setAllowMigrations

On this page

Definition

setAllowMigrations: Prevents the start of new automatic migrations on a collection, prevents in-flight manual migrations from committing, and excludes the collection from new balancer rounds.

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

This command is not supported in serverless instances. For more information, see Unsupported Commands.

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

The command has the following syntax:

db.adminCommand(
   {
    setAllowMigrations: "<db>.<collection>",
    allowMigrations: <true|false>
   }
)

The command takes the following parameters:

Field	Type	Description
setAllowMigrations	`string`	The collection to modify.
allowMigrations	`boolean`	If `false`: MongoDB prevents new automatic migrations on the collection in-flight manual migrations will not be committed the collection will be excluded from new balancer rounds If `true`: MongoDB allows new automatic migrations on the collection in-flight manual migrations will be committed the collection will be included in new balancer rounds

setAllowMigrations requires the same privileges as moveChunk.

This operation prevents migrations on the store.inventory collection:

db.adminCommand( {
   setAllowMigrations: "store.inventory",
   allowMigrations: false
} )

Back

reshardCollection

shardCollection