DOCSP 25472 collection interlink ii (#1961) (#2127)

* 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

Author: kennethdyer

source/includes/fact-mongosh-shell-method-alt.rst

@@ -2,7 +2,9 @@
 
    This page documents a :binary:`~bin.mongosh` method. This is *not*
    the documentation for database commands or language-specific drivers,
-   such as Node.js. To use the database command, see the |dbcommand|.
+   such as Node.js. 
+   
+   For the database command, see the |dbcommand|.
 
    For MongoDB API drivers, refer to the language-specific
    :driver:`MongoDB driver documentation </>`.

source/reference/command/aggregate.txt

@@ -20,8 +20,9 @@ Definition
    to process data from a collection or other source with a sequence of 
    stage-based manipulations.
 
-   .. |method| replace:: :method:`db.aggregate()` and 
-      :method:`db.collection.aggregate()` helper methods
+   .. |method| replace:: :method:`db.aggregate` and 
+      :method:`db.collection.aggregate` helper methods or with the
+      :method:`~db.collection.watch` helper method
    .. include:: /includes/fact-dbcommand-tip
 
 Syntax
@@ -51,13 +52,6 @@ The command has the following syntax:
       }
    )
 
-.. tip::
-
-   Rather than run the :dbcommand:`aggregate` command directly, most
-   users should use the :method:`db.collection.aggregate()` helper
-   provided in :binary:`~bin.mongosh` or the equivalent helper in
-   their driver.
-
 Command Fields
 ~~~~~~~~~~~~~~
 

source/reference/command/collMod.txt

@@ -18,6 +18,10 @@ Definition
    :dbcommand:`collMod` makes it possible to add options to a collection
    or to modify view definitions.
 
+   .. |method| replace:: :method:`~db.collection.hideIndex` and
+      :method:`~db.collection.unhideIndex` helper methods
+   .. include:: /includes/fact-dbcommand-tip
+
    .. note::
 
       The view modified by this command does not refer to materialized
@@ -103,11 +107,6 @@ Index Options
           Modifying the index option ``hidden`` resets the
           :pipeline:`$indexStats` for the index if the value changes.
 
-          .. seealso::
-
-             - :method:`db.collection.hideIndex()`
-             - :method:`db.collection.unhideIndex()`
-
           .. versionadded:: 4.4
 
       * - ``prepareUnique``
@@ -165,8 +164,6 @@ Index Options
    .. seealso::
 
       - :ref:`index-type-hidden`
-      - :method:`db.collection.hideIndex()`
-      - :method:`db.collection.unhideIndex()`
 
 Document Validation
 ~~~~~~~~~~~~~~~~~~~

source/reference/command/collStats.txt

@@ -18,6 +18,18 @@ Definition
    The :dbcommand:`collStats` command returns a variety of storage statistics
    for a given collection.
 
+   .. |method| replace:: :method:`~db.collection.stats` helper method.  
+      Specific fields in the ``collStats`` output can be accessed using the
+      :method:`~db.collection.dataSize`,
+      :method:`~db.collection.estimatedDocumentCount`,
+      :method:`~db.collection.isCapped`,
+      :method:`~db.collection.latencyStats`,
+      :method:`~db.collection.storageSize`,
+      :method:`~db.collection.totalIndexSize`, and
+      :method:`~db.collection.totalSize`
+      helper methods
+   .. include:: /includes/fact-dbcommand-tip
+
    .. |command| replace:: ``collStats``
 
    .. include:: /includes/fact-dbcommand.rst

source/reference/command/count.txt

@@ -18,6 +18,9 @@ Definition
    Counts the number of documents in a collection or a view. Returns a
    document that contains this count and as well as the command status.
 
+   .. |method| replace:: :method:`~db.collection.count`  helper method
+   .. include:: /includes/fact-dbcommand-tip
+
    .. note::
 
       MongoDB drivers compatible with the 4.0 features deprecate their
@@ -139,13 +142,6 @@ Command Fields
        .. versionadded:: 4.4
 
 
-
-:binary:`~bin.mongosh` also provides the following wrapper methods for :dbcommand:`count`:
-
-- :method:`~cursor.count()`
-- :method:`db.collection.estimatedDocumentCount()`
-- :method:`db.collection.count()`
-
 Stable API Support
 ------------------
 

source/reference/command/delete.txt

@@ -23,6 +23,12 @@ Definition
 
    .. versionchanged:: 5.0
 
+   .. |method| replace:: :method:`~db.collection.deleteOne`,
+      :method:`~db.collection.deleteMany`, and
+      :method:`~db.collection.findOneAndDelete`
+      helper methods
+   .. include:: /includes/fact-dbcommand-tip
+
    :returns:
 
       A document that contains the status of the operation.

source/reference/command/drop.txt

@@ -18,6 +18,9 @@ Definition
    The :dbcommand:`drop` command removes an entire collection from a
    database. 
 
+   .. |method| replace:: :method:`~db.collection.drop` helper method
+   .. include:: /includes/fact-dbcommand-tip
+
 Syntax
 ------
 

source/reference/command/mapReduce.txt

@@ -22,6 +22,9 @@ Definition
    The :dbcommand:`mapReduce` command allows you to run
    :term:`map-reduce` aggregation operations over a collection. 
 
+   .. |method| replace:: :method:`~db.collection.mapReduce` helper method
+   .. include:: /includes/fact-dbcommand-tip
+
 Syntax
 ------
 

source/reference/command/reIndex.txt

@@ -19,7 +19,10 @@ Definition
 
    Attempting to run the :dbcommand:`reIndex` command writes a warning 
    message to the log.
-   
+
+   .. |method| replace:: :method:`db.collection.reIndex` helper method
+   .. include:: /includes/fact-dbcommand-tip
+
    The :dbcommand:`reIndex` command drops all indexes on a
    collection and recreates them. This operation may be expensive for
    collections that have a large amount of data and/or a large number
@@ -59,7 +62,6 @@ The command takes the following fields:
    * - reIndex
      - The name of the collection to reindex.
 
-:binary:`~bin.mongosh` provides a wrapper :method:`db.collection.reIndex()`.
 
 Behavior
 --------

source/reference/command/renameCollection.txt

@@ -19,6 +19,9 @@ Definition
    to :dbcommand:`renameCollection` in the form of a complete
    :term:`namespace` (``<database>.<collection>``).
 
+   .. |method| replace:: :method:`~db.collection.renameCollection` helper method
+   .. include:: /includes/fact-dbcommand-tip
+
    Issue the :dbcommand:`renameCollection` command against the
    :term:`admin database`.
 

source/reference/command/update.txt

@@ -17,13 +17,15 @@ Definition
 
    The :dbcommand:`update` command modifies documents in a collection.
    A single :dbcommand:`update` command can contain multiple update
-   statements. The update methods provided by the MongoDB drivers use
-   this command internally.
-
-   :binary:`~bin.mongosh` provides the following helper methods:
-
-   - :method:`db.collection.updateOne()`
-   - :method:`db.collection.updateMany()` 
+   statements. 
+
+   .. |method| replace:: :method:`~db.collection.updateOne`,
+      :method:`~db.collection.updateMany`, 
+      :method:`~db.collection.replaceOne`,
+      :method:`~db.collection.findOneAndReplace`, and
+      :method:`~db.collection.findOneAndUpdate` 
+      helper methods
+   .. include:: /includes/fact-dbcommand-tip
 
 Syntax
 ------

source/reference/command/validate.txt

@@ -18,6 +18,11 @@ Definition
    The :dbcommand:`validate` command checks a collection's data and
    indexes for correctness and returns the results.
 
+   .. |method| replace:: :method:`~db.collection.validate` helper method
+   .. include:: /includes/fact-dbcommand-tip
+
+   .. versionchanged:: 5.0
+
    Starting in version 5.0, the :dbcommand:`validate` command can also
    find inconsistencies in the collection and fix them if possible.
 
@@ -50,8 +55,6 @@ The command has the following syntax:
       } 
    )
 
-:binary:`~bin.mongosh` also provides a wrapper
-:method:`db.collection.validate()`.
 
 Command Fields
 --------------

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

@@ -15,9 +15,8 @@ Definition
 
 .. method:: db.collection.count(query, options)
 
-
-   .. include:: /includes/fact-mongosh-shell-method.rst
-
+   .. |dbcommand| replace:: :dbcommand:`count` command
+   .. include:: /includes/fact-mongosh-shell-method-alt
 
    .. note::
 

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

@@ -15,15 +15,15 @@ Definition
 
 .. method:: db.collection.countDocuments(query, options)
 
-
-   .. include:: /includes/fact-mongosh-shell-method.rst
-
+   .. |dbcommand| replace:: :pipeline:`$group` aggregation stage and 
+      the :group:`$sum` expression called by the :dbcommand:`aggregate`
+      command
+   .. include:: /includes/fact-mongosh-shell-method-alt
 
    .. versionadded:: 4.0.3
 
    Returns the count of documents that match the query for a collection
-   or view. The method wraps the :pipeline:`$group` aggregation stage
-   with a :group:`$sum` expression to perform the count and is
+   or view.  This method is
    available for use in :doc:`/core/transactions`.
 
    .. code-block:: javascript

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

@@ -12,22 +12,18 @@ db.collection.dataSize()
 
 .. method:: db.collection.dataSize()
 
-
-   .. include:: /includes/fact-mongosh-shell-method.rst
-
+   .. |dbcommand| replace:: :data:`~collStats.size` field returned by the
+      :dbcommand:`collStats` command
+   .. include:: /includes/fact-mongosh-shell-method-alt
 
    :returns: The size in bytes of the collection.
 
              :option:`Data compression <mongod
              --wiredTigerCollectionBlockCompressor>` does not affect
              this value.
 
-   This method provides a wrapper around the :data:`~collStats.size`
-   output of the :dbcommand:`collStats` (i.e.
-   :method:`db.collection.stats()`) command.
-
    .. include:: /includes/extracts/4.4-changes-repl-state-restrictions-operation.rst
 
    .. |operations| replace:: :dbcommand:`collStats`
 
-   
+   

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

@@ -15,9 +15,8 @@ Definition
 
 .. method:: db.collection.deleteMany()
 
-
-   .. include:: /includes/fact-mongosh-shell-method.rst
-
+   .. |dbcommand| replace:: :dbcommand:`delete` command
+   .. include:: /includes/fact-mongosh-shell-method-alt
 
    Removes all documents that match the ``filter`` from a collection.
 

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

@@ -15,8 +15,8 @@ Definition
 
 .. method:: db.collection.deleteOne()
 
-
-   .. include:: /includes/fact-mongosh-shell-method.rst
+   .. |dbcommand| replace:: :dbcommand:`delete` command
+   .. include:: /includes/fact-mongosh-shell-method-alt
 
 
    Removes a single document from a collection.

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

@@ -17,9 +17,8 @@ Definition
 
 .. method:: db.collection.drop(<options>)
 
-
-   .. include:: /includes/fact-mongosh-shell-method.rst
-
+   .. |dbcommand| replace:: :dbcommand:`drop` command
+   .. include:: /includes/fact-mongosh-shell-method-alt
 
    Removes a collection or :doc:`view </core/views>` from the database.
    The method also removes any indexes associated with the dropped

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

@@ -15,14 +15,13 @@ Definition
 
 .. method:: db.collection.estimatedDocumentCount(options)
 
-
-   .. include:: /includes/fact-mongosh-shell-method.rst
-
+   .. |dbcommand| replace:: :data:`~collStats.count` field returned by the
+      :dbcommand:`collStats` command
+   .. include:: /includes/fact-mongosh-shell-method-alt
 
    .. versionadded:: 4.0.3
 
-   Returns the count of all documents in a collection or view. The
-   method wraps the :dbcommand:`count` command.
+   Returns the count of all documents in a collection or view. 
 
    .. code-block:: javascript
 

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

@@ -15,8 +15,8 @@ Definition
 
 .. method:: db.collection.findOneAndDelete( filter, options )
 
-
-   .. include:: /includes/fact-mongosh-shell-method.rst
+   .. |dbcommand| replace:: :dbcommand:`delete` command
+   .. include:: /includes/fact-mongosh-shell-method-alt
 
    Deletes a single document based on the ``filter`` and 
    ``sort`` criteria, returning the deleted document.

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

@@ -17,8 +17,8 @@ Definition
 
 .. method:: db.collection.findOneAndReplace( filter, replacement, options )
 
-
-   .. include:: /includes/fact-mongosh-shell-method.rst
+   .. |dbcommand| replace:: :dbcommand:`update` command
+   .. include:: /includes/fact-mongosh-shell-method-alt
 
    Replaces a single document based on the specified :ref:`filter
    <findOneAndReplace-filter>`.

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

@@ -15,7 +15,8 @@ Definition
 
 .. method:: db.collection.findOneAndUpdate( filter, update, options )
 
-   .. include:: /includes/fact-mongosh-shell-method.rst
+   .. |dbcommand| replace:: :dbcommand:`update` command
+   .. include:: /includes/fact-mongosh-shell-method-alt
 
    Updates a single document based on the ``filter`` and
    ``sort`` criteria.

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

@@ -17,7 +17,9 @@ Definition
 
    .. versionadded:: 4.4
 
-   .. include:: /includes/fact-mongosh-shell-method.rst
+   .. |dbcommand| replace:: ``index.hidden`` collection option set
+      using the :dbcommand:`collMod` command
+   .. include:: /includes/fact-mongosh-shell-method-alt
 
    Hides an existing index from the query planner. An :doc:`index
    hidden from the query planner </core/index-hidden>` is not evaluated

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

@@ -13,8 +13,9 @@ db.collection.isCapped()
 .. method:: db.collection.isCapped()
 
 
-   .. include:: /includes/fact-mongosh-shell-method.rst
-
+   .. |dbcommand| replace:: :data:`~collStats.capped` field returned by the 
+      :dbcommand:`collStats` command
+   .. include:: /includes/fact-mongosh-shell-method-alt
 
    :returns: Returns ``true`` if the collection is a :term:`capped
              collection`, otherwise returns ``false``.

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

@@ -16,7 +16,9 @@ Definition
 .. method:: db.collection.latencyStats(options)
 
 
-   .. include:: /includes/fact-mongosh-shell-method.rst
+   .. |dbcommand| replace:: ``latencyStats`` field returned by the
+      :dbcommand:`collStats` command
+   .. include:: /includes/fact-mongosh-shell-method-alt
 
 
    :method:`db.collection.latencyStats()` returns latency