This version of the documentation is archived and no longer supported.


On this page


sh.addShardTag(shard, tag)

Changed in version 3.4: This method aliases to sh.addShardToZone() 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.

Associates a shard with a tag or identifier. MongoDB uses these identifiers to direct chunks that fall within a tagged range to specific shards. sh.addTagRange() associates chunk ranges with tag ranges.

Parameter Type Description
shard string The name of the shard to which to give a specific tag.
tag string The name of the tag to add to the shard.

Only issue sh.addShardTag() when connected to a mongos instance.


The following example adds three tags, NYC, LAX, and NRT, to three shards:

sh.addShardTag("shard0000", "NYC")
sh.addShardTag("shard0001", "LAX")
sh.addShardTag("shard0002", "NRT")