Skip to content

Commit 11015e5

Browse files
(DOCS-14449): maxCatchUpPercentageBeforeBlockingWrites server parameter
1 parent f12dd91 commit 11015e5

File tree

3 files changed

+46
-1
lines changed

3 files changed

+46
-1
lines changed

source/reference/command/moveChunk.txt

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -193,5 +193,14 @@ while :dbcommand:`moveChunk` is running, you may see this
193193
error. You may retry the :dbcommand:`moveChunk` operation without
194194
side effects.
195195

196+
``maxCatchUpPercentageBeforeBlockingWrites`` Server Parameter
197+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
198+
199+
Starting in MongoDB 4.0.26, you can set the
200+
:parameter:`maxCatchUpPercentageBeforeBlockingWrites` to specify the
201+
maximum allowed percentage of data not yet migrated
202+
during a :dbcommand:`moveChunk` operation when compared to the
203+
total size (in MBs) of the chunk being transferred.
204+
196205

197206
.. admin-only

source/reference/parameters.txt

Lines changed: 35 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1807,6 +1807,8 @@ Sharding Parameters
18071807

18081808
.. parameter:: AsyncRequestsSenderUseBaton
18091809

1810+
.. versionadded:: 4.0
1811+
18101812
Type: boolean
18111813

18121814
Default: true
@@ -1818,7 +1820,39 @@ Sharding Parameters
18181820

18191821
.. seealso:: :parameter:`taskExecutorPoolSize`
18201822

1821-
.. versionadded:: 4.0
1823+
.. parameter:: maxCatchUpPercentageBeforeBlockingWrites
1824+
1825+
.. versionadded:: 4.0.26
1826+
1827+
Type: integer
1828+
1829+
Default: 10
1830+
1831+
|mongod-only|
1832+
1833+
For :dbcommand:`moveChunk` operations, specifies the maximum
1834+
percentage of untrasferred data allowed by the migration protocol
1835+
(expressed in percentage of the total chunk size) to
1836+
transition from the ``catchup`` phase to the ``commit`` phase.
1837+
1838+
Setting a higher catchup percentage can decrease the amount of time
1839+
it takes for the migration to complete at the cost of increased
1840+
latency during concurrent :method:`upsert <db.collection.updateOne>`
1841+
and :method:`delete <db.collection.deleteOne>` operations.
1842+
1843+
For example, to set the maximum percentage to 20, you can issue the
1844+
followingduring startup:
1845+
1846+
.. code-block:: bash
1847+
1848+
mongod --setParameter maxCatchUpPercentageBeforeBlockingWrites=20
1849+
1850+
You cannot change
1851+
:parameter:`maxCatchUpPercentageBeforeBlockingWrites` during runtime.
1852+
1853+
.. seealso::
1854+
1855+
`Live Migration Protocol <https://github.com/mongodb/mongo/blob/master/src/mongo/db/s/README.md#the-live-migration-protocol>`__
18221856

18231857
.. parameter:: replMonitorMaxFailedChecks
18241858

source/tutorial/migrate-chunks-in-sharded-cluster.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. _migrate-chunks-sharded-cluster:
2+
13
===================================
24
Migrate Chunks in a Sharded Cluster
35
===================================

0 commit comments

Comments
 (0)