From e6fe0f630cbad6c6f237ba4039e00106b601c266 Mon Sep 17 00:00:00 2001 From: ltran-mdb2 <143426234+ltran-mdb2@users.noreply.github.com> Date: Tue, 19 Nov 2024 16:59:26 -0500 Subject: [PATCH] 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 (cherry picked from commit cd47f513ad9549a2994cbb2322cce192a05071d8) --- source/about-mongosync.txt | 14 ++++++++++++++ source/reference/limitations.txt | 8 +++++--- 2 files changed, 19 insertions(+), 3 deletions(-) diff --git a/source/about-mongosync.txt b/source/about-mongosync.txt index 0258b9cf7..5165aa773 100644 --- a/source/about-mongosync.txt +++ b/source/about-mongosync.txt @@ -124,6 +124,20 @@ Finalize Sync To finalize the sync between the source and destination clusters, call the :ref:`commit ` endpoint. +.. note:: + + You must block writes to the source cluster before you begin the + the commit process. + + If you previously set ``enableUserWriteBlocking`` to ``true`` when + you used the :ref:`start ` endpoint, ``mongosync`` + automatically blocks writes on the source cluster when you use the + ``commit`` endpoint. + + If you did not set ``enableUserWriteBlocking`` to ``true``, run + :dbcommand:`setUserWriteBlockMode` on the source cluster to + block writes. + The ``commit`` endpoint starts the :ref:`COMMITTING ` state, which is when ``mongosync`` stops continuous sync between the source and destination clusters. diff --git a/source/reference/limitations.txt b/source/reference/limitations.txt index c6f3a2d1b..4001a5c2f 100644 --- a/source/reference/limitations.txt +++ b/source/reference/limitations.txt @@ -34,9 +34,11 @@ General Limitations are properly configured. - Other clients must not write to the destination cluster while ``mongosync`` is running. -- If write blocking is disabled, the client must :ref:`prevent writes - ` to the source cluster before starting the commit - process. +- If you want to start the :ref:`commit ` + process and you did not set ``enableUserWriteBlocking`` to ``true`` + when you used the :ref:`c2c-api-start` endpoint, you + must :ref:`prevent writes ` to the source cluster + before you start the commit process. - :ref:`system.* collections ` aren't replicated. - Documents that have dollar (``$``) prefixed field names aren't