• Reference >
• mongo Shell Methods >
• Sharding Methods >
• sh.setBalancerState()

sh.setBalancerState()

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

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.

See also

• sh.enableBalancing()
• sh.disableBalancing()
• sh.getBalancerHost()
• sh.getBalancerState()
• sh.isBalancerRunning()
• sh.startBalancer()
• sh.stopBalancer()
• sh.waitForBalancer()
• sh.waitForBalancerOff()

←   sh.removeShardFromZone() sh.shardCollection()  →

© MongoDB, Inc 2008-present. MongoDB, Mongo, and the leaf logo are registered trademarks of MongoDB, Inc.