Docs Menu
Docs Home
/
MongoDB Manual
/
Reference
/
mongosh Methods
/
Sharding

sh.abortReshardCollection()

On this page

  • Definition
  • Compatibility
  • Syntax
  • Example

Definition

sh.abortReshardCollection(namespace)

New in version 5.0.

During a resharding operation, you can abort the operation with the sh.abortReshardCollection() method.

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 sh.abortReshardCollection() method, the method returns an error.

Important

mongosh Method

This page documents a mongosh method. This is not the documentation for database commands or language-specific drivers, such as Node.js.

For the database command, see the abortReshardCollection command.

For MongoDB API drivers, refer to the language-specific MongoDB driver documentation.

Compatibility

This method 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 sh.abortReshardCollection() method has the following syntax:

sh.abortReshardCollection( <namespace> )

Parameter

The sh.abortReshardCollection() method takes the following parameter:

Parameter
Type
Description
String

The name of the collection to shard in the form "<database>.<collection>".

Example

Abort a Resharding Operation

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

sh.abortReshardCollection("sales.orders")

Tip

See also:

Reshard a Collection

Back

db.collection.checkMetadataConsistency

Next

sh.addShard