Start Defragmenting a Sharded Collection

On this page

About this Task

Before you Begin
Procedure
Next Steps
Learn More

To start defragmenting a sharded collection, use the configureCollectionBalancing command with the defragmentCollection option set to true.

About this Task

Fragmentation is where a sharded collection's data is broken up into an unnecessarily large number of small chunks. This can increase operation times of CRUD operations run on that collection. Defragmentation reduces the number of chunks by merging smaller chunks into larger ones, resulting in lower CRUD operation times.

If CRUD operation times are acceptable, you don't need to defragment collections.

The following table summarizes defragmentation information for various MongoDB versions.

MongoDB Version	Description
MongoDB 7.0 and later	Chunks are automatically merged. Performance improvements from defragmenting a collection in MongoDB 7.0 are lower compared to MongoDB 6.0. Typically, you don't need to defragment collections starting in MongoDB 7.0.
MongoDB 6.0 and earlier than 7.0	Defragment collections only if you experience CRUD operation delays when the balancer migrates chunks or a node starts. Starting in MongoDB 6.0, high write traffic should not cause fragmentation. Chunk migrations cause fragmentation.
Earlier than MongoDB 6.0	Defragment collections only if you experience longer CRUD operation times during metadata updates. For MongoDB versions earlier than 6.0, a sharded collection becomes fragmented when the collection size grows significantly because of many insert or update operations.

The procedure in this task uses an example sharded collection named ordersShardedCollection in a database named test.

You can use your own sharded collection and database in the procedure.

Before you Begin

Connect to mongos.

Procedure

Start defragmenting the collection

Run:

db.adminCommand(
   {
      configureCollectionBalancing: "test.ordersShardedCollection",
      defragmentCollection: true
   }
)

Ensure defragmentation started

Ensure ok is 1 in the command output, which indicates the command execution was successful:

{
   ok: 1,
   '$clusterTime': {
      clusterTime: Timestamp({ t: 1677616966, i: 8 }),
      signature: {
         hash: Binary(Buffer.from("0000000000000000000000000000000000000000", "hex"), 0),
         keyId: Long("0")
      }
   },
   operationTime: Timestamp({ t: 1677616966, i: 8 })
}

Next Steps

You can monitor the collection's defragmentation progress. For details, see Monitor Defragmentation of a Sharded Collection.

Learn More

Print shard status, see db.printShardingStatus()
Retrieve shard status details, see sh.status()
View shard status collection fields, see Sharded Collection
See active mongos instances, see Active mongos Instances
Monitor shards using MongoDB Atlas, see Review Sharded Clusters

Back

Defragment Sharded Collections

Monitor