Skip to content

Commit 361c19e

Browse files
kennethdyerksuarz
andauthored
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]>
1 parent 34b5534 commit 361c19e

12 files changed

+65
-211
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: 8 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -301,13 +301,11 @@ Each document in the ``indexes`` array can take the following fields:
301301
along with keys of other types, only the ``2dsphere`` index
302302
fields determine whether the index references a document.
303303

304-
.. versionchanged:: 3.2
305304

306-
Starting in MongoDB 3.2, MongoDB provides the option to create
307-
:ref:`partial indexes <index-type-partial>`. Partial indexes
308-
offer a superset of the functionality of sparse indexes. If you
309-
are using MongoDB 3.2 or later, :ref:`partial indexes
310-
<index-type-partial>` should be preferred over sparse indexes.
305+
MongoDB provides the option to create
306+
:ref:`partial indexes <index-type-partial>`. These
307+
offer a superset of the functionality of sparse indexes
308+
and are preferred instead.
311309

312310
* - ``expireAfterSeconds``
313311

@@ -521,11 +519,9 @@ Each document in the ``indexes`` array can take the following fields:
521519
Considerations
522520
--------------
523521

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

530526
Index Names
531527
~~~~~~~~~~~
@@ -622,9 +618,7 @@ Concurrency
622618
Memory Usage Limit
623619
~~~~~~~~~~~~~~~~~~
624620

625-
.. versionchanged:: 3.4
626-
627-
.. include:: /includes/fact-index-build-default-memory-limit.rst
621+
.. include:: /includes/fact-index-build-default-memory-limit.rst
628622

629623

630624
Index Options

source/reference/command/currentOp.txt

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

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

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

139-
.. versionchanged:: 3.6
140-
141139
.. code-block:: javascript
142140

143141
db.adminCommand(
@@ -190,8 +188,6 @@ database ``db1`` that have been running longer than 3 seconds:
190188
Active Indexing Operations
191189
~~~~~~~~~~~~~~~~~~~~~~~~~~
192190

193-
.. versionchanged:: 3.6
194-
195191
The following example returns information on index creation operations:
196192

197193
.. code-block:: javascript
@@ -322,8 +318,6 @@ Output Fields
322318

323319
Only present if the operation is part of a multi-document transaction.
324320

325-
.. versionadded:: 4.0
326-
327321
.. data:: currentOp.transaction.parameters
328322

329323
A document that contains information on multi-document
@@ -332,25 +326,19 @@ Output Fields
332326
Only present if the operation is part of a multi-document
333327
transaction.
334328

335-
.. versionadded:: 4.0
336-
337329
.. data:: currentOp.transaction.parameters.txnNumber
338330

339331
The transaction number.
340332

341333
Only present if the operation is part of a multi-document transaction.
342334

343-
.. versionadded:: 4.0
344-
345335
.. data:: currentOp.transaction.parameters.autocommit
346336

347337
A boolean flag that indicates if autocommit is on for the
348338
transaction.
349339

350340
Only present if the operation is part of a multi-document transaction.
351341

352-
.. versionadded:: 4.0.2
353-
354342
.. data:: currentOp.transaction.parameters.readConcern
355343

356344
The :ref:`read concern <transactions-read-concern>` for the
@@ -362,25 +350,19 @@ Output Fields
362350

363351
Only present if the operation is part of a multi-document transaction.
364352

365-
.. versionadded:: 4.0.2
366-
367353
.. data:: currentOp.transaction.readTimestamp
368354

369355
The timestamp of the snapshot being read by the operations in
370356
the transaction.
371357

372358
Only present if the operation is part of a multi-document transaction.
373359

374-
.. versionadded:: 4.0.2
375-
376360
.. data:: currentOp.transaction.startWallClockTime
377361

378362
The date and time (with time zone) of the transaction start.
379363

380364
Only present if the operation is part of a multi-document transaction.
381365

382-
.. versionadded:: 4.0.2
383-
384366
.. data:: currentOp.transaction.timeOpenMicros
385367

386368
The duration of the transaction in microseconds.
@@ -393,8 +375,6 @@ Output Fields
393375

394376
Only present if the operation is part of a multi-document transaction.
395377

396-
.. versionadded:: 4.0.2
397-
398378
.. data:: currentOp.transaction.timeActiveMicros
399379

400380
The total amount of time that the transaction has been active;
@@ -409,8 +389,6 @@ Output Fields
409389

410390
Only present if the operation is part of a multi-document transaction.
411391

412-
.. versionadded:: 4.0.2
413-
414392
.. data:: currentOp.transaction.timeInactiveMicros
415393

416394
The total amount of time that the transaction has been
@@ -439,8 +417,6 @@ Output Fields
439417

440418
Only present if the operation is part of a multi-document transaction.
441419

442-
.. versionadded:: 4.0.2
443-
444420
.. data:: currentOp.twoPhaseCommitCoordinator
445421

446422
Information on either:

source/reference/command/dbHash.txt

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

119119
- An array that lists the capped collections.
120120

121-
.. versionadded:: 4.0
122-
123121
* - ``uuids``
124122

125123
- A document with the collections and their corresponding UUID values.
@@ -132,8 +130,6 @@ The command returns a document with the following fields:
132130
...
133131
}
134132

135-
.. versionadded:: 4.0
136-
137133
* - ``md5``
138134
- The aggregate hash value for these collections.
139135

source/reference/command/killOp.txt

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

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

8887
Sharded Cluster
8988
~~~~~~~~~~~~~~~
9089

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

source/reference/command/listCollections.txt

Lines changed: 0 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -76,8 +76,6 @@ The command can take the following optional fields:
7676
filter based on a collection's name and type. No other fields are
7777
available.
7878

79-
.. versionadded:: 4.0
80-
8179
* - ``authorizedCollections``
8280
- boolean
8381
- Optional. A flag, when set to ``true`` and used with ``nameOnly: true``, that
@@ -105,8 +103,6 @@ The command can take the following optional fields:
105103
command when access control is enforced. Otherwise, the user is
106104
unauthorized to run the command.
107105

108-
.. versionadded:: 4.0
109-
110106
* - ``comment``
111107
- any
112108
- .. include:: /includes/extracts/comment-content.rst
@@ -129,8 +125,6 @@ set.
129125
Locks
130126
~~~~~
131127

132-
.. versionchanged:: 4.0
133-
134128
The :dbcommand:`listCollections` command takes Intent Shared lock on the
135129
database. In previous versions, the command takes Shared lock on the
136130
database.
@@ -163,11 +157,6 @@ Required Access
163157

164158
.. include:: /includes/extracts/listCollections-auth-show-collections.rst
165159

166-
Earlier MongoDB Versions
167-
~~~~~~~~~~~~~~~~~~~~~~~~
168-
169-
.. include:: /includes/extracts/listCollections-auth-show-collections-earlier-versions.rst
170-
171160
.. _list-collection-output:
172161

173162
Output

source/reference/command/listDatabases.txt

Lines changed: 5 additions & 57 deletions
Original file line numberDiff line numberDiff line change
@@ -82,8 +82,6 @@ The command can take the following optional fields:
8282

8383
For more information, see :ref:`listDatabases-behavior`.
8484

85-
.. versionadded:: 4.0.5
86-
8785
* - ``comment``
8886
- any
8987
- .. include:: /includes/extracts/comment-content.rst
@@ -95,63 +93,13 @@ The command can take the following optional fields:
9593
Behavior
9694
--------
9795

98-
When :ref:`authentication <authentication>` is enabled:
99-
100-
.. note::
101-
102-
For :binary:`~bin.mongosh` connected to earlier
103-
versions of MongoDB deployment (e.g. 3.6.10),
104-
105-
- If the user has :authaction:`listDatabases` action on the cluster
106-
resource, ``show dbs`` returns all databases.
107-
108-
- If the user does not have :authaction:`listDatabases` action on
109-
the cluster resource, ``show dbs`` returns only the databases for
110-
which the user has privileges (including those databases for which
111-
the user has privileges on specific collections).
112-
113-
.. tabs::
114-
115-
tabs:
116-
117-
- id: mongodb-4.0.6
118-
name: "MongoDB 4.0.6+"
119-
content: |
120-
For MongoDB 4.0.6+, the :dbcommand:`listDatabases` command
121-
returns different values based on the privileges assigned to
122-
the user who executes the command and the
123-
``authorizedDatabases`` command option:
124-
125-
.. include:: /includes/extracts/listDatabases-auth-privileges-4.0.6.rst
126-
127-
- id: mongodb-4.0.5
128-
name: "MongoDB 4.0.5"
129-
content: |
130-
131-
For MongoDB 4.0.5, the :dbcommand:`listDatabases` command
132-
returns different values based on the privileges assigned to
133-
the user who executes the command and the
134-
``authorizedDatabases`` command option:
135-
136-
.. include:: /includes/extracts/listDatabases-auth-privileges-4.0.5.rst
137-
138-
- id: mongodb-4.0.4
139-
name: "MongoDB 4.0.0-4.0.4"
140-
content: |
141-
142-
For MongoDB 4.0.0-4.0.4, the :dbcommand:`listDatabases` command
143-
returns different values based on the privileges assigned to
144-
the user who executes the command.
96+
When :ref:`authentication <authentication>` is enabled,
97+
the :dbcommand:`listDatabases` command returns different values based on
98+
the privileges assigned to the user who executes the command and the
99+
``authorizedDatabases`` command option:
145100

146-
- If the user has the :authaction:`listDatabases` privilege
147-
action on the cluster, the :dbcommand:`listDatabases` command
148-
returns a list of all existing databases.
101+
.. include:: /includes/extracts/listDatabases-auth-privileges-4.0.6.rst
149102

150-
- If the user does not have the :authaction:`listDatabases`
151-
privilege action on the cluster, the
152-
:dbcommand:`listDatabases` command only returns a list of
153-
databases for which the user has the :authaction:`find`
154-
action.
155103

156104
Client Disconnection
157105
~~~~~~~~~~~~~~~~~~~~~

source/reference/command/replSetSyncFrom.txt

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,7 @@ Description
2020
patterns and in situations where a set member is not replicating
2121
from the desired host.
2222

23-
.. versionchanged:: 3.2
24-
25-
.. include:: /includes/fact-voting-node-sync-incompatibility.rst
23+
.. include:: /includes/fact-voting-node-sync-incompatibility.rst
2624

2725
Run :dbcommand:`replSetSyncFrom` in the ``admin`` database.
2826

@@ -57,9 +55,7 @@ The command takes the following field:
5755
- The name and port number of the replica set member that this member
5856
should replicate from. Use the ``[hostname]:[port]`` form.
5957

60-
.. versionchanged:: 3.2
61-
62-
.. include:: /includes/fact-voting-node-sync-incompatibility.rst
58+
.. include:: /includes/fact-voting-node-sync-incompatibility.rst
6359

6460
Behavior
6561
--------

0 commit comments

Comments
 (0)