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

abortReshardCollection

On this page

  • Definition
  • Compatibility
  • Syntax
  • Example

Definition

abortReshardCollection

New in version 5.0.

During a resharding operation, you can abort the operation with the abortReshardCollection command.

You can abort a resharding operation at any point until the commit phase. If the resharding operation has reached the commit phase before you run the abortReshardCollection command, the command returns an error.

Tip

In mongosh, this command can also be run through the sh.abortReshardCollection() helper method.

Helper methods are convenient for mongosh users, but they may not return the same level of information as database commands. In cases where the convenience is not needed or the additional return fields are required, use the database command.

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 Atlas support for all commands, see Unsupported Commands.

Syntax

The command has the following syntax:

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

Example

Abort a Resharding Operation

The following example aborts a running resharding operation on the sales.orders collection:

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

Tip

See also:

Reshard a Collection

Back

abortMoveCollection

Next

abortUnshardCollection