Skip to content

Commit 33205e7

Browse files
authored
DOCSP-25472 collection interlinks v4.2 backport (#2137)
* DOCSP-25472 collection interlinks v4.4 (#2133) * DOCSP-25472 collection interlinks v5.0 (#2128) * DOCSP 25472 collection interlink ii (#1961) * DOCSP-25472 db.collection.isCapped * DOCSP-25472 db.collection.latencyStats * DOCSP-25472 db.collection.reIndex * DOCSP-25472 collection interlink * DOCSP-25472 collection interlink * DOCSP-25472 collection interlink * DOCSP-25472 collection interlink * DOCSP-25472 delete and update commands * DOCSP-25472 delete and update commands * DOCSP-25472 Adds mongosh interlink * DOCSP-25472 Adds mongosh interlink * DOCSP-25472 Fixes interlink to command * DOCSP-25472 Updates command tip * DOCSP-25472 Updates command tip * DOCSP-25472 Updates command tip * DOCSP-25472 Fixes build error * DOCSP-25472 Self-review fixes * DOCSP-25472 Self-review fixes * DOCSP-25472 Self-review fixes * DOCSP-25472 Fixes per Dave Cuthbert * DOCSP-25472 Fixes per Dave Cuthbert * DOCSP-25472 Fixes per Dave Cuthbert * DOCSP-25472 Fixes per Dave Cuthbert * DOCSP-25472 Fixes per Anna * DOCSP-25472 Fixes per Anna * DOCSP-25472 Fixes build issue * DOCSP-25472 Fixes build * DOCSP-25472 Fixes build * DOCSP-25472 Fixes build * DOCSP-25472 Fixes build
1 parent fa1ee52 commit 33205e7

34 files changed

+120
-132
lines changed

source/reference/command/aggregate.txt

Lines changed: 3 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,9 @@ Definition
2020
to process data from a collection or other source with a sequence of
2121
stage-based manipulations.
2222

23-
.. |method| replace:: :method:`db.aggregate()` and
24-
:method:`db.collection.aggregate()` helper methods
23+
.. |method| replace:: :method:`db.aggregate` and
24+
:method:`db.collection.aggregate` helper methods or with the
25+
:method:`~db.collection.watch` helper method
2526
.. include:: /includes/fact-dbcommand-tip.rst
2627

2728
Syntax
@@ -48,14 +49,6 @@ The command has following syntax:
4849
writeConcern: <document>
4950
}
5051

51-
.. tip::
52-
53-
Rather than run the :dbcommand:`aggregate` command directly, most
54-
users should use the :method:`db.collection.aggregate()` helper
55-
provided in the :binary:`~bin.mongo` shell or the equivalent helper in
56-
their driver. In 2.6 and later, the
57-
:method:`db.collection.aggregate()` helper always returns a cursor.
58-
5952
Command Fields
6053
~~~~~~~~~~~~~~
6154

source/reference/command/collMod.txt

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,12 @@ Definition
1616
.. dbcommand:: collMod
1717

1818
:dbcommand:`collMod` makes it possible to add options to a collection
19-
or to modify view definitions.
20-
19+
or to modify view definitions.
20+
21+
.. |method| replace:: :method:`~db.collection.hideIndex` and
22+
:method:`~db.collection.unhideIndex` helper methods
23+
.. include:: /includes/fact-dbcommand-tip.rst
24+
2125
.. note::
2226

2327
The view modified by this command does not refer to materialized
@@ -84,7 +88,6 @@ TTL Collections
8488
1.0 } for ns **namespace**`` if the specified ``keyPattern``
8589
does not exist.
8690

87-
8891
Document Validation
8992
~~~~~~~~~~~~~~~~~~~
9093

source/reference/command/collStats.txt

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,18 @@ Definition
1818
The :dbcommand:`collStats` command returns a variety of storage statistics
1919
for a given collection.
2020

21+
.. |method| replace:: :method:`~db.collection.stats` helper method.
22+
Specific fields in the ``collStats`` output can be accessed using the
23+
:method:`~db.collection.dataSize`,
24+
:method:`~db.collection.estimatedDocumentCount`,
25+
:method:`~db.collection.isCapped`,
26+
:method:`~db.collection.latencyStats`,
27+
:method:`~db.collection.storageSize`,
28+
:method:`~db.collection.totalIndexSize`, and
29+
:method:`~db.collection.totalSize`
30+
helper methods
31+
.. include:: /includes/fact-dbcommand-tip.rst
32+
2133
.. |command| replace:: ``collStats``
2234

2335
.. include:: /includes/fact-dbcommand.rst

source/reference/command/count.txt

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,9 @@ Definition
1818
Counts the number of documents in a collection or a view. Returns a
1919
document that contains this count and as well as the command status.
2020

21+
.. |method| replace:: :method:`~db.collection.count` helper method
22+
.. include:: /includes/fact-dbcommand-tip.rst
23+
2124
.. note::
2225

2326
MongoDB drivers compatible with the 4.0 features deprecate their
@@ -124,13 +127,6 @@ Definition
124127

125128

126129

127-
128-
The :binary:`~bin.mongo` shell also provides the following wrapper methods for :dbcommand:`count`:
129-
130-
- :method:`~cursor.count()`
131-
- :method:`db.collection.estimatedDocumentCount()`
132-
- :method:`db.collection.count()`
133-
134130
.. important::
135131

136132
- Avoid using the :dbcommand:`count` and its wrapper methods

source/reference/command/delete.txt

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,14 @@ Definition
2121
collections </core/capped-collections>`. The remove methods provided
2222
by the MongoDB drivers use this command internally.
2323

24+
.. |method| replace:: :method:`~db.collection.deleteOne`,
25+
:method:`~db.collection.deleteMany`, and
26+
:method:`~db.collection.findOneAndDelete`
27+
helper methods
28+
.. include:: /includes/fact-dbcommand-tip.rst
29+
30+
.. _delete-syntax:
31+
2432
The :dbcommand:`delete` command has the following syntax:
2533

2634
.. code-block:: javascript
@@ -136,10 +144,6 @@ Definition
136144
- Optional.
137145

138146
.. include:: /includes/extracts/collation-option.rst
139-
140-
141-
142-
143147

144148
:return:
145149

source/reference/command/drop.txt

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,17 @@ drop
1010
:depth: 1
1111
:class: singlecol
1212

13+
Syntax
14+
------
15+
1316
.. dbcommand:: drop
1417

1518
The :dbcommand:`drop` command removes an entire collection from a
1619
database. The command has following syntax:
1720

21+
.. |method| replace:: :method:`~db.collection.drop` helper method
22+
.. include:: /includes/fact-dbcommand-tip.rst
23+
1824
.. code-block:: javascript
1925

2026
{ drop: <collection_name>, writeConcern: <document>}

source/reference/command/reIndex.txt

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,9 @@ reIndex
1212

1313
.. dbcommand:: reIndex
1414

15+
.. |method| replace:: :method:`db.collection.reIndex` helper method
16+
.. include:: /includes/fact-dbcommand-tip.rst
17+
1518
The :dbcommand:`reIndex` command drops all indexes on a
1619
collection and recreates them. This operation may be expensive for
1720
collections that have a large amount of data and/or a large number
@@ -44,15 +47,13 @@ reIndex
4447
.. list-table::
4548
:header-rows: 1
4649
:widths: 20 80
47-
50+
4851
* - Field
4952
- Description
50-
53+
5154
* - reIndex
5255
- The name of the collection to reindex.
53-
54-
The :binary:`~bin.mongo` shell provides a wrapper :method:`db.collection.reIndex()`.
55-
56+
5657
Behavior
5758
--------
5859

source/reference/command/renameCollection.txt

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,9 @@ Definition
1919
to :dbcommand:`renameCollection` in the form of a complete
2020
:term:`namespace` (``<database>.<collection>``).
2121

22+
.. |method| replace:: :method:`~db.collection.renameCollection` helper method
23+
.. include:: /includes/fact-dbcommand-tip.rst
24+
2225
Issue the :dbcommand:`renameCollection` command against the
2326
:term:`admin database`.
2427

source/reference/command/update.txt

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -20,16 +20,16 @@ Definition
2020

2121
The :dbcommand:`update` command modifies documents in a collection.
2222
A single :dbcommand:`update` command can contain multiple update
23-
statements. The update methods provided by the MongoDB drivers use
24-
this command internally.
25-
26-
The :binary:`~bin.mongo` shell provides the following helper methods:
27-
28-
- :method:`db.collection.updateOne()`
29-
30-
- :method:`db.collection.updateMany()`
31-
32-
- :method:`db.collection.update()`
23+
statements.
24+
25+
.. |method| replace:: :method:`~db.collection.updateOne`,
26+
:method:`~db.collection.updateMany`,
27+
:method:`~db.collection.update`,
28+
:method:`~db.collection.replaceOne`,
29+
:method:`~db.collection.findOneAndReplace`, and
30+
:method:`~db.collection.findOneAndUpdate`
31+
helper methods
32+
.. include:: /includes/fact-dbcommand-tip.rst
3333

3434
Syntax
3535
------

source/reference/command/validate.txt

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,9 @@ Definition
1818
The :dbcommand:`validate` command checks a collection's data and
1919
indexes for correctness and returns the results.
2020

21+
.. |method| replace:: :method:`~db.collection.validate` helper method
22+
.. include:: /includes/fact-dbcommand-tip.rst
23+
2124
.. note::
2225

2326
The :dbcommand:`validate` command does not support :doc:`views

source/reference/method/db.collection.count.txt

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,8 @@ Definition
1515

1616
.. method:: db.collection.count(query, options)
1717

18-
19-
.. include:: /includes/fact-mongo-shell-method.rst
20-
18+
.. |dbcommand| replace:: :dbcommand:`count` command
19+
.. include:: /includes/fact-mongo-shell-method-alt.rst
2120

2221
.. note::
2322

source/reference/method/db.collection.countDocuments.txt

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,15 +15,15 @@ Definition
1515

1616
.. method:: db.collection.countDocuments(query, options)
1717

18-
19-
.. include:: /includes/fact-mongo-shell-method.rst
20-
18+
.. |dbcommand| replace:: :pipeline:`$group` aggregation stage and
19+
the :group:`$sum` expression called by the :dbcommand:`aggregate`
20+
command
21+
.. include:: /includes/fact-mongo-shell-method-alt.rst
2122

2223
.. versionadded:: 4.0.3
2324

2425
Returns the count of documents that match the query for a collection
25-
or view. The method wraps the :pipeline:`$group` aggregation stage
26-
with a :group:`$sum` expression to perform the count and is
26+
or view. This method is
2727
available for use in :doc:`/core/transactions`.
2828

2929
.. code-block:: javascript

source/reference/method/db.collection.dataSize.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,9 @@ db.collection.dataSize()
1212

1313
.. method:: db.collection.dataSize()
1414

15-
16-
.. include:: /includes/fact-mongo-shell-method.rst
17-
15+
.. |dbcommand| replace:: :data:`~collStats.size` field returned by the
16+
:dbcommand:`collStats` command
17+
.. include:: /includes/fact-mongo-shell-method-alt.rst
1818

1919
:returns: The size in bytes of the collection.
2020

source/reference/method/db.collection.deleteMany.txt

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,8 @@ Definition
1515

1616
.. method:: db.collection.deleteMany()
1717

18-
19-
.. include:: /includes/fact-mongo-shell-method.rst
20-
18+
.. |dbcommand| replace:: :dbcommand:`delete` command
19+
.. include:: /includes/fact-mongo-shell-method-alt.rst
2120

2221
Removes all documents that match the ``filter`` from a collection.
2322

source/reference/method/db.collection.deleteOne.txt

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,8 @@ Definition
1515

1616
.. method:: db.collection.deleteOne()
1717

18-
19-
.. include:: /includes/fact-mongo-shell-method.rst
20-
18+
.. |dbcommand| replace:: :dbcommand:`delete` command
19+
.. include:: /includes/fact-mongo-shell-method-alt.rst
2120

2221
Removes a single document from a collection.
2322

source/reference/method/db.collection.drop.txt

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,8 @@ Definition
1717

1818
.. method:: db.collection.drop(<options>)
1919

20-
21-
.. include:: /includes/fact-mongo-shell-method.rst
22-
20+
.. |dbcommand| replace:: :dbcommand:`drop` command
21+
.. include:: /includes/fact-mongo-shell-method-alt.rst
2322

2423
Removes a collection or :doc:`view </core/views>` from the database.
2524
The method also removes any indexes associated with the dropped

source/reference/method/db.collection.estimatedDocumentCount.txt

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,14 +15,13 @@ Definition
1515

1616
.. method:: db.collection.estimatedDocumentCount(options)
1717

18-
19-
.. include:: /includes/fact-mongo-shell-method.rst
20-
18+
.. |dbcommand| replace:: :data:`~collStats.count` field returned by the
19+
:dbcommand:`collStats` command
20+
.. include:: /includes/fact-mongo-shell-method-alt.rst
2121

2222
.. versionadded:: 4.0.3
2323

24-
Returns the count of all documents in a collection or view. The
25-
method wraps the :dbcommand:`count` command.
24+
Returns the count of all documents in a collection or view.
2625

2726
.. code-block:: javascript
2827

source/reference/method/db.collection.findOneAndDelete.txt

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,11 +15,8 @@ Definition
1515

1616
.. method:: db.collection.findOneAndDelete( filter, options )
1717

18-
19-
.. include:: /includes/fact-mongo-shell-method.rst
20-
21-
22-
.. versionadded:: 3.2
18+
.. |dbcommand| replace:: :dbcommand:`delete` command
19+
.. include:: /includes/fact-mongo-shell-method-alt.rst
2320

2421
Deletes a single document based on the ``filter`` and
2522
``sort`` criteria, returning the deleted document.

source/reference/method/db.collection.findOneAndReplace.txt

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,11 +15,8 @@ Definition
1515

1616
.. method:: db.collection.findOneAndReplace( filter, replacement, options )
1717

18-
19-
.. include:: /includes/fact-mongo-shell-method.rst
20-
21-
22-
.. versionadded:: 3.2
18+
.. |dbcommand| replace:: :dbcommand:`update` command
19+
.. include:: /includes/fact-mongo-shell-method-alt.rst
2320

2421
Replaces a single document based on the specified :ref:`filter
2522
<findOneAndReplace-filter>`.

source/reference/method/db.collection.findOneAndUpdate.txt

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -18,11 +18,8 @@ Definition
1818

1919
.. method:: db.collection.findOneAndUpdate( filter, update, options )
2020

21-
22-
.. include:: /includes/fact-mongo-shell-method.rst
23-
24-
25-
.. versionadded:: 3.2
21+
.. |dbcommand| replace:: :dbcommand:`update` command
22+
.. include:: /includes/fact-mongo-shell-method-alt.rst
2623

2724
Updates a single document based on the ``filter`` and
2825
``sort`` criteria.

source/reference/method/db.collection.isCapped.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,9 @@ db.collection.isCapped()
1212

1313
.. method:: db.collection.isCapped()
1414

15-
16-
.. include:: /includes/fact-mongo-shell-method.rst
17-
15+
.. |dbcommand| replace:: :data:`~collStats.capped` field returned by the
16+
:dbcommand:`collStats` command
17+
.. include:: /includes/fact-mongo-shell-method-alt.rst
1818

1919
:returns: Returns ``true`` if the collection is a :term:`capped
2020
collection`, otherwise returns ``false``.

source/reference/method/db.collection.latencyStats.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,9 @@ Definition
1515

1616
.. method:: db.collection.latencyStats(options)
1717

18-
19-
.. include:: /includes/fact-mongo-shell-method.rst
20-
18+
.. |dbcommand| replace:: ``latencyStats`` field returned by the
19+
:dbcommand:`collStats` command
20+
.. include:: /includes/fact-mongo-shell-method-alt.rst
2121

2222
:method:`db.collection.latencyStats()` returns latency
2323
statistics for a given collection. It is a wrapper around

source/reference/method/db.collection.mapReduce.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,8 @@ db.collection.mapReduce()
1313
.. method:: db.collection.mapReduce(map,reduce, {<out>,<query>,<sort>,<limit>,<finalize>,<scope>,<jsMode>,<verbose>})
1414

1515

16-
.. include:: /includes/fact-mongo-shell-method.rst
17-
16+
.. |dbcommand| replace:: :dbcommand:`mapReduce` command
17+
.. include:: /includes/fact-mongo-shell-method-alt.rst
1818

1919
.. note::
2020

0 commit comments

Comments
 (0)