balancerStart
On this page
This version of the documentation is archived and no longer supported. View the current documentation to learn how to upgrade your version of MongoDB server.
Definition
balancerStartStarts the balancer thread. The command does not wait for a balancing round to start.
Starting in MongoDB 4.2, the command enables auto-splitting for the sharded cluster. To disable auto-splitting when the balancer is enabled, you can use
sh.disableAutoSplit().
Syntax
You can only issue the
balancerStart against the admin database on a
mongos instance.
The command takes the following form:
db.adminCommand( { balancerStart: 1, maxTimeMS: <number> } )
Field | Type | Description |
|---|---|---|
balancerStart | any | Any value. |
maxTimeMS | integer | Optional. Time limit for enabling the balancer. Defaults to 60000 milliseconds. Changed in version 3.4: If using the 3.4 |
Example
To start the balancer thread, connect to a mongos instance
and issue the following command:
db.adminCommand( { balancerStart: 1 } )