Docs4dev
Docs
mongodb / v3.6 / reference / reference-command-movePrimary.html

movePrimary

On this page

movePrimary

In a sharded cluster, movePrimary reassigns the primary shard which holds all un-sharded collections in the database. movePrimary first changes the primary shard in the cluster metadata, and then migrates all un-sharded collections to the specified shard. Use the command with the following form:

db.adminCommand( { movePrimary: <databaseName>, to: <newPrimaryShard> } )

For example, the following command moves the primary shard from test to shard0001:

db.adminCommand( { movePrimary : "test", to : "shard00 01" } )

When the command returns, the database’s primary shard location has switched to the specified shard. To fully decommission a shard, use the removeShard command.

movePrimary is an administrative command that is only available for mongos instances.

Warning

After starting movePrimary, do not perform any read or write operations against any unsharded collection in that database until the command completes. Read or write operations issued against those collections during the migration can result in unexpected behavior, including potential failure of the migration operation or loss of data.

Considerations

Issue movePrimary During A Maintenance Window

movePrimary may require a significant time to complete depending on the size of the database and factors such as network health or machine resources. Read or write operations issued against the database during the migration can result in unexpected behavior, including potential failure of the migration operation or loss of data.

Consider scheduling a maintenance window during which applications stop all reads and writes to the cluster. Issuing movePrimary during planned downtime mitigates the risk of encountering undefined behavior due to interleaving reads or writes to the unsharded collections in the database.

Using movePrimary To Move Unsharded Collections

Warning

If you use the movePrimary command to move un-sharded collections, you must either restart all mongos instances, or use the flushRouterConfig command on all mongos instances before reading or writing any data to any unsharded collections that were moved. This action ensures that the mongos is aware of the new shard for these collections.

If you do not update the mongos instances’ metadata cache after using movePrimary, the mongos may miss data on reads, and may not write data to the correct shard. To recover, you must manually intervene.

Namespace Conflicts Prevent Migration

movePrimary fails if the destination shard contains a conflicting collection namespace. For example:

  1. An administrator issues movePrimary to change the primary shard for the hr database.
  2. A user or application issues a write operation against an unsharded collection in hr while movePrimary is moving that collection. The write operation creates the collection in the original primary shard.
  3. An administrator later issues movePrimary to restore the original primary shard for the hr database.
  4. movePrimary fails due to the conflicting namespace left behind from the interleaving write operation.

Destination Shard Must Rebuild Indexes

The destination shard must rebuild its indexes in the foreground when it becomes the primary shard. The collection locks while the indexes are building, preventing reads and writes until the indexes are finished. This may require a significant amount of time depending on the number of indexes per collection and the amount of data to index.

See Index Build Operations on a Populated Collection for more information on the index build process.

Additional Information

See Remove Shards from an Existing Sharded Cluster for a complete procedure.