Docs Menu
Docs Home
/
MongoDB Manual
/
Reference
/
Database Commands
/
Sharding

cleanupReshardCollection

On this page

  • Definition
  • Compatibility
  • Syntax
  • Example

Definition

cleanupReshardCollection

New in version 5.0.

The cleanupReshardCollection command cleans up metadata of a failed resharding operation. You only need to run this command if a primary failover occurred while you ran a resharding operation.

Compatibility

This command is available in deployments hosted in the following environments:

  • MongoDB Atlas: The fully managed service for MongoDB deployments in the cloud

Note

This command is supported in all MongoDB Atlas clusters. For information on all commands, see Unsupported Commands.

Syntax

The command has the following syntax:

db.adminCommand(
   {
     cleanupReshardCollection: "<database>.<collection>"
   }
)

Example

Clean up a Failed Resharding Operation

The following example cleans up metadata of a failed resharding operation on the sales.orders collection:

db.adminCommand({
  cleanupReshardCollection: "sales.orders"
})

Tip

See also:

Reshard a Collection

Back

cleanupOrphaned

Next

commitReshardCollection