On this page
Changed in version 6.0.
Starts the balancer in a sharded cluster.
Starting in MongoDB 6.0.3, 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.0
sh.startBalancer()also enables auto-splitting for the sharded cluster.
This page documents a
mongoshmethod. This is not the documentation for database commands or language-specific drivers, such as Node.js.
For the database command, see the
For MongoDB API drivers, refer to the language-specific MongoDB driver documentation.
For the legacy
mongoshell documentation, refer to the documentation for the corresponding MongoDB Server release:
The method can take the following options:ParameterTypeDescription
Optional. Time limit for enabling the balancer.
Defaults to 60000 milliseconds.
intervalintegerOptional. The frequency (in milliseconds) at which to check if a balancing round has started.
You can only run
sh.startBalancer()errors if run on
mongosh shell method
is a wrapper around the
balancerStart command. As such,
the method does not wait for balancing to start.
In earlier versions, the method waited for the balancing to start.