balancerStop¶

On this page

Definition
Syntax
Example

Definition¶

balancerStop¶

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 balancerStop against the admin database on a mongos instance.

Syntax¶

The command has the following syntax:

copy

db.adminCommand(
   {
     balancerStop: 1,
     maxTimeMS: <number>
   }
)

Command Fields¶

Field Type Description

balancerStop any Any value.

maxTimeMS

integer

Time 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:

copy

db.adminCommand( { balancerStop: 1 } )