Skip to content

Commit 9ddf379

Browse files
cleanup sync states page (#28)
* cleanup sync states page * wording
1 parent c35a71b commit 9ddf379

File tree

1 file changed

+15
-13
lines changed

1 file changed

+15
-13
lines changed

source/reference/mongosync-states.txt

Lines changed: 15 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -14,24 +14,26 @@
1414

1515

1616
``mongosync`` enters different states depending on the requests it
17-
receives. This page describes the states that ``mongosync`` can be in.
18-
``mongosync`` is in a single state at a particular time. The possible
19-
API operations you can run depend on the state of ``mongosync``.
17+
receives. ``mongosync`` can only be in a single state at a given time.
18+
The current ``mongosync`` states determines which API operations you can
19+
run.
20+
21+
This page describes ``mongosync`` states.
2022

2123
View the Current State
2224
----------------------
2325

24-
To view the current state of ``mongosync``, use the
25-
:ref:`/progress <c2c-api-progress>`. endpoint. The endpoint returns the
26-
state in the ``state`` field.
26+
To view the current state of ``mongosync``, use the :ref:`/progress
27+
<c2c-api-progress>`. endpoint. The :ref:`/progress <c2c-api-progress>`
28+
endpoint returns the state in the ``state`` field.
2729

2830
.. _c2c-states-descriptions:
2931

3032
State Descriptions
3133
------------------
3234

33-
The following table describes each state and the operations you can run
34-
when ``mongosync`` is in a given state.
35+
The following table describes each state and lists the permitted
36+
operations in that state.
3537

3638
.. list-table::
3739
:header-rows: 1
@@ -49,8 +51,8 @@ when ``mongosync`` is in a given state.
4951

5052
* - ``RUNNING``
5153
- The sync process is currently running. In this state, data is
52-
initially synced to the destination cluster, and subsequent
53-
writes are applied.
54+
initially synced to the destination cluster. Subsequent writes to
55+
the source cluster are applied to the destination cluster.
5456
- - ``POST`` :ref:`/pause <c2c-api-pause>`
5557
- ``POST`` :ref:`/commit <c2c-api-commit>`
5658
- ``GET`` :ref:`/progress <c2c-api-progress>`
@@ -64,9 +66,9 @@ when ``mongosync`` is in a given state.
6466
* - ``COMMITTING``
6567
- The cutover for the sync process has started. The time it takes
6668
to transition to the ``COMMITTED`` phase depends on
67-
``lagTimeSeconds``. To monitor ``lagTimeSeconds`` or see if
68-
``mongosync`` has finished committing, use the
69-
:ref:`/progress <c2c-api-progress>` endpoint.
69+
``lagTimeSeconds``. To monitor ``lagTimeSeconds`` or to see if
70+
``mongosync`` has finished committing, use the :ref:`/progress
71+
<c2c-api-progress>` endpoint.
7072
- - ``GET`` :ref:`/progress <c2c-api-progress>`
7173

7274
* - ``COMMITTED``

0 commit comments

Comments
 (0)