balancerStop

On this page

Definition

  • balancerStop
    • New 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 before stopping the balancer.

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> } )
FieldTypeDescription
balancerStopanyAny value.
maxTimeMSintegerTime limit for disabling the balancer.
Defaults to 60000 milliseconds.
Changed in version 3.4: If using the 3.4 mongo shell with earlier version sharded clusters, the parameter specifies the amount of milliseconds to wait for the balancing round to stop.

Example

To stop the balancer thread, connect to a mongos instance and issue the following command:

db.adminCommand( { balancerStop: 1 } )