Skip to content

Commit 4b46d1d

Browse files
authored
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
1 parent ae82617 commit 4b46d1d

37 files changed

+131
-150
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
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: 7 additions & 8 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
24+
2125
.. note::
2226

2327
The view modified by this command does not refer to materialized
@@ -98,11 +102,6 @@ Index Options
98102
Modifying the index option ``hidden`` resets the
99103
:pipeline:`$indexStats` for the index if the value changes.
100104

101-
.. seealso::
102-
103-
- :method:`db.collection.hideIndex()`
104-
- :method:`db.collection.unhideIndex()`
105-
106105
.. versionadded:: 4.4
107106

108107
To change index options, specify either the key pattern or name of
@@ -126,7 +125,7 @@ Index Options
126125

127126
.. seealso::
128127

129-
- :doc:`/core/index-hidden`
128+
- :ref:`index-type-hidden`
130129
- :method:`db.collection.hideIndex()`
131130
- :method:`db.collection.unhideIndex()`
132131

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
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
23+
2124
.. note::
2225

2326
MongoDB drivers compatible with the 4.0 features deprecate their
@@ -132,13 +135,6 @@ Definition
132135
.. versionadded:: 4.4
133136

134137

135-
136-
The :binary:`~bin.mongo` shell also provides the following wrapper methods for :dbcommand:`count`:
137-
138-
- :method:`~cursor.count()`
139-
- :method:`db.collection.estimatedDocumentCount()`
140-
- :method:`db.collection.count()`
141-
142138
.. important::
143139

144140
- 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
29+
30+
.. _delete-syntax:
31+
2432
The :dbcommand:`delete` command has the following syntax:
2533

2634
.. code-block:: none
@@ -177,10 +185,6 @@ Definition
177185
For an example, see :ref:`ex-delete-command-hint`.
178186

179187
.. versionadded:: 4.4
180-
181-
182-
183-
184188

185189
:returns:
186190

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
23+
1824
.. code-block:: javascript
1925

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

source/reference/command/mapReduce.txt

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,9 @@ Definition
2222
The :dbcommand:`mapReduce` command allows you to run
2323
:term:`map-reduce` aggregation operations over a collection.
2424

25+
.. |method| replace:: :method:`~db.collection.mapReduce` helper method
26+
.. include:: /includes/fact-dbcommand-tip
27+
2528
Syntax
2629
------
2730

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
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
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
@@ -19,16 +19,16 @@ Definition
1919

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

3333
Syntax
3434
------

0 commit comments

Comments
 (0)