sh.removeTagRange()

On this page

Definition

Example

This version of the documentation is archived and no longer supported. View the current documentation to learn how to upgrade your version of MongoDB.

Definition

sh.removeTagRange(namespace, minimum, maximum)

Changed in version 3.4: This method aliases to sh.removeRangeFromZone() in MongoDB 3.4. The functionality specified below still applies to MongoDB 3.2. MongoDB 3.4 provides Zone sharding as the successor to tag-aware sharding.

Removes a specified shard tag from a defined range of shard key values. sh.removeTagRange() takes the following arguments:

Parameter	Type	Description
`namespace`	string	The namespace of the sharded collection to tag.
`minimum`	document	The minimum value of the shard key from the tag. Specify the minimum value in the form of `<fieldname>:<value>`. This value must be of the same BSON type or types as the shard key.
`maximum`	document	The maximum value of the shard key range from the tag. Specify the maximum value in the form of `<fieldname>:<value>`. This value must be of the same BSON type or types as the shard key.

Use sh.removeTagRange() to ensure that unused or out of date ranges are removed and hence chunks are balanced as required.

Only run sh.removeTagRange() when connected to a mongos instance.

Example

Given a shard key of {state: 1, zip: 1}, the following operation removes an existing tag range covering zip codes in New York State:

sh.removeTagRange( "exampledb.collection",
                { state: "NY", zip: MinKey },
                { state: "NY", zip: MaxKey }
              )

Back

sh.removeShardFromZone()

sh.setBalancerState()