sh.moveRange() (mongosh method)

Definition

sh.moveRange(namespace, toShard, min, max)

New in version 6.0.

Moves ranges between shards.

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 moveRange command.

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

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

sh.moveRange(namespace, toShard, min, max)

The sh.moveRange() method takes the following parameters:

Example

The following example uses a collection with:

• Shard key postal, representing a postal code.

• A range with the boundaries 70007 and 70124.

To move the postal range to shard02, run the following method:

sh.moveRange(
   "contacts.addresses", "shard02",
   { postal: 70007 },
   { postal: 70124 }
)

{
  ok: 1,
  '$clusterTime': {
    clusterTime: Timestamp({ t: 1742507819, i: 42 }),
    signature: {
      hash: Binary.createFromBase64('AAAAAAAAAAAAAAAAAAAAAAAAAAA=', 0),
      keyId: Long('0')
    }
  },
  operationTime: Timestamp({ t: 1742507819, i: 42 })
}