Skip to content

Commit 01bc588

Browse files
authored
DOCSP 30174 clarifying estimatedCopiedByes and estimatedTotalBytes (#268)
* DOCSP-30174 clarifying estimatedCopiedByes and estimatedTotalBytes * DOCSP-30174 clarifying estimatedCopiedByes and estimatedTotalBytes * DOCSP-30174 clarifying estimatedCopiedByes and estimatedTotalBytes * DOCSP-30174 clarifying estimatedCopiedByes and estimatedTotalBytes * DOCSP-30174 tech edit * DOCSP-30174 tech edit * DOCSP-30174 tech edits * DOCSP-30174 tech edits
1 parent 27265f5 commit 01bc588

File tree

1 file changed

+18
-1
lines changed

1 file changed

+18
-1
lines changed

source/includes/api/tables/progress-response.rst

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,16 @@
6464
``.estimatedTotalBytes``
6565
- integer
6666
- Estimated total number of bytes to be copied globally by all
67-
``mongosync`` instances during the initial copying of collections.
67+
``mongosync`` instances during the initial copying of
68+
collections.
69+
70+
.. note::
71+
72+
``mongosync`` approximates the estimated total number of bytes
73+
prior to migration and does not update this value during the
74+
synchronization process. This value does not reflect changes
75+
made to the source cluster during sync and is not an accurate
76+
indicator of migration progress.
6877

6978
* - ``collectionCopy``
7079
``.estimatedCopiedBytes``
@@ -78,6 +87,14 @@
7887
and divide the result by the value of the ``estimatedTotalBytes`` field
7988
. Then, multiply the result by 100.
8089

90+
.. note::
91+
92+
The value of ``estimatedCopiedBytes`` may be larger than the
93+
value of the ``estimatedTotalBytes`` due to retried operations.
94+
A comparison of ``estimatedTotalBytes`` and
95+
``estimatedCopiedBytes`` is not an accurate indicator of
96+
migration progress.
97+
8198
* - ``directionMapping``
8299
- object
83100
- Describes the mapping direction for the synchronization, namely

0 commit comments

Comments
 (0)