Database Manual / Reference / mongosh Methods / Sharding

sh.getBalancerState() (mongosh method)

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.

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 and Flex clusters. For more information, see Unsupported Commands.