Skip to content
This repository was archived by the owner on May 1, 2025. It is now read-only.

Commit 2c394d9

Browse files
committed
write blocking params
1 parent 07991f7 commit 2c394d9

File tree

2 files changed

+22
-19
lines changed

2 files changed

+22
-19
lines changed

source/includes/live-upgrade.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,4 @@ only live upgrade to ``mongosync`` 1.7.3 or later from ``mongosync``
55

66
.. important::
77

8-
``mongosync`` does not support live upgrades to version 1.11.
8+
``mongosync`` does not support live upgrades to version 1.11 or 1.12.

source/reference/api/start.txt

Lines changed: 21 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -117,26 +117,29 @@ Request Body Parameters
117117
* - ``enableUserWriteBlocking``
118118
- boolean or string
119119
- Optional
120-
- If set to ``true``, blocks writes on the destination
121-
cluster while the migration is in progress, and unblocks writes right
122-
before the :ref:`/progress <c2c-api-progress>` endpoint reports
123-
that ``canWrite`` is ``true``. Blocks writes on the source
124-
cluster after ``mongosync`` calls the :ref:`/commit <c2c-api-commit>`
125-
endpoint.
126-
127-
If set to ``false``, no write blocking occurs.
128-
129-
If set to ``"destinationOnly"``, blocks writes on the destination
130-
cluster while migration is in progress, and unblocks writes right
131-
before ``canWrite`` is ``true``.
132-
133-
:gold:`IMPORTANT:` If you are migrating from a pre-6.0 source cluster,
134-
you cannot set ``enableUserWriteBlocking`` to ``true``.
120+
- Supported options:
121+
122+
- ``true`` or ``"sourceAndDestination"``: blocks writes on the destination
123+
cluster while the migration is in progress, and unblocks writes right
124+
before the :ref:`/progress <c2c-api-progress>` endpoint reports
125+
that ``canWrite`` is ``true``. Blocks writes on the source
126+
cluster after ``mongosync`` calls the :ref:`/commit <c2c-api-commit>`
127+
endpoint.
128+
129+
:gold:`IMPORTANT:` If you are migrating from a pre-6.0 source cluster,
130+
you cannot set ``enableUserWriteBlocking`` to ``true`` or
131+
``"sourceAndDestination"``.
132+
133+
- ``false`` or ``"none"``: no write blocking occurs.
134+
135+
- ``"destinationOnly"``: blocks writes on the destination
136+
cluster while migration is in progress, and unblocks writes right
137+
before ``canWrite`` is ``true``.
135138

136139
To reverse sync, the ``enableUserWriteBlocking`` field must be set
137-
to ``true``. To allow the source cluster to accept writes again,
138-
for example after running migration tests, run the following
139-
command:
140+
to ``true`` or ``"sourceAndDestination"``. To allow the source cluster
141+
to accept writes again, for example after running migration tests,
142+
run the following command:
140143

141144
.. code-block:: shell
142145

0 commit comments

Comments
 (0)