Docs Menu
Docs Home
/
MongoDB Manual
/
Reference
/
mongosh Methods
/
Sharding

sh.enableBalancing()

On this page

  • Description
  • Compatibility

Description

sh.enableBalancing(namespace)

Enables the balancer for the specified namespace of the sharded collection.

Important

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

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

Parameter
Type
Description

namespace

string

The namespace of the collection.

Important

sh.enableBalancing() does not start balancing. Rather, it allows balancing of this collection the next time the balancer runs.

For more information on the balancing process, see Manage Sharded Cluster Balancer and Sharded Cluster Balancer.

Compatibility

This method is available in deployments hosted in the following environments:

  • MongoDB Enterprise: The subscription-based, self-managed version of MongoDB

  • MongoDB Community: The source-available, free-to-use, and self-managed version of MongoDB

Back

sh.enableAutoMerger

Next

sh.enableAutoSplit