Skip to content

Commit 3790d5c

Browse files
kennethdyerksuarz
andauthored
DOCSP-27277 - EOL Reference Cleanup for Database Commands (#2327) (#2… (#2517)
* 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 <ksuarz@gmail.com> --------- Co-authored-by: Kyle Suarez <ksuarz@gmail.com> * Reverts text to fix build errors * Fixes indentation from cherry-pick --------- Co-authored-by: Kyle Suarez <ksuarz@gmail.com> * Fixes format issue --------- Co-authored-by: Kyle Suarez <ksuarz@gmail.com>
1 parent cd0a648 commit 3790d5c

12 files changed

+192
-423
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: 42 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -132,25 +132,25 @@ Definition
132132
- .. include:: /includes/extracts/comment-content.rst
133133

134134
.. versionadded:: 4.4
135-
135+
136136
.. _createIndexes-options:
137137

138138
Each document in the ``indexes`` array can take the following fields:
139-
139+
140140
.. list-table::
141141
:header-rows: 1
142142
:widths: 20 20 80
143-
143+
144144
* - Field
145-
145+
146146
- Type
147-
147+
148148
- Description
149-
149+
150150
* - ``key``
151-
151+
152152
- document
153-
153+
154154
-
155155
Specifies the index's fields. For each field, specify a key-value pair
156156
in which the key is the name of the field to index and the value is
@@ -163,7 +163,7 @@ Definition
163163
MongoDB supports several different index types including
164164
:ref:`text <index-feature-text>`, :ref:`geospatial
165165
<index-feature-geospatial>`, and :ref:`hashed
166-
<index-type-hashed>` indexes. See :ref:`index types <index-types>`
166+
indexes <index-type-hashed>`. See :ref:`index types <index-types>`
167167
for more information.
168168

169169
.. versionchanged:: 4.2
@@ -211,29 +211,29 @@ Definition
211211

212212

213213

214-
214+
215215
* - ``name``
216-
216+
217217
- string
218-
218+
219219
- A name that uniquely identifies the index.
220220

221221

222-
222+
223223
* - ``background``
224-
224+
225225
- boolean
226-
226+
227227
- Optional. *Deprecated in MongoDB 4.2.*
228228

229229
.. include:: /includes/extracts/4.2-index-background.rst
230230

231231

232-
232+
233233
* - ``unique``
234-
234+
235235
- boolean
236-
236+
237237
- Optional. Creates a unique index so that the collection will not accept
238238
insertion or update of documents where the index key value matches an existing
239239
value in the index.
@@ -242,16 +242,16 @@ Definition
242242
Specify ``true`` to create a unique index. The
243243
default value is ``false``.
244244

245-
The option is *unavailable* for :doc:`hashed </core/index-hashed>`
245+
The option is *unavailable* for :ref:`hashed <index-hashed-index>`
246246
indexes.
247247

248248

249249

250-
250+
251251
* - ``partialFilterExpression``
252-
252+
253253
- document
254-
254+
255255
- Optional. If specified, the index only references documents that match the
256256
filter expression. See :doc:`/core/index-partial` for more information.
257257

@@ -263,49 +263,45 @@ Definition
263263
You can specify a ``partialFilterExpression`` option for all MongoDB
264264
:ref:`index types <index-types>`.
265265

266-
.. versionadded:: 3.2
267266

268267

269-
270-
268+
271269
* - ``sparse``
272-
270+
273271
- boolean
274-
272+
275273
- Optional. If ``true``, the index only references documents with the specified
276274
field. These indexes use less space but behave differently in some
277275
situations (particularly sorts). The default value is ``false``.
278276
See :doc:`/core/index-sparse` for more information.
279-
277+
280278
The following index types are sparse by default and ignore
281279
this option:
282-
280+
283281
- :doc:`2dsphere </core/2dsphere>`
284282
- :doc:`2d </core/2d>`
285283
- :doc:`geoHaystack </core/geohaystack>`
286-
- :doc:`text </core/index-text>`
287-
284+
- :ref:`text <index-feature-text>`
285+
288286
For a compound index that includes ``2dsphere`` index key(s)
289287
along with keys of other types, only the ``2dsphere`` index
290288
fields determine whether the index references a document.
291-
292-
.. versionchanged:: 3.2
293-
294-
Starting in MongoDB 3.2, MongoDB provides the option to create
295-
:ref:`partial indexes <index-type-partial>`. Partial indexes
296-
offer a superset of the functionality of sparse indexes. If you
297-
are using MongoDB 3.2 or later, :ref:`partial indexes
298-
<index-type-partial>` should be preferred over sparse indexes.
299-
289+
290+
291+
MongoDB provides the option to create
292+
:ref:`partial indexes <index-type-partial>`. These
293+
offer a superset of the functionality of sparse indexes
294+
and are preferred instead.
295+
300296
* - ``expireAfterSeconds``
301-
297+
302298
- integer
303299

304300
- Optional. Specifies a value, in seconds, as a :term:`TTL` to control how long
305301
MongoDB retains documents in this collection. See
306302
:doc:`/tutorial/expire-data` for more information on this
307303
functionality. This applies only to :term:`TTL` indexes.
308-
304+
309305
* - :ref:`hidden <cmd-createIndexes-hidden>`
310306

311307
- boolean
@@ -512,11 +508,9 @@ Definition
512508
Considerations
513509
--------------
514510

515-
.. versionchanged:: 3.2
516-
517-
MongoDB disallows the creation of :ref:`version 0
518-
<3.2-version-0-indexes>` indexes. To upgrade existing version 0
519-
indexes, see :ref:`3.2-version-0-indexes`.
511+
MongoDB disallows the creation of :ref:`version 0
512+
<3.2-version-0-indexes>` indexes. To upgrade existing version 0
513+
indexes, see :ref:`3.2-version-0-indexes`.
520514

521515
Index Names
522516
~~~~~~~~~~~
@@ -598,9 +592,7 @@ Concurrency
598592
Memory Usage Limit
599593
~~~~~~~~~~~~~~~~~~
600594

601-
.. versionchanged:: 3.4
602-
603-
.. include:: /includes/fact-index-build-default-memory-limit.rst
595+
.. include:: /includes/fact-index-build-default-memory-limit.rst
604596

605597

606598
Index Options

source/reference/command/currentOp.txt

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

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

@@ -134,8 +134,6 @@ Write Operations Waiting for a Lock
134134
The following example returns information on all write operations that
135135
are waiting for a lock:
136136

137-
.. versionchanged:: 3.6
138-
139137
.. code-block:: javascript
140138

141139
db.adminCommand(
@@ -188,8 +186,6 @@ database ``db1`` that have been running longer than 3 seconds:
188186
Active Indexing Operations
189187
~~~~~~~~~~~~~~~~~~~~~~~~~~
190188

191-
.. versionchanged:: 3.6
192-
193189
The following example returns information on index creation operations:
194190

195191
.. code-block:: javascript
@@ -317,8 +313,6 @@ Output Fields
317313

318314
Only present if the operation is part of a multi-document transaction.
319315

320-
.. versionadded:: 4.0
321-
322316
.. data:: currentOp.transaction.parameters
323317

324318
A document that contains information on multi-document
@@ -327,25 +321,19 @@ Output Fields
327321
Only present if the operation is part of a multi-document
328322
transaction.
329323

330-
.. versionadded:: 4.0
331-
332324
.. data:: currentOp.transaction.parameters.txnNumber
333325

334326
The transaction number.
335327

336328
Only present if the operation is part of a multi-document transaction.
337329

338-
.. versionadded:: 4.0
339-
340330
.. data:: currentOp.transaction.parameters.autocommit
341331

342332
A boolean flag that indicates if autocommit is on for the
343333
transaction.
344334

345335
Only present if the operation is part of a multi-document transaction.
346336

347-
.. versionadded:: 4.0.2
348-
349337
.. data:: currentOp.transaction.parameters.readConcern
350338

351339
The :ref:`read concern <transactions-read-concern>` for the
@@ -357,25 +345,19 @@ Output Fields
357345

358346
Only present if the operation is part of a multi-document transaction.
359347

360-
.. versionadded:: 4.0.2
361-
362348
.. data:: currentOp.transaction.readTimestamp
363349

364350
The timestamp of the snapshot being read by the operations in
365351
the transaction.
366352

367353
Only present if the operation is part of a multi-document transaction.
368354

369-
.. versionadded:: 4.0.2
370-
371355
.. data:: currentOp.transaction.startWallClockTime
372356

373357
The date and time (with time zone) of the transaction start.
374358

375359
Only present if the operation is part of a multi-document transaction.
376360

377-
.. versionadded:: 4.0.2
378-
379361
.. data:: currentOp.transaction.timeOpenMicros
380362

381363
The duration of the transaction in microseconds.
@@ -388,8 +370,6 @@ Output Fields
388370

389371
Only present if the operation is part of a multi-document transaction.
390372

391-
.. versionadded:: 4.0.2
392-
393373
.. data:: currentOp.transaction.timeActiveMicros
394374

395375
The total amount of time that the transaction has been active;
@@ -404,8 +384,6 @@ Output Fields
404384

405385
Only present if the operation is part of a multi-document transaction.
406386

407-
.. versionadded:: 4.0.2
408-
409387
.. data:: currentOp.transaction.timeInactiveMicros
410388

411389
The total amount of time that the transaction has been
@@ -434,8 +412,6 @@ Output Fields
434412

435413
Only present if the operation is part of a multi-document transaction.
436414

437-
.. versionadded:: 4.0.2
438-
439415
.. data:: currentOp.twoPhaseCommitCoordinator
440416

441417
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)