Skip to content

Commit cd47f51

Browse files
authored
DOCSP-43406-write-blocking-limitation-clarification (#489)
* DOCSP-43406-write-blocking-limitation-clarification * DOCSP-43406 fixing ref' * DOCSP-43406 fixing ref * DOCSP-43406 fixing ref * DOCSP-43406 copy edits * DOCSP-43406 tech edit
1 parent 9ea9290 commit cd47f51

File tree

2 files changed

+19
-3
lines changed

2 files changed

+19
-3
lines changed

source/about-mongosync.txt

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -126,6 +126,20 @@ Finalize Sync
126126
To finalize the sync between the source and destination clusters,
127127
call the :ref:`commit <c2c-api-commit>` endpoint.
128128

129+
.. note::
130+
131+
You must block writes to the source cluster before you begin the
132+
the commit process.
133+
134+
If you previously set ``enableUserWriteBlocking`` to ``true`` when
135+
you used the :ref:`start <c2c-api-start>` endpoint, ``mongosync``
136+
automatically blocks writes on the source cluster when you use the
137+
``commit`` endpoint.
138+
139+
If you did not set ``enableUserWriteBlocking`` to ``true``, run
140+
:dbcommand:`setUserWriteBlockMode` on the source cluster to
141+
block writes.
142+
129143
The ``commit`` endpoint starts the :ref:`COMMITTING <c2c-state-committing>`
130144
state, which is when ``mongosync`` stops continuous sync between the source and
131145
destination clusters.

source/reference/limitations.txt

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -34,9 +34,11 @@ General Limitations
3434
are properly configured.
3535
- Other clients must not write to the destination cluster while
3636
``mongosync`` is running.
37-
- If write blocking is disabled, the client must :ref:`prevent writes
38-
<c2c-api-start>` to the source cluster before starting the commit
39-
process.
37+
- If you want to start the :ref:`commit <c2c-api-commit>`
38+
process and you did not set ``enableUserWriteBlocking`` to ``true``
39+
when you used the :ref:`c2c-api-start` endpoint, you
40+
must :ref:`prevent writes <c2c-api-start>` to the source cluster
41+
before you start the commit process.
4042
- :ref:`system.* collections <metadata-system-collections>` aren't
4143
replicated.
4244
- Documents that have dollar (``$``) prefixed field names aren't

0 commit comments

Comments
 (0)