Skip to content

Commit 3561e2c

Browse files
npentreljeff-allen-mongo
authored andcommitted
Add references to resharding operation
1 parent fecea3c commit 3561e2c

File tree

3 files changed

+178
-151
lines changed

3 files changed

+178
-151
lines changed

source/reference/command/currentOp.txt

Lines changed: 54 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -1110,19 +1110,19 @@ Output Fields
11101110

11111111
.. data:: currentOp.totalOperationTimeElapsed
11121112

1113-
The total time elapsed, in seconds, for the current resharding
1114-
operation. The time is set to 0 when a new resharding operation
1115-
starts.
1113+
The total time elapsed, in seconds, for the current :ref:`resharding
1114+
operation <sharding-resharding>`. The time is set to 0 when a new
1115+
resharding operation starts.
11161116

11171117
Only present if a resharding operation is taking place.
11181118

11191119
.. versionadded:: 5.0
11201120

11211121
.. data:: currentOp.remainingOperationTimeEstimated
11221122

1123-
The estimated time remaining in seconds for the current resharding
1124-
operation. The time is set to -1 when a new resharding operation
1125-
starts.
1123+
The estimated time remaining in seconds for the current
1124+
:ref:`resharding operation <sharding-resharding>`. The time is set to
1125+
-1 when a new resharding operation starts.
11261126

11271127
Only present when a resharding operation is taking place.
11281128

@@ -1131,11 +1131,11 @@ Output Fields
11311131
.. data:: currentOp.approxDocumentsToCopy
11321132

11331133
The approximate number of documents to be copied from the donor
1134-
shards to the recipient shards during the resharding operation. This
1135-
number is an estimate that is set at the beginning of the resharding
1136-
operation and does not change after it has been set. The number is
1137-
set to 0 when a new resharding operation starts. It is
1138-
possible for ``$currentOp.documentsCopied`` and
1134+
shards to the recipient shards during the :ref:`resharding operation
1135+
<sharding-resharding>`. This number is an estimate that is set at the
1136+
beginning of the resharding operation and does not change after it
1137+
has been set. The number is set to 0 when a new resharding operation
1138+
starts. It is possible for ``$currentOp.documentsCopied`` and
11391139
``$currentOp.bytesCopied`` to end up exceeding
11401140
``$currentOp.approxDocumentsToCopy`` and
11411141
``$currentOp.approxBytesToCopy``, respectively, if
@@ -1149,8 +1149,8 @@ Output Fields
11491149
.. data:: currentOp.documentsCopied
11501150

11511151
The number of documents copied form donor shards to recipient shards
1152-
during the resharding operation. The number is set to 0 when a new
1153-
resharding operation starts.
1152+
during the :ref:`resharding operation <sharding-resharding>`. The
1153+
number is set to 0 when a new resharding operation starts.
11541154

11551155
Only present on a recipient shard when a resharding operation is
11561156
taking place.
@@ -1160,12 +1160,13 @@ Output Fields
11601160
.. data:: currentOp.approxBytesToCopy
11611161

11621162
The approximate number of bytes to be copied from the donor shards to
1163-
the recipient shards during the resharding operation. This number is
1164-
an estimate that is set at the beginning of the resharding operation
1165-
and does not change after it has been set. The number is set to 0
1166-
when a new resharding operation starts. It is possible for
1167-
``$currentOp.documentsCopied`` and ``$currentOp.bytesCopied`` to end
1168-
up exceeding ``$currentOp.approxDocumentsToCopy`` and
1163+
the recipient shards during the :ref:`resharding operation
1164+
<sharding-resharding>`. This number is an estimate that is set at the
1165+
beginning of the resharding operation and does not change after it
1166+
has been set. The number is set to 0 when a new resharding operation
1167+
starts. It is possible for ``$currentOp.documentsCopied`` and
1168+
``$currentOp.bytesCopied`` to end up exceeding
1169+
``$currentOp.approxDocumentsToCopy`` and
11691170
``$currentOp.approxBytesToCopy``, respectively, if the
11701171
post-resharding data distribution is not perfectly uniform.
11711172

@@ -1177,8 +1178,8 @@ Output Fields
11771178
.. data:: currentOp.bytesCopied
11781179

11791180
The number of bytes copied from donor shards to recipient shards
1180-
during the resharding operation. The number is set to 0 when a new
1181-
resharding operation starts.
1181+
during the :ref:`resharding operation <sharding-resharding>`. The
1182+
number is set to 0 when a new resharding operation starts.
11821183

11831184
Only present on a recipient shard when a resharding operation is
11841185
taking place.
@@ -1188,9 +1189,9 @@ Output Fields
11881189
.. data:: currentOp.totalCopyTimeElapsed
11891190

11901191
The total elapsed time, in seconds, for ongoing data copy tasks from
1191-
donor shards to recipient shards for the current resharding
1192-
operation. The time is set to 0 when a new resharding operation
1193-
starts.
1192+
donor shards to recipient shards for the current :ref:`resharding
1193+
operation <sharding-resharding>`. The time is set to 0 when a new
1194+
resharding operation starts.
11941195

11951196
Only present on a recipient shard when a resharding operation is
11961197
taking place.
@@ -1200,8 +1201,8 @@ Output Fields
12001201
.. data:: currentOp.oplogEntriesFetched
12011202

12021203
The number of entries fetched from the :term:`oplog` for the current
1203-
resharding operation. The number is set to 0 when a new resharding
1204-
operation starts.
1204+
:ref:`resharding operation <sharding-resharding>`. The number is set
1205+
to 0 when a new resharding operation starts.
12051206

12061207
Only present on a recipient shard when a resharding operation is
12071208
taking place.
@@ -1211,8 +1212,8 @@ Output Fields
12111212
.. data:: currentOp.oplogEntriesApplied
12121213

12131214
The number of entries applied to the :term:`oplog` for the current
1214-
resharding operation. The number is set to 0 when a new resharding
1215-
operation starts.
1215+
:ref:`resharding operation <sharding-resharding>`. The number is set
1216+
to 0 when a new resharding operation starts.
12161217

12171218
Only present on a recipient shard when a resharding operation is
12181219
taking place.
@@ -1222,10 +1223,10 @@ Output Fields
12221223
.. data:: currentOp.totalApplyTimeElapsed
12231224

12241225
The total elapsed time, in seconds, for the apply step of the
1225-
current resharding operation. In the apply step, recipient shards
1226-
apply :term:`oplog` entries to modify their data based on new
1227-
incoming writes from donor shards. The time is set to 0 when a new
1228-
resharding operation starts.
1226+
current :ref:`resharding operation <sharding-resharding>`. In the
1227+
apply step, recipient shards apply :term:`oplog` entries to modify
1228+
their data based on new incoming writes from donor shards. The time
1229+
is set to 0 when a new resharding operation starts.
12291230

12301231
Only present on a recipient shard when a resharding operation is
12311232
taking place.
@@ -1235,9 +1236,10 @@ Output Fields
12351236
.. data:: currentOp.countWritesDuringCriticalSection
12361237

12371238
The number of writes perfomed in the critical section for the current
1238-
resharding operation. The critical section prevents new incoming
1239-
writes to the collection currently being resharded. The number is set
1240-
to 0 when a new resharding operation starts.
1239+
:ref:`resharding operation <sharding-resharding>`. The critical
1240+
section prevents new incoming writes to the collection currently
1241+
being resharded. The number is set to 0 when a new resharding
1242+
operation starts.
12411243

12421244
Only present on a donor shard when a resharding operation is taking
12431245
place.
@@ -1247,9 +1249,10 @@ Output Fields
12471249
.. data:: currentOp.totalCriticalSectionTimeElapsed
12481250

12491251
The total elapsed time, in seconds, for the critical section of the
1250-
current resharding operation. The critical section prevents new
1251-
incoming writes to the collection currently being resharded. The time
1252-
is set to 0 when a new resharding operation starts.
1252+
current :ref:`resharding operation <sharding-resharding>`. The
1253+
critical section prevents new incoming writes to the collection
1254+
currently being resharded. The time is set to 0 when a new
1255+
resharding operation starts.
12531256

12541257
Only present on a donor shard when a resharding operation is taking
12551258
place.
@@ -1258,8 +1261,9 @@ Output Fields
12581261

12591262
.. data:: currentOp.donorState
12601263

1261-
The current state of a donor shard for the resharding operation. The
1262-
state is set to ``unused`` when a new resharding operation starts.
1264+
The current state of a donor shard for the :ref:`resharding operation
1265+
<sharding-resharding>`. The state is set to ``unused`` when a new
1266+
resharding operation starts.
12631267

12641268
Only present on a donor shard when a resharding operation is taking
12651269
place.
@@ -1306,9 +1310,9 @@ Output Fields
13061310

13071311
.. data:: currentOp.recipientState
13081312

1309-
The current state of a recipient shard for a resharding operation.
1310-
The state is set to ``unused`` when a new resharding operation
1311-
starts.
1313+
The current state of a recipient shard for a :ref:`resharding
1314+
operation <sharding-resharding>`. The state is set to ``unused`` when
1315+
a new resharding operation starts.
13121316

13131317
Only present on a donor shard when a resharding operation is taking
13141318
place.
@@ -1354,11 +1358,11 @@ Output Fields
13541358

13551359
.. data:: currentOp.coordinatorState
13561360

1357-
The state of the resharding coordinator for the current resharding
1358-
operation. The resharding coordinator is an operation that runs on
1359-
the :doc:`config server </core/sharded-cluster-config-servers>`
1360-
primary. The state is set to ``unused`` when a new resharding
1361-
operation starts.
1361+
The state of the resharding coordinator for the current
1362+
:ref:`resharding operation <sharding-resharding>`. The resharding
1363+
coordinator is an operation that runs on the :doc:`config server
1364+
</core/sharded-cluster-config-servers>` primary. The state is set to
1365+
``unused`` when a new resharding operation starts.
13621366

13631367
Only present on the coordinating config server.
13641368

@@ -1426,7 +1430,8 @@ Output Fields
14261430

14271431
.. data:: currentOp.opStatus
14281432

1429-
The current state of a resharding operation.
1433+
The current state of a :ref:`resharding operation
1434+
<sharding-resharding>`.
14301435

14311436
Only present if a resharding operation is taking place. Once the
14321437
operation has completed, the operation is removed from ``currentOp``

0 commit comments

Comments
 (0)