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.enableBalancing()Activates the sharded collection balancer process if previously disabled using sh.disableBalancing().如果以前使用sh.disableBalancing()禁用了分片集合平衡器进程，则激活该进程。
sh.disableAutoSplit()Disables auto-splitting for the sharded cluster.禁用分片群集的自动拆分。
sh.enableAutoSplit()Enables auto-splitting for the sharded cluster.启用分片群集的自动拆分。
sh.enableSharding()Enables sharding on a specific database.在特定数据库上启用分片。
sh.getBalancerHost()Deprecated since MongoDB 3.4自MongoDB 3.4以来已弃用
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.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.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描述
abortReshardCollection

Aborts 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.支持在分片集群中配置分区。
balancerCollectionStatus

Returns 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.删除分片键值超出分片所拥有的块范围的孤立数据。
cleanupReshardCollection

Cleans up a failed resharding operation.清理失败的重新分片操作。

New in version 5.0.在版本5.0中新增。

commitReshardCollection

Forces 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.从分片集群中删除分片时，重新分配主分片。
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.支持在分片集群中配置分区。
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中新增。

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数据库内容的完整文档。
←  Convert a Shard Standalone to a Shard Replica Set将独立分片转换为分片副本集Operational Restrictions in Sharded Clusters分片群集中的操作限制 →