Skip to content

Commit 0e91078

Browse files
authored
DOCSP 30174 clarifying estimatedCopiedByes and estimatedTotalBytes (#268) (#270)
* 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 82c3f5f commit 0e91078

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
@@ -58,7 +58,16 @@
5858
``.estimatedTotalBytes``
5959
- integer
6060
- Estimated total number of bytes to be copied globally by all
61-
``mongosync`` instances during the initial copying of collections.
61+
``mongosync`` instances during the initial copying of
62+
collections.
63+
64+
.. note::
65+
66+
``mongosync`` approximates the estimated total number of bytes
67+
prior to migration and does not update this value during the
68+
synchronization process. This value does not reflect changes
69+
made to the source cluster during sync and is not an accurate
70+
indicator of migration progress.
6271

6372
* - ``collectionCopy``
6473
``.estimatedCopiedBytes``
@@ -72,6 +81,14 @@
7281
and divide the result by the value of the ``estimatedTotalBytes`` field
7382
. Then, multiply the result by 100.
7483

84+
.. note::
85+
86+
The value of ``estimatedCopiedBytes`` may be larger than the
87+
value of the ``estimatedTotalBytes`` due to retried operations.
88+
A comparison of ``estimatedTotalBytes`` and
89+
``estimatedCopiedBytes`` is not an accurate indicator of
90+
migration progress.
91+
7592
* - ``directionMapping``
7693
- object
7794
- Describes the mapping direction for the synchronization, namely

0 commit comments

Comments
 (0)