sh.stopBalancer()

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 thesharded cluster.

The method can take the following options:

ParameterTypeDescriptiontimeoutintegerTime limit for disabling the balancer.

Defaults to 60000 milliseconds.

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

intervalintegerThe interval (in milliseconds) at which to check if the balancinground has stopped.

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

You can only run sh.stopBalancer() on amongos instance. sh.stopBalancer() errorsif run on mongod instance.

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

Behavior

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

See also