Skip to content

Commit 1aeaf31

Browse files
authored
DOCS-16422 clarifying write blocking behavior (#182)
* DOCS-16422 clarifying write blocking behavior * DOCS-16422 clarifying write blocking behavior * DOCS-16422 clarifying write blocking behavior * DOCS-16422 copy edits * DOCS-16422 copy edits * DOCS-16422 copy edits * DOCSP-16422 moving commit section and copy edits * DOCS-16422 fixing reference * DOCS-16422 active voice * DOCS-16422 fixing reference * DOCS-16422 copy edit
1 parent 8cd010c commit 1aeaf31

File tree

2 files changed

+27
-25
lines changed

2 files changed

+27
-25
lines changed

source/includes/fact-write-blocking-enable.rst

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
1-
When write-blocking is enabled, ``mongosync`` blocks writes:
1+
``mongosync`` does not enable write-blocking by default. If you enable
2+
write-blocking, ``mongosync`` blocks writes:
23

3-
- On the destination cluster during sync
4-
- On the source cluster while committing
4+
- On the destination cluster during sync.
5+
- On the source cluster while ``commit`` is running.
56

67
To enable write-blocking, use the :ref:`start API <c2c-api-start>`
78
to set ``enableUserWriteBlocking`` to ``true``. You cannot enable

source/reference/mongosync.txt

Lines changed: 23 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -132,24 +132,6 @@ Global Options
132132
Behavior
133133
--------
134134

135-
Commit
136-
~~~~~~
137-
138-
To stop syncing, use the :ref:`commit <c2c-api-commit>` command on the
139-
destination cluster to convert indexes and finalize the changes. While
140-
``commit`` is running:
141-
142-
- Writes are blocked on the source cluster.
143-
- Writes are blocked on the destination cluster until ``mongosync``
144-
begins index validation.
145-
146-
To monitor the ``commit`` process, use the :ref:`progress
147-
<c2c-api-progress>` command:
148-
149-
- The destination cluster is writable when ``canWrite`` is true.
150-
- Index conversion is complete when ``mongosync`` enters the
151-
``COMMITTED`` state.
152-
153135
.. _c2c-mongosync-config:
154136

155137
Cluster Independence
@@ -221,16 +203,35 @@ show an empty ``system.views`` collection in that database. The empty
221203
``system.views`` collection will not change the accuracy of user
222204
data on the destination.
223205

224-
.. c2c-write-blocking:
206+
.. _c2c-write-blocking:
225207

226208
Write Blocking
227209
~~~~~~~~~~~~~~
228210

229211
.. include:: /includes/fact-write-blocking-enable.rst
230212

231-
Write-blocking is not enabled by default. You must enable write-blocking
232-
when you start ``mongosync`` if you want to use :ref:`reverse
233-
synchronization <c2c-api-reverse>` later.
213+
You must enable write-blocking when you start ``mongosync`` if you want
214+
to use :ref:`reverse synchronization <c2c-api-reverse>` later.
215+
216+
Commit
217+
~~~~~~
218+
219+
To stop syncing, use the :ref:`commit <c2c-api-commit>` command on the
220+
destination cluster to convert indexes and finalize the changes. If you
221+
enable :ref:`write-blocking <c2c-write-blocking>`:
222+
223+
224+
- ``commit`` blocks writes on the source cluster.
225+
- ``commit`` blocks writes on the destination cluster until
226+
``mongosync`` begins index validation.
227+
228+
229+
To monitor the ``commit`` process, use the :ref:`progress
230+
<c2c-api-progress>` command:
231+
232+
- The destination cluster is writable when ``canWrite`` is true.
233+
- Index conversion is complete when ``mongosync`` enters the
234+
``COMMITTED`` state.
234235

235236
User Permissions
236237
````````````````

0 commit comments

Comments
 (0)