Skip to content

Commit 3ce9616

Browse files
kennethdyerksuarz
kennethdyer
and
ksuarz
authored
DOCSP-27277 - EOL Reference Cleanup for Database Commands (#2327) (#2… (#2518)
* DOCSP-27277 - EOL Reference Cleanup for Database Commands (#2327) (#2515) * DOCSP-27277 - EOL Reference Cleanup for Database Commands (#2327) * DOCSP-27277 EOL version reference cleanup for Database Commands * Refactors version references to use directive * Version cleanup createIndexes and serverStatus * EOL version cleanup for currentOp * EOL version cleanup for currentOp * EOL version cleanup for listDatabases * EOL version cleanup for listDatabases * EOL version cleanup for listCollections * EOL version cleanup for listCollections * EOL version cleanup for usersInfo * EOL reference fixes for dbHash and updateUser * EOL reference fixes for killOp replSetSyncFrom * Fixes per Kyle Suarez * Fixes per Kyle Suarez. Co-authored-by: Kyle Suarez <[email protected]> --------- Co-authored-by: Kyle Suarez <[email protected]> * Reverts text to fix build errors * Fixes indentation from cherry-pick --------- Co-authored-by: Kyle Suarez <[email protected]> * Fixes build error --------- Co-authored-by: Kyle Suarez <[email protected]>
1 parent 788acd4 commit 3ce9616

12 files changed

+184
-436
lines changed

‎source/includes/extracts-command-field.yaml

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
11
ref: _command-field
22
content: |
33
4-
.. versionchanged:: 3.6
5-
64
A document containing the full command object associated with this
75
operation.
86

‎source/includes/fact-voting-node-sync-incompatibility.rst

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,2 @@
1-
MongoDB 3.2 replica set members with :rsconf:`1 vote
2-
<members[n].votes>` cannot sync from members with :rsconf:`0 votes
3-
<members[n].votes>`.
1+
Replica set members with :rsconf:`1 vote <members[n].votes>`
2+
cannot sync from members with :rsconf:`0 votes <members[n].votes>`.

‎source/reference/command/createIndexes.txt

Lines changed: 41 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -83,29 +83,25 @@ Definition
8383

8484
- Optional. A document expressing the :doc:`write concern
8585
</reference/write-concern>`. Omit to use the default write concern.
86-
87-
.. versionadded:: 3.4
88-
89-
90-
86+
9187
.. _createIndexes-options:
9288

9389
Each document in the ``indexes`` array can take the following fields:
94-
90+
9591
.. list-table::
9692
:header-rows: 1
9793
:widths: 20 20 80
98-
94+
9995
* - Field
100-
96+
10197
- Type
102-
98+
10399
- Description
104-
100+
105101
* - ``key``
106-
102+
107103
- document
108-
104+
109105
-
110106
Specifies the index's fields. For each field, specify a key-value pair
111107
in which the key is the name of the field to index and the value is
@@ -118,7 +114,7 @@ Definition
118114
MongoDB supports several different index types including
119115
:ref:`text <index-feature-text>`, :ref:`geospatial
120116
<index-feature-geospatial>`, and :ref:`hashed
121-
<index-type-hashed>` indexes. See :ref:`index types <index-types>`
117+
indexes <index-type-hashed>`. See :ref:`index types <index-types>`
122118
for more information.
123119

124120
.. versionchanged:: 4.2
@@ -166,29 +162,29 @@ Definition
166162

167163

168164

169-
165+
170166
* - ``name``
171-
167+
172168
- string
173-
169+
174170
- A name that uniquely identifies the index.
175171

176172

177-
173+
178174
* - ``background``
179-
175+
180176
- boolean
181-
177+
182178
- Optional. *Deprecated in MongoDB 4.2.*
183179

184180
.. include:: /includes/extracts/4.2-index-background.rst
185181

186182

187-
183+
188184
* - ``unique``
189-
185+
190186
- boolean
191-
187+
192188
- Optional. Creates a unique index so that the collection will not accept
193189
insertion or update of documents where the index key value matches an existing
194190
value in the index.
@@ -197,16 +193,16 @@ Definition
197193
Specify ``true`` to create a unique index. The
198194
default value is ``false``.
199195

200-
The option is *unavailable* for :doc:`hashed </core/index-hashed>`
196+
The option is *unavailable* for :ref:`hashed <index-hashed-index>`
201197
indexes.
202198

203199

204200

205-
201+
206202
* - ``partialFilterExpression``
207-
203+
208204
- document
209-
205+
210206
- Optional. If specified, the index only references documents that match the
211207
filter expression. See :doc:`/core/index-partial` for more information.
212208

@@ -218,50 +214,44 @@ Definition
218214
You can specify a ``partialFilterExpression`` option for all MongoDB
219215
:ref:`index types <index-types>`.
220216

221-
.. versionadded:: 3.2
222217

223218

224-
225-
219+
226220
* - ``sparse``
227-
221+
228222
- boolean
229-
223+
230224
- Optional. If ``true``, the index only references documents with the specified
231225
field. These indexes use less space but behave differently in some
232226
situations (particularly sorts). The default value is ``false``.
233227
See :doc:`/core/index-sparse` for more information.
234-
228+
235229
The following index types are sparse by default and ignore
236230
this option:
237-
231+
238232
- :doc:`2dsphere </core/2dsphere>`
239233
- :doc:`2d </core/2d>`
240234
- :doc:`geoHaystack </core/geohaystack>`
241-
- :doc:`text </core/index-text>`
242-
235+
- :ref:`text <index-feature-text>`
236+
243237
For a compound index that includes ``2dsphere`` index key(s)
244238
along with keys of other types, only the ``2dsphere`` index
245239
fields determine whether the index references a document.
246-
247-
.. versionchanged:: 3.2
248-
249-
Starting in MongoDB 3.2, MongoDB provides the option to create
250-
:ref:`partial indexes <index-type-partial>`. Partial indexes
251-
offer a superset of the functionality of sparse indexes. If you
252-
are using MongoDB 3.2 or later, :ref:`partial indexes
253-
<index-type-partial>` should be preferred over sparse indexes.
254-
240+
241+
242+
MongoDB provides the option to create
243+
:ref:`partial indexes <index-type-partial>`. These
244+
offer a superset of the functionality of sparse indexes
245+
and are preferred instead.
246+
255247
* - ``expireAfterSeconds``
256-
248+
257249
- integer
258250

259251
- Optional. Specifies a value, in seconds, as a :term:`TTL` to control how long
260252
MongoDB retains documents in this collection. See
261253
:doc:`/tutorial/expire-data` for more information on this
262254
functionality. This applies only to :term:`TTL` indexes.
263-
264-
265255

266256
* - ``storageEngine``
267257

@@ -448,11 +438,9 @@ Definition
448438
Considerations
449439
--------------
450440

451-
.. versionchanged:: 3.2
452-
453-
MongoDB disallows the creation of :ref:`version 0
454-
<3.2-version-0-indexes>` indexes. To upgrade existing version 0
455-
indexes, see :ref:`3.2-version-0-indexes`.
441+
MongoDB disallows the creation of :ref:`version 0
442+
<3.2-version-0-indexes>` indexes. To upgrade existing version 0
443+
indexes, see :ref:`3.2-version-0-indexes`.
456444

457445
Index Names
458446
~~~~~~~~~~~
@@ -518,9 +506,7 @@ Concurrency
518506
Memory Usage Limit
519507
~~~~~~~~~~~~~~~~~~
520508

521-
.. versionchanged:: 3.4
522-
523-
.. include:: /includes/fact-index-build-default-memory-limit.rst
509+
.. include:: /includes/fact-index-build-default-memory-limit.rst
524510

525511

526512
Index Options

‎source/reference/command/currentOp.txt

Lines changed: 1 addition & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ On systems running with :setting:`~security.authorization`, the user
8585
must have access that includes the :authaction:`inprog` privilege
8686
action.
8787

88-
Starting in 3.2.9, users can use
88+
Users can use
8989
``$ownOps`` on :binary:`~bin.mongod` instances to view their own
9090
operations without the :authaction:`inprog` privilege action.
9191

@@ -125,8 +125,6 @@ Write Operations Waiting for a Lock
125125
The following example returns information on all write operations that
126126
are waiting for a lock:
127127

128-
.. versionchanged:: 3.6
129-
130128
.. code-block:: javascript
131129

132130
db.adminCommand(
@@ -179,8 +177,6 @@ database ``db1`` that have been running longer than 3 seconds:
179177
Active Indexing Operations
180178
~~~~~~~~~~~~~~~~~~~~~~~~~~
181179

182-
.. versionchanged:: 3.6
183-
184180
The following example returns information on index creation operations:
185181

186182
.. code-block:: javascript
@@ -307,8 +303,6 @@ Output Fields
307303

308304
Only present if the operation is part of a multi-document transaction.
309305

310-
.. versionadded:: 4.0
311-
312306
.. data:: currentOp.transaction.parameters
313307

314308
A document that contains information on multi-document
@@ -317,25 +311,19 @@ Output Fields
317311
Only present if the operation is part of a multi-document
318312
transaction.
319313

320-
.. versionadded:: 4.0
321-
322314
.. data:: currentOp.transaction.parameters.txnNumber
323315

324316
The transaction number.
325317

326318
Only present if the operation is part of a multi-document transaction.
327319

328-
.. versionadded:: 4.0
329-
330320
.. data:: currentOp.transaction.parameters.autocommit
331321

332322
A boolean flag that indicates if autocommit is on for the
333323
transaction.
334324

335325
Only present if the operation is part of a multi-document transaction.
336326

337-
.. versionadded:: 4.0.2
338-
339327
.. data:: currentOp.transaction.parameters.readConcern
340328

341329
The :ref:`read concern <transactions-read-concern>` for the
@@ -347,25 +335,19 @@ Output Fields
347335

348336
Only present if the operation is part of a multi-document transaction.
349337

350-
.. versionadded:: 4.0.2
351-
352338
.. data:: currentOp.transaction.readTimestamp
353339

354340
The timestamp of the snapshot being read by the operations in
355341
the transaction.
356342

357343
Only present if the operation is part of a multi-document transaction.
358344

359-
.. versionadded:: 4.0.2
360-
361345
.. data:: currentOp.transaction.startWallClockTime
362346

363347
The date and time (with time zone) of the transaction start.
364348

365349
Only present if the operation is part of a multi-document transaction.
366350

367-
.. versionadded:: 4.0.2
368-
369351
.. data:: currentOp.transaction.timeOpenMicros
370352

371353
The duration of the transaction in microseconds.
@@ -378,8 +360,6 @@ Output Fields
378360

379361
Only present if the operation is part of a multi-document transaction.
380362

381-
.. versionadded:: 4.0.2
382-
383363
.. data:: currentOp.transaction.timeActiveMicros
384364

385365
The total amount of time that the transaction has been active;
@@ -394,8 +374,6 @@ Output Fields
394374

395375
Only present if the operation is part of a multi-document transaction.
396376

397-
.. versionadded:: 4.0.2
398-
399377
.. data:: currentOp.transaction.timeInactiveMicros
400378

401379
The total amount of time that the transaction has been
@@ -424,8 +402,6 @@ Output Fields
424402

425403
Only present if the operation is part of a multi-document transaction.
426404

427-
.. versionadded:: 4.0.2
428-
429405
.. data:: currentOp.twoPhaseCommitCoordinator
430406

431407
Information on either:

‎source/reference/command/dbHash.txt

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -115,8 +115,6 @@ The command returns a document with the following fields:
115115

116116
- An array that lists the capped collections.
117117

118-
.. versionadded:: 4.0
119-
120118
* - ``uuids``
121119

122120
- A document with the collections and their corresponding UUID values.
@@ -129,8 +127,6 @@ The command returns a document with the following fields:
129127
...
130128
}
131129

132-
.. versionadded:: 4.0
133-
134130
* - ``md5``
135131
- The aggregate hash value for these collections.
136132

‎source/reference/command/killOp.txt

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -67,14 +67,13 @@ On systems running with :setting:`~security.authorization`, to kill
6767
operations not owned by the user, the user must have access that
6868
includes the :authaction:`killop` privilege action.
6969

70-
.. versionchanged:: 3.2.9
71-
On :binary:`~bin.mongod` instances, users can kill their own operations
72-
even without the :authaction:`killop` privilege action.
70+
On :binary:`~bin.mongod` instances, users can kill their own operations
71+
even without the :authaction:`killop` privilege action.
7372

7473
Sharded Cluster
7574
---------------
7675

77-
Starting in MongoDB 4.0, the :dbcommand:`killOp` command can be run on
76+
The :dbcommand:`killOp` command can be run on
7877
a :binary:`~bin.mongos` and can kill queries (i.e. read operations)
7978
that span shards in a cluster. The :dbcommand:`killOp` command from the
8079
:binary:`~bin.mongos` does not propagate to the shards when the

0 commit comments

Comments
 (0)