Skip to content

Commit 284c36d

Browse files
authored
DOCSP 28174 adding info to commit page (#222)
* DOCSP-28714 clarifying commit * DOCSP-28174 adding commit information * DOCSP-28174 adding commit information * DOCSP-28174 copy edits * DOCSP-28174 copy edits * DOCSP-28174 adding commit behavior table * DOCSP-28174 adding commit behavior table * DOCSP-28174 adding commit behavior table * DOCSP-28174 adding commit behavior table * DOCSP-28174 updating disaster recovery
1 parent 4027ad4 commit 284c36d

File tree

2 files changed

+40
-4
lines changed

2 files changed

+40
-4
lines changed

source/reference/api/commit.txt

Lines changed: 37 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,39 @@
1515
Description
1616
-----------
1717

18-
Commits the synchronization operation to the destination cluster.
18+
Finalizes the sync between the source cluster and the destination
19+
cluster and stops continuous sync between clusters. ``commit`` also
20+
restores collection characteristics that ``mongosync`` temporarily
21+
alters during synchronization.
22+
23+
The following table illustrates the impact of ``commit`` on collection
24+
characteristics that ``mongosync`` alters during the synchronization process.
25+
26+
.. list-table::
27+
:header-rows: 1
28+
29+
* - Collection Characteristic
30+
- Impact of ``commit``
31+
* - :ref:`Unique Indexes <c2c-dr-unique>`
32+
- ``commit`` resets unique indexes that ``mongosync`` replicated as
33+
non-unique on the destination cluster.
34+
35+
* - :ref:`TTL Indexes <c2c-dr-ttl>`
36+
- ``commit`` resets ``expireAfterSeconds`` which ``mongosync`` set
37+
to the value of ``MAX_INT`` on the destination cluster.
38+
39+
* - :ref:`Hidden Indexes <c2c-dr-hidden>`
40+
- ``commit`` resets hidden indexes that ``mongosync``
41+
replicated as non-hidden on the destination cluster.
42+
43+
* - :ref:`Write Blocking <c2c-dr-write-blocking>`
44+
- If ``mongosync`` disabled writes on the destination cluster,
45+
``commit`` disables the Write Block Mode.
46+
47+
* - :ref:`Capped Collections <c2c-dr-capped-collections>`
48+
- ``commit`` resets the required maximum size of capped collections
49+
which ``mongosync`` set to the maximum allowable size on the
50+
destination cluster.
1951

2052
Requirements
2153
------------
@@ -114,4 +146,7 @@ Behavior
114146

115147
If the ``commit`` request is successful, ``mongosync`` enters the
116148
``COMMITTING`` state, then automatically transitions to the
117-
``COMMITTED`` state.
149+
``COMMITTED`` state. Once ``mongosync`` enters the ``COMMITTED`` state,
150+
continuous sync between the clusters stops.
151+
152+

source/reference/disaster-recovery.txt

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,9 @@ during synchronization. The original values are restored during the
2525
you must manually reset these collection characteristics on the destination
2626
cluster before you can use it as the primary cluster.
2727

28-
To prepare the destination cluster to replace the source cluster, make the
29-
following changes:
28+
To prepare the destination cluster to replace the source cluster, make
29+
the following changes that mimic the sync finalization process of the
30+
``commit`` endpoint.
3031

3132
.. list-table::
3233
:header-rows: 1

0 commit comments

Comments
 (0)