Navigation

setAllowMigrations

On this page

Definition

setAllowMigrations

New in version 4.2.18.

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.

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:

If true:

Behavior

setAllowMigrations requires the same privileges as moveChunk.

Example

This operation prevents migrations on the store.inventory collection:

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