Docs 菜单
Docs 主页
/
MongoDB Manual
/
参考
/
数据库命令
/
分片

cleanupOrphaned

在此页面上

重要

Starting in MongoDB 6.0.3, you should run an aggregation using the $shardedDataDistribution stage to confirm no orphaned documents remain. For details, see 确认无孤立文档.

定义

cleanupOrphaned

自版本 8.0 起已弃用。

Use this command to wait for orphaned documents in a chunk range from a shard key's MinKey to its MaxKey for a specified namespace to be cleaned up from a majority of a shard's members.

To run, issue cleanupOrphaned in the admin database directly on the mongod instance that is the primary replica set member of the shard. You do not need to disable the balancer before running cleanupOrphaned.

注意

Do not run cleanupOrphaned on a mongos instance.

兼容性

此命令可用于以下环境中托管的部署：

重要

M0、M2、M5 和 Flex 集群不支持此命令。有关更多信息，请参阅不支持的命令。

语法

该命令具有以下语法：

db.runCommand(
   {
     cleanupOrphaned: "<database>.<collection>",
     startingFromKey: <minimumShardKeyValue>, // deprecated
     secondaryThrottle: <boolean>, // deprecated
     writeConcern: <document> // deprecated
   }
)

命令字段

cleanupOrphaned具有以下字段：

字段
类型
说明

cleanupOrphaned

字符串

The namespace, i.e. both the database and the collection name, of the sharded collection for which to wait for cleanup of the orphaned data.

行为

Determine Range

The value of this field is not used to determine the bounds of the cleanup range. The cleanupOrphaned command waits until all orphaned documents in all ranges in the namespace are cleaned up from the shard before completing, regardless of the presence of or value of startingFromKey.

必需的访问权限

On systems running with authorization, you must have clusterAdmin privileges to run cleanupOrphaned.

输出

returnDocument

Each cleanupOrphaned command returns a document containing a subset of the following fields:

cleanupOrphaned.ok

Equal to 1 on success.

A value of 1 indicates that either:

  • No orphaned documents remain in the cleanupOrphaned namespace on the shard, or

  • The collection referenced in the cleanupOrphaned namespace is not sharded.

A value of 0 indicates that an error has occurred.

后退

clearJumboFlag

来年

cleanupReshardCollection