Docs Menu
Docs Home
/
MongoDB Manual
/ / /

sh.getBalancerState()

On this page

  • Compatibility
sh.getBalancerState()
Returns:boolean

sh.getBalancerState() returns true when the balancer is enabled and false if the balancer is disabled. This does not reflect the current state of balancing operations: use sh.isBalancerRunning() to check the current state of the balancer.

Tip

See also:

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.

Back

sh.enableSharding

On this page