Docs HomeMongoDB Manual

Sharding Methods

Note

For details on a specific method, including syntax and examples, click on the link to the method's reference page.有关特定方法的详细信息,包括语法和示例,请单击该方法参考页的链接。

Name名称Description描述
sh.abortReshardCollection()Aborts a resharding operation. 中止重新分片操作
New in version 5.0. 5.0版新增。
sh.addShard()Adds a shard to a sharded cluster.分片添加到已分片化的群集中。
sh.addShardTag()This method aliases to sh.addShardToZone().此方法别名为sh.addShardToZone()
sh.addShardToZone()Associates a shard to a zone. 将分片与区域关联。Supports configuring zones in sharded clusters.支持在分片集群中配置区域
sh.addTagRange()This method aliases to sh.updateZoneKeyRange().此方法别名为sh.updateZoneKeyRange()
sh.balancerCollectionStatus()Returns information on whether the chunks of a sharded collection are balanced. 返回有关分片集合的块是否平衡的信息。
New in version 4.4. 4.4版新增。
sh.commitReshardCollection()Forces a resharding operation to block writes and complete.强制重新分片操作以阻止写入并完成。
New in version 5.0. 5.0版新增。
sh.disableAutoMerger()Disables automatic chunk merges for a namespace. 禁用命名空间的自动合并。
New in version 7.0. 7.0版新增。
sh.disableBalancing()Disable balancing on a single collection in a sharded database. Does not affect balancing of other collections in a sharded cluster.在分片数据库中禁用对单个集合的平衡。不影响分片集群中其他集合的平衡。
sh.enableAutoMerger()Enables automatic chunk merges for a namespace. 启用命名空间的自动合并。
New in version 7.0. 7.0版新增。
sh.enableBalancing()Activates the sharded collection balancer process if previously disabled using sh.disableBalancing().如果之前使用sh.disableBalancing()禁用了分片集合平衡器进程,则激活该进程。
sh.disableAutoSplit()Disables auto-splitting for the sharded cluster.禁用分片群集的自动拆分。
Starting in MongoDB 6.1, automatic chunk splitting is not performed. This is because of balancing policy improvements. 从MongoDB 6.1开始,不执行自动区块分割。这是因为平衡政策的改进。Auto-splitting commands still exist, but do not perform an operation. 自动拆分命令仍然存在,但不执行操作。For details, see Balancing Policy Changes. 有关详细信息,请参阅平衡策略更改
sh.enableAutoSplit()Enables auto-splitting for the sharded cluster.启用分片集群的自动拆分。
Starting in MongoDB 6.1, automatic chunk splitting is not performed. 从MongoDB 6.1开始,不执行自动区块分割。This is because of balancing policy improvements. Auto-splitting commands still exist, but do not perform an operation. 这是因为平衡政策的改进。自动拆分命令仍然存在,但不执行操作。For details, see Balancing Policy Changes. 有关详细信息,请参阅平衡策略更改
sh.enableSharding()Creates a database.创建数据库。
sh.getBalancerState()Returns a boolean to report if the balancer is currently enabled.如果平衡器当前已启用,则返回要报告的布尔值。
sh.removeTagRange()This method aliases to sh.removeRangeFromZone().此方法别名为sh.removeRangeFromZone()
sh.removeRangeFromZone()Removes an association between a range of shard keys and a zone. Supports configuring zones in sharded clusters.删除一系列分片关键帧和区域之间的关联。支持在分片集群中配置区域
sh.help()Returns help text for the sh methods.返回sh方法的帮助文本。
sh.isBalancerRunning()Returns a document describing the status of the balancer.返回描述平衡器状态的文档。
sh.moveChunk()Migrates a chunk in a sharded cluster.迁移分片集群中的区块
sh.removeShardTag()This method aliases to sh.removeShardFromZone().此方法别名为sh.removeShardFromZone()
sh.removeShardFromZone()Removes the association between a shard and a zone. Use to manage zone sharding.删除分片和区域之间的关联。用于管理区域分片
sh.reshardCollection()Initiates a resharding operation to change the shard key for a collection, changing the distribution of your data. 启动重新分片操作以更改集合的分片键,从而更改数据的分布。
New in version 5.0. 5.0版新增。
sh.setBalancerState()Enables or disables the balancer which migrates chunks between shards.启用或禁用在分片之间迁移平衡器
sh.shardCollection()Enables sharding for a collection.启用集合的分片。
sh.splitAt()Divides an existing chunk into two chunks using a specific value of the shard key as the dividing point.使用分片键的特定值作为分割点,将现有划分为两个块。
sh.splitFind()Divides an existing chunk that contains a document matching a query into two approximately equal chunks.将包含与查询匹配的文档的现有块划分为两个大致相等的
sh.startAutoMerger()Enables the AutoMerger. 启用自动合并
New in version 7.0. 7.0版新增。
sh.startBalancer()Enables the balancer and waits for balancing to start.启用平衡器并等待开始平衡。
sh.status()Reports on the status of a sharded cluster, as db.printShardingStatus().报告分片集群的状态,如db.printShardingStatus()
sh.stopAutoMerger()Disables the AutoMerger.禁用自动合并
New in version 7.0. 7.0版新增。
sh.stopBalancer()Disables the balancer and waits for any in progress balancing rounds to complete.禁用平衡器并等待任何正在进行的平衡轮次完成。
sh.waitForBalancer()Internal. Waits for the balancer state to change.内部的等待平衡器状态更改。
sh.waitForBalancerOff()Internal. Waits until the balancer stops running.内部的等待,直到平衡器停止运行。
sh.waitForPingChange()Internal. Waits for a change in ping state from one of the mongos in the sharded cluster.内部的等待来自分片集群中的一个mongos的ping状态的更改。
sh.updateZoneKeyRange()Associates a range of shard keys to a zone. Supports configuring zones in sharded clusters.将一系列分片关键帧关联到一个区域。支持在分片集群中配置区域
convertShardKeyToHashed()Returns the hashed value for the input.返回输入的哈希值。