Docs Home → MongoDB Manual

Sharding Reference分片参考

On this page本页内容

Sharding Methods in mongoshmongosh中的分片方法

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()In MongoDB 3.4, this method aliases to sh.addShardToZone().在MongoDB 3.4中，此方法别名为sh.addShardToZone()。
sh.addShardToZone()Associates a shard to a zone. Supports configuring zones in sharded clusters.将分片与区域关联。支持在分片集群中配置区域。
sh.addTagRange()In MongoDB 3.4, this method aliases to sh.updateZoneKeyRange().在MongoDB 3.4中，此方法别名为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.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.disableAutoMerger()Disables automatic chunk merges for a namespace. 禁用命名空间的自动块合并。
New in version 7.0. 7.0版新增。
sh.disableAutoSplit()Disables 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.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()In MongoDB 3.4, this method aliases to sh.removeRangeFromZone().在MongoDB 3.4中，此方法别名为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()In MongoDB 3.4, this method aliases to sh.removeShardFromZone().在MongoDB 3.4中，此方法别名为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.返回输入的哈希值。

Sharding Database Commands分片数据库命令

The following database commands support sharded clusters.以下数据库命令支持分片集群。

Name名称Description描述
abortReshardCollectionAborts a resharding operation. 中止重新分片操作。
New in version 5.0. 5.0版新增。
addShardAdds a shard to a sharded cluster.将分片添加到已分片化的群集中。
addShardToZoneAssociates a shard with a zone. 将分片与区域关联。Supports configuring zones in sharded clusters.支持在分片集群中配置区域。
balancerCollectionStatusReturns information on whether the chunks of a sharded collection are balanced. 返回有关分片集合的块是否平衡的信息。
New in version 4.4. 4.4版新增。
balancerStartStarts a balancer thread.启动平衡器线程。
balancerStatusReturns information on the balancer status.返回有关平衡器状态的信息。
balancerStopStops the balancer thread.停止平衡器线程。
checkShardingIndexInternal command that validates index on shard key.用于验证分片键上的索引的内部命令。
clearJumboFlagClears the jumbo flag for a chunk.清除区块的jumbo标志。
cleanupOrphanedRemoves orphaned data with shard key values outside of the ranges of the chunks owned by a shard.删除分片键值在分片所拥有的区块范围之外的孤立数据。
cleanupReshardCollectionCleans up a failed resharding operation.清理失败的重新分片操作。
New in version 5.0. 5.0版新增。
commitReshardCollectionForces a resharding operation to block writes and complete. 强制重新分片操作以阻止写入并完成。
New in version 5.0. 5.0版新增。
enableShardingEnables sharding on a specific database.在特定数据库上启用分片。
flushRouterConfigForces a mongod / mongos instance to update its cached routing metadata.强制mongod/mongos实例更新其缓存的路由元数据。
getShardMapInternal command that reports on the state of a sharded cluster.报告分片集群状态的内部命令。
getShardVersionInternal command that returns the config server version.返回配置服务器版本的内部命令。
isdbgridVerifies that a process is a mongos.验证进程是否为mongos。
listShardsReturns a list of configured shards.返回已配置分片的列表。
medianKeyDeprecated internal command. 不推荐使用内部命令。See splitVector.请参见splitVector。
moveChunkInternal command that migrates chunks between shards.在分片之间迁移块的内部命令。
movePrimaryReassigns the primary shard when removing a shard from a sharded cluster.从分片群集中移除分片时，重新分配主分片。
moveRangeCommand that migrates ranges between shards.在分片之间迁移范围的命令。
mergeChunksProvides the ability to combine chunks on a single shard.提供在单个分片上组合块的功能。
removeShardStarts the process of removing a shard from a sharded cluster.开始从分片集群中移除分片的过程。
removeShardFromZoneRemoves the association between a shard and a zone. 删除分片和区域之间的关联。Supports configuring zones in sharded clusters.支持在分片集群中配置区域。
reshardCollectionInitiates a resharding operation to change the shard key for a collection, changing the distribution of your data. 启动重新分片操作以更改集合的分片键，从而更改数据的分布。
New in version 5.0. 5.0版新增。
setShardVersionInternal command to sets the config server version.用于设置配置服务器版本的内部命令。
shardCollectionEnables the sharding functionality for a collection, allowing the collection to be sharded.启用集合的分片功能，允许对集合进行分片。
shardingStateReports whether the mongod is a member of a sharded cluster.报告mongod是否是分片集群的成员。
splitCreates a new chunk.创建新区块。
splitVectorInternal command that determines split points.确定拆分点的内部命令。
unsetShardingRemoved in MongoDB 5.0.在MongoDB 5.0中删除。 Internal command that affects connections between instances in a MongoDB deployment.影响MongoDB部署中实例之间连接的内部命令。
updateZoneKeyRangeAdds or removes the association between a range of sharded data and a zone. 添加或删除一系列分片数据和区域之间的关联。Supports configuring zones in sharded clusters.支持在分片集群中配置区域。

Reference Documentation参考文档

Operational Restrictions操作限制
Requirement for deploying a sharded cluster部署分片集群的要求
Troubleshoot Sharded Clusters分片集群疑难解答
Common strategies for troubleshooting sharded cluster deployments.对分片集群部署进行故障排除的常见策略。
Config Database配置数据库
Complete documentation of the content of the local database that MongoDB uses to store sharded cluster metadata.MongoDB用于存储分片集群元数据的local数据库内容的完整文档。