Skip to content

Commit 22b3fbe

Browse files
kennethdyerksuarz
andauthored
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]>
1 parent 746f2ef commit 22b3fbe

12 files changed

+193
-422
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
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: 43 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -141,25 +141,25 @@ Definition
141141
- .. include:: /includes/extracts/comment-content.rst
142142

143143
.. versionadded:: 4.4
144-
144+
145145
.. _createIndexes-options:
146146

147147
Each document in the ``indexes`` array can take the following fields:
148-
148+
149149
.. list-table::
150150
:header-rows: 1
151151
:widths: 20 20 80
152-
152+
153153
* - Field
154-
154+
155155
- Type
156-
156+
157157
- Description
158-
158+
159159
* - ``key``
160-
160+
161161
- document
162-
162+
163163
-
164164
Specifies the index's fields. For each field, specify a key-value pair
165165
in which the key is the name of the field to index and the value is
@@ -172,7 +172,7 @@ Definition
172172
MongoDB supports several different index types including
173173
:ref:`text <index-feature-text>`, :ref:`geospatial
174174
<index-feature-geospatial>`, and :ref:`hashed
175-
<index-type-hashed>` indexes. See :ref:`index types <index-types>`
175+
indexes <index-type-hashed>`. See :ref:`index types <index-types>`
176176
for more information.
177177

178178
.. versionchanged:: 4.2
@@ -220,29 +220,29 @@ Definition
220220

221221

222222

223-
223+
224224
* - ``name``
225-
225+
226226
- string
227-
227+
228228
- A name that uniquely identifies the index.
229229

230230

231-
231+
232232
* - ``background``
233-
233+
234234
- boolean
235-
235+
236236
- Optional. *Deprecated in MongoDB 4.2.*
237237

238238
.. include:: /includes/extracts/4.2-index-background.rst
239239

240240

241-
241+
242242
* - ``unique``
243-
243+
244244
- boolean
245-
245+
246246
- Optional. Creates a unique index so that the collection will not accept
247247
insertion or update of documents where the index key value matches an existing
248248
value in the index.
@@ -251,16 +251,16 @@ Definition
251251
Specify ``true`` to create a unique index. The
252252
default value is ``false``.
253253

254-
The option is *unavailable* for :doc:`hashed </core/index-hashed>`
254+
The option is *unavailable* for :ref:`hashed <index-hashed-index>`
255255
indexes.
256256

257257

258258

259-
259+
260260
* - ``partialFilterExpression``
261-
261+
262262
- document
263-
263+
264264
- Optional. If specified, the index only references documents that match the
265265
filter expression. See :doc:`/core/index-partial` for more information.
266266

@@ -272,46 +272,42 @@ Definition
272272
You can specify a ``partialFilterExpression`` option for all MongoDB
273273
:ref:`index types <index-types>`.
274274

275-
.. versionadded:: 3.2
276-
277275

278276

279-
277+
280278
* - ``sparse``
281-
279+
282280
- boolean
283-
281+
284282
- Optional. If ``true``, the index only references documents with the specified
285283
field. These indexes use less space but behave differently in some
286284
situations (particularly sorts). The default value is ``false``.
287285
See :doc:`/core/index-sparse` for more information.
288-
286+
289287
The following index types are sparse by default and ignore
290288
this option:
291-
289+
292290
- :doc:`2dsphere </core/2dsphere>`
293291
- :doc:`2d </core/2d>`
294292
- :doc:`geoHaystack </core/geohaystack>`
295-
- :doc:`text </core/index-text>`
296-
293+
- :ref:`text <index-feature-text>`
294+
297295
For a compound index that includes ``2dsphere`` index key(s)
298296
along with keys of other types, only the ``2dsphere`` index
299297
fields determine whether the index references a document.
300-
301-
.. versionchanged:: 3.2
302-
303-
Starting in MongoDB 3.2, MongoDB provides the option to create
304-
:ref:`partial indexes <index-type-partial>`. Partial indexes
305-
offer a superset of the functionality of sparse indexes. If you
306-
are using MongoDB 3.2 or later, :ref:`partial indexes
307-
<index-type-partial>` should be preferred over sparse indexes.
308-
298+
299+
300+
MongoDB provides the option to create
301+
:ref:`partial indexes <index-type-partial>`. These
302+
offer a superset of the functionality of sparse indexes
303+
and are preferred instead.
304+
309305
* - ``expireAfterSeconds``
310-
306+
311307
- integer
312-
308+
313309
- .. include:: /includes/indexes/expireAfterSeconds-config-option.rst
314-
310+
315311
.. include:: /includes/indexes/expireAfterSeconds-warning.rst
316312

317313
* - :ref:`hidden <cmd-createIndexes-hidden>`
@@ -520,11 +516,9 @@ Definition
520516
Considerations
521517
--------------
522518

523-
.. versionchanged:: 3.2
524-
525-
MongoDB disallows the creation of :ref:`version 0
526-
<3.2-version-0-indexes>` indexes. To upgrade existing version 0
527-
indexes, see :ref:`3.2-version-0-indexes`.
519+
MongoDB disallows the creation of :ref:`version 0
520+
<3.2-version-0-indexes>` indexes. To upgrade existing version 0
521+
indexes, see :ref:`3.2-version-0-indexes`.
528522

529523
Index Names
530524
~~~~~~~~~~~
@@ -621,9 +615,7 @@ Concurrency
621615
Memory Usage Limit
622616
~~~~~~~~~~~~~~~~~~
623617

624-
.. versionchanged:: 3.4
625-
626-
.. include:: /includes/fact-index-build-default-memory-limit.rst
618+
.. include:: /includes/fact-index-build-default-memory-limit.rst
627619

628620

629621
Index Options

source/reference/command/currentOp.txt

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

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

@@ -131,8 +131,6 @@ Write Operations Waiting for a Lock
131131
The following example returns information on all write operations that
132132
are waiting for a lock:
133133

134-
.. versionchanged:: 3.6
135-
136134
.. code-block:: javascript
137135

138136
db.adminCommand(
@@ -185,8 +183,6 @@ database ``db1`` that have been running longer than 3 seconds:
185183
Active Indexing Operations
186184
~~~~~~~~~~~~~~~~~~~~~~~~~~
187185

188-
.. versionchanged:: 3.6
189-
190186
The following example returns information on index creation operations:
191187

192188
.. code-block:: javascript
@@ -314,8 +310,6 @@ Output Fields
314310

315311
Only present if the operation is part of a multi-document transaction.
316312

317-
.. versionadded:: 4.0
318-
319313
.. data:: currentOp.transaction.parameters
320314

321315
A document that contains information on multi-document
@@ -324,25 +318,19 @@ Output Fields
324318
Only present if the operation is part of a multi-document
325319
transaction.
326320

327-
.. versionadded:: 4.0
328-
329321
.. data:: currentOp.transaction.parameters.txnNumber
330322

331323
The transaction number.
332324

333325
Only present if the operation is part of a multi-document transaction.
334326

335-
.. versionadded:: 4.0
336-
337327
.. data:: currentOp.transaction.parameters.autocommit
338328

339329
A boolean flag that indicates if autocommit is on for the
340330
transaction.
341331

342332
Only present if the operation is part of a multi-document transaction.
343333

344-
.. versionadded:: 4.0.2
345-
346334
.. data:: currentOp.transaction.parameters.readConcern
347335

348336
The :ref:`read concern <transactions-read-concern>` for the
@@ -354,25 +342,19 @@ Output Fields
354342

355343
Only present if the operation is part of a multi-document transaction.
356344

357-
.. versionadded:: 4.0.2
358-
359345
.. data:: currentOp.transaction.readTimestamp
360346

361347
The timestamp of the snapshot being read by the operations in
362348
the transaction.
363349

364350
Only present if the operation is part of a multi-document transaction.
365351

366-
.. versionadded:: 4.0.2
367-
368352
.. data:: currentOp.transaction.startWallClockTime
369353

370354
The date and time (with time zone) of the transaction start.
371355

372356
Only present if the operation is part of a multi-document transaction.
373357

374-
.. versionadded:: 4.0.2
375-
376358
.. data:: currentOp.transaction.timeOpenMicros
377359

378360
The duration of the transaction in microseconds.
@@ -385,8 +367,6 @@ Output Fields
385367

386368
Only present if the operation is part of a multi-document transaction.
387369

388-
.. versionadded:: 4.0.2
389-
390370
.. data:: currentOp.transaction.timeActiveMicros
391371

392372
The total amount of time that the transaction has been active;
@@ -401,8 +381,6 @@ Output Fields
401381

402382
Only present if the operation is part of a multi-document transaction.
403383

404-
.. versionadded:: 4.0.2
405-
406384
.. data:: currentOp.transaction.timeInactiveMicros
407385

408386
The total amount of time that the transaction has been
@@ -431,8 +409,6 @@ Output Fields
431409

432410
Only present if the operation is part of a multi-document transaction.
433411

434-
.. versionadded:: 4.0.2
435-
436412
.. data:: currentOp.twoPhaseCommitCoordinator
437413

438414
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
@@ -79,14 +79,13 @@ On systems running with :setting:`~security.authorization`, to kill
7979
operations not owned by the user, the user must have access that
8080
includes the :authaction:`killop` privilege action.
8181

82-
.. versionchanged:: 3.2.9
83-
On :binary:`~bin.mongod` instances, users can kill their own operations
84-
even without the :authaction:`killop` privilege action.
82+
On :binary:`~bin.mongod` instances, users can kill their own operations
83+
even without the :authaction:`killop` privilege action.
8584

8685
Sharded Cluster
8786
~~~~~~~~~~~~~~~
8887

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

0 commit comments

Comments
 (0)