sh.stopBalancer()

Definition

sh.stopBalancer(timeout, interval)

Changed in version 6.1.

Disables the balancer in a sharded cluster.

Starting in MongoDB 6.1, automatic chunk splitting is not performed. This is because of balancing policy improvements. Auto-splitting commands still exist, but do not perform an operation. For details, see Balancing Policy Changes.

In MongoDB versions earlier than 6.1, sh.stopBalancer() also disables auto-splitting for the sharded cluster.

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

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

For the legacy mongo shell documentation, refer to the documentation for the corresponding MongoDB Server release:

mongo shell v4.4

The method can take the following options:

Parameter	Type	Description
timeout	integer	Time limit for disabling the balancer. Defaults to 60000 milliseconds.
interval	integer	The interval (in milliseconds) at which to check if the balancing round has stopped.

You can only run sh.stopBalancer() on a mongos instance. sh.stopBalancer() errors if run on mongod instance.

The mongosh shell method is a wrapper around the balancerStop command.

Behavior

If a balancing round is in progress, the operation waits for balancing to complete.