commitReshardCollection

Definition

commitReshardCollection

New in version 5.0.

During a resharding operation, MongoDB does not block writes until the estimated duration to complete the resharding operation is below two seconds.

If the current estimate is above two seconds but the time frame is acceptable to you, you can finish resharding faster. The commitReshardCollection command blocks writes early and forces the resharding operation to complete.

Tip

In mongosh, this command can also be run through the sh.commitReshardCollection() 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

• MongoDB Enterprise: The subscription-based, self-managed version of MongoDB

• MongoDB Community: The source-available, free-to-use, and self-managed version of MongoDB

Syntax

The command has the following syntax:

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

The mongosh provides a wrapper method sh.commitReshardCollection().

Example

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