Skip to content

Commit 924d84e

Browse files
authored
DOCSP-50182 configureCollectionBalancing backport (#12313)
1 parent 1a57252 commit 924d84e

File tree

1 file changed

+25
-3
lines changed

1 file changed

+25
-3
lines changed

content/manual/manual/source/reference/command/configureCollectionBalancing.txt

Lines changed: 25 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -44,8 +44,9 @@ The command has the following syntax:
4444
{
4545
configureCollectionBalancing: "<db>.<collection>",
4646
chunkSize: <num>,
47-
defragmentCollection: <bool>
48-
enableAutoMerger: <bool>
47+
defragmentCollection: <bool>,
48+
enableAutoMerger: <bool>,
49+
enableBalancing: <bool>
4950
}
5051
)
5152

@@ -80,9 +81,17 @@ Command Fields
8081
* - ``enableAutoMerger``
8182
- boolean
8283
- Optional
83-
- Whether or not the :ref:`{+auto-merge-upper+}
84+
- Sets whether the :ref:`{+auto-merge-upper+}
8485
<automerger-concept>` takes this collection into account.
8586
Defaults to ``true``.
87+
* - ``enableBalancing``
88+
- boolean
89+
- Optional
90+
- Sets whether the balancer operates on the collection.
91+
When set to ``false``, the balancer is disabled for the
92+
collection.
93+
94+
.. versionadded:: 8.0.10
8695

8796

8897
For more information, see :ref:`Data Partitioning with Chunks
@@ -207,3 +216,16 @@ set the ``enableAutoMerger`` option to ``false``:
207216
configureCollectionBalancing: "test.students",
208217
enableAutoMerger: false
209218
} )
219+
220+
Disable Balancing on a Collection
221+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
222+
223+
To explicitly disable the balancer on a collection, set the
224+
``enableBalancing`` option to ``false``:
225+
226+
.. code-block:: javascript
227+
228+
db.adminCommand( {
229+
configureCollectionBalancing: "test.students",
230+
enableBalancing: false
231+
} )

0 commit comments

Comments
 (0)