|
15 | 15 | Description
|
16 | 16 | -----------
|
17 | 17 |
|
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. |
19 | 51 |
|
20 | 52 | Requirements
|
21 | 53 | ------------
|
@@ -114,4 +146,7 @@ Behavior
|
114 | 146 |
|
115 | 147 | If the ``commit`` request is successful, ``mongosync`` enters the
|
116 | 148 | ``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 | + |
0 commit comments