DOCSP-24513 Interlink of Mongosh Methods to Database Commands I (#2222)

kennethdyer · web-flow · commit f75206cb43f1 · 2022-12-06T17:07:12.000-05:00
* DOCSP-24513 Adds interlinks for db.% mongosh methods * Interlinks commands and methods * Interlinks commands and methods * Fixes build error * Fixes build error * Fixes per Joe D. * Fixes per Joe D. * Fixes per Ashley * Fixes per Ashley
diff --git a/source/reference/command/createUser.txt b/source/reference/command/createUser.txt
@@ -21,6 +21,9 @@ Definition
    :dbcommand:`createUser` command returns a *duplicate user* error if the
    user exists.
 
+   .. |method| replace:: :method:`db.createUser` helper method
+   .. include:: /includes/fact-dbcommand-tip
+
 Syntax
 ------
 
diff --git a/source/reference/command/dropAllUsersFromDatabase.txt b/source/reference/command/dropAllUsersFromDatabase.txt
@@ -18,6 +18,9 @@ Definition
    Removes all users from the database on which you run the
    command.
 
+   .. |method| replace:: :method:`db.dropAllUsers` helper method
+   .. include:: /includes/fact-dbcommand-tip
+
    .. warning::
 
       The :dbcommand:`dropAllUsersFromDatabase` removes all users from the database.
diff --git a/source/reference/command/dropUser.txt b/source/reference/command/dropUser.txt
@@ -17,6 +17,9 @@ Definition
 
    Removes the user from the database on which you run the command. 
 
+   .. |method| replace:: :method:`db.dropUser` helper method
+   .. include:: /includes/fact-dbcommand-tip
+
 Syntax
 ------
 
diff --git a/source/reference/command/grantRolesToUser.txt b/source/reference/command/grantRolesToUser.txt
@@ -17,6 +17,9 @@ Definition
 
    Grants additional roles to a user.
 
+   .. |method| replace:: :method:`db.grantRolesToUser` helper method
+   .. include:: /includes/fact-dbcommand-tip
+
 Syntax
 ------
 
diff --git a/source/reference/command/revokeRolesFromUser.txt b/source/reference/command/revokeRolesFromUser.txt
@@ -15,9 +15,12 @@ Definition
 
 .. dbcommand:: revokeRolesFromUser
 
-   Removes a one or more roles from a user on the database where the
+   Removes one or more roles from a user on the database where the
    roles exist. 
 
+   .. |method| replace:: :method:`db.revokeRolesFromUser` helper method
+   .. include:: /includes/fact-dbcommand-tip
+
 Syntax
 ------
 
diff --git a/source/reference/command/updateUser.txt b/source/reference/command/updateUser.txt
@@ -23,6 +23,9 @@ Definition
    field's values, including updates to the user's ``roles`` and
    ``authenticationRestrictions`` arrays.
 
+   .. |method| replace:: :method:`db.changeUserPassword` helper method
+   .. include:: /includes/fact-dbcommand-tip
+
    .. warning::
 
       When you update the ``roles`` array, you completely replace the
diff --git a/source/reference/method/db.aggregate.txt b/source/reference/method/db.aggregate.txt
@@ -19,158 +19,127 @@ Definition
    underlying collection. For aggregations on collection data, see
    :method:`db.collection.aggregate()`.
 
+   .. |dbcommand| replace:: :dbcommand:`aggregate` command
+   .. include:: /includes/fact-mongosh-shell-method-alt.rst
+
    The :method:`db.aggregate()` method has the following syntax:
 
    .. code-block:: javascript
 
       db.aggregate( [ <pipeline> ], { <options> } )
 
-   - The ``pipeline`` parameter is an array of stages to execute. It
-     must start with a compatible stage that does not require an
-     underlying collection, such as :pipeline:`$currentOp` or 
-     :pipeline:`$listLocalSessions`.
-
-   - The ``options`` document can contain the following fields and values:
-
-
-     .. list-table::
-        :header-rows: 1
-        :widths: 20 20 80
-     
-        * - Field
-     
-          - Type
-     
-          - Description
-     
-        * - ``explain``
-     
-          - boolean
-     
-          - Optional. Specifies to return the information on the processing of the pipeline. See
-            :ref:`example-aggregate-method-explain-option` for an example.
-            
-            Not available in :ref:`multi-document transactions <transactions>`.
-            
-            
-     
-        * - ``allowDiskUse``
-     
-          - boolean
-     
-          - Optional. Enables writing to temporary files. When set to ``true``, aggregation
-            operations can write data to the :file:`_tmp` subdirectory in the
-            :setting:`~storage.dbPath` directory. See
-            :ref:`example-aggregate-method-external-sort` for an example.
-            
-            .. include:: /includes/extracts/4.2-changes-usedDisk.rst
-            
-            
-     
-        * - ``cursor``
-     
-          - document
-     
-          - Optional. Specifies the *initial* batch size for the cursor. The value of the ``cursor``
-            field is a document with the field ``batchSize``. See
-            :ref:`example-aggregate-method-initial-batch-size` for syntax and example.
-
-     
-        * - ``maxTimeMS``
-     
-          - non-negative integer
-     
-          - Optional. Specifies a time limit in milliseconds for processing
-            operations on a cursor. If you do not specify a value for maxTimeMS,
-            operations will not time out. A value of ``0`` explicitly
-            specifies the default unbounded behavior.
-            
-            MongoDB terminates operations that exceed their allotted time limit
-            using the same mechanism as :method:`db.killOp()`. MongoDB only
-            terminates an operation at one of its designated :term:`interrupt 
-            points <interrupt point>`.
-            
-            
-     
-        * - ``bypassDocumentValidation``
-     
-          - boolean
-     
-          - Optional. Applicable only if you specify the :pipeline:`$out` or :pipeline:`$merge` aggregation
-            stages.
-            
-            
-            
-            Enables :method:`db.collection.aggregate` to bypass document validation
-            during the operation. This lets you insert documents that do not
-            meet the validation requirements.
-            
-            
-     
-        * - ``readConcern``
-     
-          - document
-     
-          - Optional. Specifies the :term:`read concern`.
-            
-            .. include:: /includes/fact-readConcern-syntax.rst
-            
-            .. include:: /includes/fact-readConcern-option-description.rst
-            
-            .. include:: /includes/extracts/4.2-changes-out-linearizable.rst
-            
-            .. include:: /includes/extracts/4.2-changes-linearizable-merge-restriction.rst
-            
-            
-     
-        * - ``collation``
-     
-          - document
-     
-          - Optional. 
-            
-            .. include:: /includes/extracts/collation-option.rst
-            
-            
-     
-        * - ``hint``
-     
-          - string or document
-     
-          - Optional. The index to use for the aggregation. The index is on the initial
-            collection/view against which the aggregation is run.
-            
-            Specify the index either by the index name or by the index
-            specification document.
-            
-            .. note::
-            
-               The ``hint`` does not apply to :pipeline:`$lookup` and
-               :pipeline:`$graphLookup` stages.
-            
-            
-     
-        * - ``comment``
-     
-          - string
-     
-          - Optional. Users can specify an arbitrary string to help trace the operation 
-            through the database profiler, currentOp, and logs.
-            
-            
-     
-        * - ``writeConcern``
-     
-          - document
-     
-          - Optional. A document that expresses the :ref:`write concern <write-concern>`
-            to use with the :pipeline:`$out` or :pipeline:`$merge` stage. 
-            
-            Omit to use the default write concern with the :pipeline:`$out` or
-            :pipeline:`$merge` stage.
-            
-            
-     
+   The ``pipeline`` parameter is an array of stages to execute. It
+   must start with a compatible stage that does not require an
+   underlying collection, such as :pipeline:`$currentOp` or 
+   :pipeline:`$listLocalSessions`.
+
+   The ``options`` document can contain the following fields and values:
+
+
+   .. list-table::
+      :header-rows: 1
+      :widths: 20 20 80
+   
+      * - Field
+        - Type
+        - Description
+   
+      * - ``explain``
+        - boolean
+        - Optional. Specifies that the method should return 
+          information on the processing of the pipeline. 
+          
+          See :ref:`example-aggregate-method-explain-option` for an example.
+          
+          Not available in :ref:`multi-document transactions <transactions>`.
+          
+   
+      * - ``allowDiskUse``
+        - boolean
+        - Optional. Enables writing to temporary files. When set to ``true``, aggregation
+          operations can write data to the :file:`_tmp` subdirectory in the
+          :setting:`~storage.dbPath` directory. See
+          :ref:`example-aggregate-method-external-sort` for an example.
+          
+          .. include:: /includes/extracts/4.2-changes-usedDisk.rst
+          
+   
+      * - ``cursor``
+        - document
+        - Optional. Specifies the *initial* batch size for the cursor. The value of the ``cursor``
+          field is a document with the field ``batchSize``. See
+          :ref:`example-aggregate-method-initial-batch-size` for syntax and example.
+
+   
+      * - ``maxTimeMS``
+        - non-negative integer
+        - Optional. Specifies a time limit in milliseconds for processing
+          operations on a cursor. If you do not specify a value for maxTimeMS,
+          operations will not time out. A value of ``0`` explicitly
+          specifies the default unbounded behavior.
+          
+          MongoDB terminates operations that exceed their allotted time limit
+          using the same mechanism as :method:`db.killOp()`. MongoDB only
+          terminates an operation at one of its designated :term:`interrupt 
+          points <interrupt point>`.
+          
+   
+      * - ``bypassDocumentValidation``
+        - boolean
+        - Optional. Applicable only if you specify the :pipeline:`$out` or :pipeline:`$merge` aggregation
+          stages.
+          
+          Enables :method:`db.collection.aggregate` to bypass document validation
+          during the operation. This lets you insert documents that do not
+          meet the validation requirements.
+   
+      * - ``readConcern``
+        - document
+        - Optional. Specifies the :term:`read concern`.
+          
+          .. include:: /includes/fact-readConcern-syntax.rst
+          
+          .. include:: /includes/fact-readConcern-option-description.rst
+          
+          .. include:: /includes/extracts/4.2-changes-out-linearizable.rst
+          
+          .. include:: /includes/extracts/4.2-changes-linearizable-merge-restriction.rst
+          
+   
+      * - ``collation``
+        - document
+        - Optional. 
+          
+          .. include:: /includes/extracts/collation-option.rst
+   
+
+      * - ``hint``
+        - string or document
+        - Optional. The index to use for the aggregation. The index is on the initial
+          collection/view against which the aggregation is run.
+          
+          Specify the index either by the index name or by the index
+          specification document.
+          
+          .. note::
+          
+             The ``hint`` does not apply to :pipeline:`$lookup` and
+             :pipeline:`$graphLookup` stages.
+          
+   
+      * - ``comment``
+        - string
+        - Optional. Users can specify an arbitrary string to help trace the operation 
+          through the database profiler, currentOp, and logs.
+          
+   
+      * - ``writeConcern``
+        - document
+        - Optional. A document that expresses the :ref:`write concern <write-concern>`
+          to use with the :pipeline:`$out` or :pipeline:`$merge` stage. 
+          
+          Omit to use the default write concern with the :pipeline:`$out` or
+          :pipeline:`$merge` stage.
 
 
 Example
diff --git a/source/reference/method/db.changeUserPassword.txt b/source/reference/method/db.changeUserPassword.txt
@@ -19,6 +19,8 @@ Definition
    user is defined, i.e. the database you :method:`created
    <db.createUser()>` the user.
 
+   .. |dbcommand| replace:: :dbcommand:`updateUser` command
+   .. include:: /includes/fact-mongosh-shell-method-alt.rst
 
    .. list-table::
       :header-rows: 1
diff --git a/source/reference/method/db.createUser.txt b/source/reference/method/db.createUser.txt
@@ -19,6 +19,9 @@ Definition
    :method:`db.createUser()` returns a *duplicate user* error if the
    user already exists on the database.
 
+   .. |dbcommand| replace:: :dbcommand:`createUser` command
+   .. include:: /includes/fact-mongosh-shell-method-alt.rst
+
    The :method:`db.createUser()` method has the following syntax:
 
 
diff --git a/source/reference/method/db.dropAllUsers.txt b/source/reference/method/db.dropAllUsers.txt
@@ -17,6 +17,9 @@ Definition
 
    Removes all users from the current database.
 
+   .. |dbcommand| replace:: :dbcommand:`dropAllUsersFromDatabase` command
+   .. include:: /includes/fact-mongosh-shell-method-alt.rst
+
    .. warning::
 
       The :method:`db.dropAllUsers` method removes all users from the
diff --git a/source/reference/method/db.dropUser.txt b/source/reference/method/db.dropUser.txt
@@ -17,6 +17,9 @@ Definition
 
    Removes the user from the current database.
 
+   .. |dbcommand| replace:: :dbcommand:`dropUser` command
+   .. include:: /includes/fact-mongosh-shell-method-alt.rst
+
    The :method:`db.dropUser()` method takes the following arguments:
 
 
diff --git a/source/reference/method/db.grantRolesToUser.txt b/source/reference/method/db.grantRolesToUser.txt
@@ -17,6 +17,9 @@ Definition
 
    Grants additional roles to a user.
 
+   .. |dbcommand| replace:: :dbcommand:`grantRolesToUser` command
+   .. include:: /includes/fact-mongosh-shell-method-alt.rst
+
    The :method:`db.grantRolesToUser()` method uses the following syntax:
 
    .. code-block:: javascript
diff --git a/source/reference/method/db.revokeRolesFromUser.txt b/source/reference/method/db.revokeRolesFromUser.txt
