Docs Menu

Docs HomeMongoDB Manual

configureCollectionBalancing

On this page

  • Definition
  • Syntax
  • Behavior
  • Examples
configureCollectionBalancing

New in version 5.3.

Configures balancer settings for a sharded collection, such as setting the chunk size for and defragmenting the collection.

The command has the following syntax:

db.adminCommand(
{
configureCollectionBalancing: "<collection>",
chunkSize: <num>,
defragmentCollection: <bool>
}
)

configureCollectionBalancing has the following fields:

Field
Type
Description
configureCollectionBalancing
string
Required: The name of the database and sharded collection to configure.
chunkSize
integer
Optional: Sets the chunk size in MiB for the collection. The recommended size is 256, 512, or larger.
defragmentCollection
boolean
Optional: Causes the balancer to defragment the collection.

For more information, see Data Partitioning with Chunks.

If you do not specify chunkSize for a collection and no custom size has been set previously, the global default chunkSize is used for balancing.

If you use configureCollectionBalancing with chunkSize: 0, the per-collection chunkSize is reset and the global default chunkSize is used for balancing.

For more information on configuring default chunkSize, see Modify Chunk Size in a Sharded Cluster.

To change the chunk size for a sharded collection, use the chunkSize option:

db.adminCommand( {
configureCollectionBalancing: "test.students",
chunkSize: 256
} )

Use this command to change the chunk size for the given collection.

Warning

By default, MongoDB cannot move a chunk if the number of documents in the chunk is greater than 1.3 times the result of dividing the configured chunk size by the average document size.

To find the average document size, see the avgObjSize field in the output of the db.collection.stats() method.

For more information, see Chunk Size.

To tell the balancer to defragment a sharded collection, use the defragmentCollection option:

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

Use this command to have the balancer defragment a sharded collection. To monitor the chunk defragmentation process, use the balancerCollectionStatus command.

To defragment a sharded collection while updating the chunk size, use the defragmentCollection option and the chunkSize option together:

db.adminCommand( {
configureCollectionBalancing: "test.students",
chunkSize: 512,
defragmentCollection: true
} )
←  commitReshardCollectionenableSharding →
Share Feedback
© 2022 MongoDB, Inc.

About

  • Careers
  • Investor Relations
  • Legal Notices
  • Privacy Notices
  • Security Information
  • Trust Center
© 2022 MongoDB, Inc.