sh.setBalancerState()¶

On this page

Description

Description¶

sh.setBalancerState(state)¶

Enables or disables the balancer. Starting in MongoDB 4.2, the method also enables auto-splitting if enabling the balancer and disables auto-splitting if disabling the balancer.

Use sh.getBalancerState() to determine if the balancer is currently enabled or disabled and sh.isBalancerRunning() to check its current state.

Important

mongo Shell Method

This page documents a mongo method. This is not the documentation for database commands or language-specific drivers, such as Node.js. To use the database command, see the balancerStart and balancerStop commands.

For MongoDB API drivers, refer to the language-specific MongoDB driver documentation.

Important

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

The sh.setBalancerState() method has the following parameter:

Parameter	Type	Description
`state`	boolean	Set this to `true` to enable the balancer and `false` to disable it.