sh.stopBalancer()
On this page
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.Important
mongosh Method
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
balancerStopcommand.For MongoDB API drivers, refer to the language-specific MongoDB driver documentation.
The method can take the following options:
ParameterTypeDescriptiontimeoutinteger
Time limit for disabling the balancer.
Defaults to 60000 milliseconds.
Changed in version 3.4: If using the 3.4
mongoshell with earlier version sharded clusters, the parameter specifies the amount of milliseconds to wait for the balancing round to stop.intervalinteger
The interval (in milliseconds) at which to check if the balancing round has stopped.
If you omit both options, MongoDB disables the balancer indefinitely.
Important
Leaving the balancer disabled for extended periods of time can lead to unbalanced shards, which degrade cluster performance. Only disable the balancer if necessary, and ensure that you re-enable the balancer when maintenance is complete.
You can only run
sh.stopBalancer()on amongosinstance.sh.stopBalancer()errors if run onmongodinstance.The
mongoshell method is a wrapper around thebalancerStopcommand, introduced in 3.4.
Compatibility
This method is available in deployments hosted in the following environments:
MongoDB Atlas: The fully managed service for MongoDB deployments in the cloud
Important
This command is not supported in M0, M2, and M5 clusters. For more information, see Unsupported Commands.
MongoDB Enterprise: The subscription-based, self-managed version of MongoDB
MongoDB Community: The source-available, free-to-use, and self-managed version of MongoDB
Behavior
If a balancing round is in progress, the operation waits for balancing to complete.