sh.startBalancer()

Definition

  • sh.startBalancer(timeout, interval)

Changed in version 4.2.

Starts the balancer in a sharded cluster. Starting in MongoDB 4.2,sh.startBalancer() also enables auto-splitting for thesharded cluster.

The method can take the following options:

ParameterTypeDescriptiontimeoutintegerOptional. Time limit for enabling 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 of time towait for the balancing round to start.

intervalintegerOptional. The frequency (in milliseconds) at which to check if a balancinground has started.

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

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

Behavior

Starting in MongoDB 3.4, the mongo shell methodsh.startBalancer() is a wrapper around thebalancerStart command. As such, the method does notwait for balancing to start.

In earlier versions, the method waited for the balancing to start.

See also