Docs Home → Develop Applications → MongoDB Manual
sh.setBalancerState()
On this page
Description
sh.setBalancerState(state)
Enables or disables the balancer.
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.
In MongoDB versions earlier than 6.1,
sh.setBalancerState()
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 andsh.isBalancerRunning()
to check its current state.Important
mongosh Method
This page documents a
mongosh
method. This is not the documentation for database commands or language-specific drivers, such as Node.js.For the database command, see the
balancerStart
andbalancerStop
commands.For MongoDB API drivers, refer to the language-specific MongoDB driver documentation.
For the legacy
mongo
shell documentation, refer to the documentation for the corresponding MongoDB Server release:Important
You can only run
sh.setBalancerState()
on amongos
instance.sh.setBalancerState()
errors if run onmongod
instance.The
sh.setBalancerState()
method has the following parameter:ParameterTypeDescriptionstate
booleanSet this totrue
to enable the balancer andfalse
to disable it.