Definition
balancerStopNew in version 3.4.
Disables the balancer in a sharded cluster. If a balancing round is in progress, the operation waits for balancing to complete.
Starting in MongoDB 4.2, the command disables auto-splitting for the sharded cluster. To enable auto-splitting when the balancer is disabled, you can use
sh.enableAutoSplit().You can only issue the
balancerStopagainst theadmindatabase on amongosinstance.Tip
In the
mongoShell, this command can also be run through thesh.stopBalancer()helper method.Helper methods are convenient for
mongousers, but they may not return the same level of information as database commands. In cases where the convenience is not needed or the additional return fields are required, use the database command.
Syntax
You can only issue the balancerStop against the
admin database on a mongos instance.
The command takes the following form:
db.adminCommand( { balancerStop: 1, maxTimeMS: <number> } )
Field | Type | Description |
|---|---|---|
| any | Any value. |
| integer | Time limit for disabling the balancer. Defaults to 60000 milliseconds. Changed in version 3.4: If using the 3.4 |
Example
To stop the balancer thread, connect to a mongos instance
and issue the following command:
db.adminCommand( { balancerStop: 1 } )