Skip to content

Commit 15902b2

Browse files
committed
DOCS-12492: tweak - add admonition about chunk migration and update links to use ref instead of doc
1 parent 48b4814 commit 15902b2

File tree

1 file changed

+19
-9
lines changed

1 file changed

+19
-9
lines changed

source/reference/command/cleanupOrphaned.txt

Lines changed: 19 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -127,18 +127,28 @@ you may prefer to include a pause in-between iterations.
127127
Alternatively, to mitigate the impact of :dbcommand:`cleanupOrphaned`,
128128
you may prefer to run the command at off peak hours.
129129

130-
It is also possible to tune the performance impact of :dbcommand:`cleanupOrphaned`
131-
with two server parameters :parameter:`rangeDeleterBatchSize`
132-
and :parameter:`rangeDeleterBatchDelayMS`
130+
It is also possible to tune the performance impact of
131+
:dbcommand:`cleanupOrphaned` with the parameters,
132+
:parameter:`rangeDeleterBatchSize` and
133+
:parameter:`rangeDeleterBatchDelayMS`. For example:
133134

134-
To limit the number of documents deleted per batch, you can set
135-
`rangeDeleterBatchSize` to a small value such as `32`.
135+
- To limit the number of documents deleted per batch, you can set
136+
:parameter:`rangeDeleterBatchSize` to a small value such as ``32``.
136137

137-
To add an additional delay between batch deletions, you can set
138-
`rangeDeleterBatchDelayMS` above the current default of `20` milliseconds.
138+
- To add an additional delay between batch deletions, you can set
139+
:parameter:`rangeDeleterBatchDelayMS` above the current default of
140+
``20`` milliseconds.
139141

140-
Note that these affect all range deletion including normal
141-
:doc:`chunk migration</core/sharding-balancer-administration/#chunk-migration-procedure>`.
142+
.. note::
143+
144+
Changing :parameter:`rangeDeleterBatchSize` and
145+
:parameter:`rangeDeleterBatchDelayMS` affect all range deletion,
146+
including normal :ref:`chunk
147+
migration<chunk-migration-procedure>`.
148+
149+
If you are temporarily modifying one or both of these parameters to
150+
run :dbcommand:`cleanupOrphaned`, return to their previous values
151+
after you run :dbcommand:`cleanupOrphaned`.
142152

143153
.. _cleanupOrphaned-determine-range:
144154

0 commit comments

Comments
 (0)