sh.stopBalancer()¶

On this page

Definition
Behavior

Definition¶

sh.stopBalancer(timeout, interval)¶

Changed in version 4.2.

Disables the balancer in a sharded cluster. Starting in MongoDB 4.2, sh.stopBalancer() also disables auto-splitting for the sharded cluster.

The method can take the following options:

Parameter Type Description

timeout

integer

Time limit for disabling the balancer.

Defaults to 60000 milliseconds.

Changed in version 3.4: If using the 3.4 mongo shell with earlier version sharded clusters, the parameter specifies the amount of milliseconds to wait for the balancing round to stop.

interval

integer

The interval (in milliseconds) at which to check if the balancing round has stopped.

Changed in version 3.4: Only applicable when using version 3.4 mongo shell with earlier version sharded clusters.

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

The mongo shell method is a wrapper around the balancerStop command, introduced in 3.4.

Behavior¶

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