sh.abortReshardCollection()
On this page
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
mongoshmethod. This is not the documentation for database commands or language-specific drivers, such as Node.js.For the database command, see the
abortReshardCollectioncommand.For MongoDB API drivers, refer to the language-specific MongoDB driver documentation.
For the legacy
mongoshell documentation, refer to the documentation for the corresponding MongoDB Server release:
Syntax
The sh.abortReshardCollection() method has the following syntax:
sh.abortReshardCollection( <namespace> )
Parameter
The sh.abortReshardCollection() method takes the following parameter:
| Parameter | Type | Description |
|---|---|---|
| namespace | 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")