mongodb · jeff-allen-mongo · May 3, 2021 · Apr 20, 2021 · ghost · Apr 30, 2021
diff --git a/source/includes/fact-mongo-shell-method-toc.rst b/source/includes/fact-mongo-shell-method-toc.rst
diff --git a/source/includes/fact-mongo-shell-method.rst b/source/includes/fact-mongo-shell-method.rst
diff --git a/source/includes/fact-mongosh-shell-method-toc.rst b/source/includes/fact-mongosh-shell-method-toc.rst
@@ -0,0 +1,18 @@
+The methods listed on this table of contents page are
+:mongosh:`mongosh </>` methods.  This is *not* the documention for
+``Node.js`` or other programming language specific driver methods.
+
+In most cases :mongosh:`mongosh </>` methods work the same way as the
+legacy :binary:`~bin.mongo` shell methods. However, some legacy methods
+are unavailable in ``mongosh``.
+
+For legacy :binary:`~bin.mongo` shell documention, refer to the
+documentation for the corresponding ``MongoDB`` release.
+
+- :v4.4:`mongo shell v4.4 </mongo>`
+- :v4.2:`mongo shell v4.2 </mongo>`
+- :v4.0:`mongo shell v4.0 </mongo>`
+
+For MongoDB API drivers, refer to the language specific
+:driver:`MongoDB driver </>` documentation.
+
diff --git a/source/includes/fact-mongosh-shell-method.rst b/source/includes/fact-mongosh-shell-method.rst
@@ -0,0 +1,20 @@
+.. important:: ``mongosh`` Method
+
+   This is a :mongosh:`mongosh </>` method. This is *not* the
+   documention for ``Node.js`` or other programming language specific
+   driver methods.
+
+   In most cases :mongosh:`mongosh </>` methods work the same way as
+   the legacy :binary:`~bin.mongo` shell methods. However, some legacy
+   methods are unavailable in ``mongosh``.
+
+   For legacy :binary:`~bin.mongo` shell documention, refer to the
+   documentation for the corresponding ``MongoDB`` release.
+
+   - :v4.4:`mongo shell v4.4 </mongo>`
+   - :v4.2:`mongo shell v4.2 </mongo>`
+   - :v4.0:`mongo shell v4.0 </mongo>`
+
+   For MongoDB API drivers, refer to the language specific
+   :driver:`MongoDB driver </>` documentation.
+
diff --git a/source/reference/method.txt b/source/reference/method.txt
@@ -1,8 +1,8 @@
 .. _js-administrative-methods:
 
-=======================
-``mongo`` Shell Methods
-=======================
+===================
+``mongosh`` Methods
+===================
 
 .. default-domain:: mongodb
 

diff --git a/source/reference/method/cursor.addOption.txt b/source/reference/method/cursor.addOption.txt
@@ -16,7 +16,7 @@ Definition
 .. method:: cursor.addOption(flag)
 
 
-   .. include:: /includes/fact-mongo-shell-method.rst
+   .. include:: /includes/fact-mongosh-shell-method.rst
 
 
    .. include:: /includes/extracts/mongo-shell-deprecated-meta-operator-cursor-addOption.rst

diff --git a/source/reference/method/cursor.allowDiskUse.txt b/source/reference/method/cursor.allowDiskUse.txt
@@ -18,7 +18,7 @@ Definition
 .. method:: cursor.allowDiskUse()
 
 
-   .. include:: /includes/fact-mongo-shell-method.rst
+   .. include:: /includes/fact-mongosh-shell-method.rst
 
    :method:`~cursor.allowDiskUse()` allows MongoDB to use temporary
    files on disk to store data exceeding the 100 megabyte system memory

diff --git a/source/reference/method/cursor.allowPartialResults.txt b/source/reference/method/cursor.allowPartialResults.txt
@@ -15,7 +15,7 @@ Definition
 
 .. method:: cursor.allowPartialResults()
 
-   .. include:: /includes/fact-mongo-shell-method.rst
+   .. include:: /includes/fact-mongosh-shell-method.rst
 
    When used with :method:`db.collection.find()` operations against a
    sharded collection, returns partial results, rather than an error,

diff --git a/source/reference/method/cursor.batchSize.txt b/source/reference/method/cursor.batchSize.txt
@@ -16,7 +16,7 @@ Definition
 .. method:: cursor.batchSize(size)
 
 
-   .. include:: /includes/fact-mongo-shell-method.rst
+   .. include:: /includes/fact-mongosh-shell-method.rst
 
 
    Specifies the

diff --git a/source/reference/method/cursor.close.txt b/source/reference/method/cursor.close.txt
@@ -10,7 +10,7 @@ Definition
 .. method:: cursor.close()
 
 
-   .. include:: /includes/fact-mongo-shell-method.rst
+   .. include:: /includes/fact-mongosh-shell-method.rst
 
 
    Instructs the server to close a :ref:`cursor <read-operations-cursors>`

diff --git a/source/reference/method/cursor.collation.txt b/source/reference/method/cursor.collation.txt
@@ -18,7 +18,7 @@ Definition
 .. method:: cursor.collation(<collation document>)
 
 
-   .. include:: /includes/fact-mongo-shell-method.rst
+   .. include:: /includes/fact-mongosh-shell-method.rst
 
 
    .. versionadded:: 3.4

diff --git a/source/reference/method/cursor.comment.txt b/source/reference/method/cursor.comment.txt
@@ -16,7 +16,7 @@ Definition
 .. method:: cursor.comment()
 
 
-   .. include:: /includes/fact-mongo-shell-method.rst
+   .. include:: /includes/fact-mongosh-shell-method.rst
 
 
    .. versionadded:: 3.2

diff --git a/source/reference/method/cursor.count.txt b/source/reference/method/cursor.count.txt
@@ -16,7 +16,7 @@ Definition
 .. method:: cursor.count()
 
 
-   .. include:: /includes/fact-mongo-shell-method.rst
+   .. include:: /includes/fact-mongosh-shell-method.rst
 
 
    .. note::

diff --git a/source/reference/method/cursor.explain.txt b/source/reference/method/cursor.explain.txt
@@ -15,7 +15,7 @@ Definition
 
 .. method:: cursor.explain(verbosity)
 
-   .. include:: /includes/fact-mongo-shell-method.rst
+   .. include:: /includes/fact-mongosh-shell-method.rst
 
    Provides information on the query plan for the
    :method:`db.collection.find()` method.

diff --git a/source/reference/method/cursor.forEach.txt b/source/reference/method/cursor.forEach.txt
@@ -16,7 +16,7 @@ Description
 .. method:: cursor.forEach(function)
 
 
-   .. include:: /includes/fact-mongo-shell-method.rst
+   .. include:: /includes/fact-mongosh-shell-method.rst
 
 
    Iterates the cursor to apply a JavaScript ``function`` to each

diff --git a/source/reference/method/cursor.hasNext.txt b/source/reference/method/cursor.hasNext.txt
@@ -13,7 +13,7 @@ cursor.hasNext()
 .. method:: cursor.hasNext()
 
 
-   .. include:: /includes/fact-mongo-shell-method.rst
+   .. include:: /includes/fact-mongosh-shell-method.rst
 
 
    :returns: Boolean.

diff --git a/source/reference/method/cursor.hint.txt b/source/reference/method/cursor.hint.txt
@@ -16,7 +16,7 @@ Definition
 .. method:: cursor.hint(index)
 
 
-   .. include:: /includes/fact-mongo-shell-method.rst
+   .. include:: /includes/fact-mongosh-shell-method.rst
 
 
    Call this method on a query to override MongoDB's default index

diff --git a/source/reference/method/cursor.isClosed.txt b/source/reference/method/cursor.isClosed.txt
@@ -13,7 +13,7 @@ cursor.isClosed()
 .. method:: cursor.isClosed()
 
 
-   .. include:: /includes/fact-mongo-shell-method.rst
+   .. include:: /includes/fact-mongosh-shell-method.rst
 
 
    :returns: Boolean.

diff --git a/source/reference/method/cursor.isExhausted.txt b/source/reference/method/cursor.isExhausted.txt
@@ -13,7 +13,7 @@ cursor.isExhausted()
 .. method:: cursor.isExhausted()
 
 
-   .. include:: /includes/fact-mongo-shell-method.rst
+   .. include:: /includes/fact-mongosh-shell-method.rst
 
 
    :returns: Boolean.

diff --git a/source/reference/method/cursor.itcount.txt b/source/reference/method/cursor.itcount.txt
@@ -16,7 +16,7 @@ Definition
 .. method:: cursor.itcount()
 
 
-   .. include:: /includes/fact-mongo-shell-method.rst
+   .. include:: /includes/fact-mongosh-shell-method.rst
 
 
    Counts the number of documents remaining in a cursor.

diff --git a/source/reference/method/cursor.limit.txt b/source/reference/method/cursor.limit.txt
@@ -16,7 +16,7 @@ Definition
 .. method:: cursor.limit()
 
 
-   .. include:: /includes/fact-mongo-shell-method.rst
+   .. include:: /includes/fact-mongosh-shell-method.rst
 
 
    Use the :method:`~cursor.limit()` method on a cursor to specify the maximum

diff --git a/source/reference/method/cursor.map.txt b/source/reference/method/cursor.map.txt
@@ -13,7 +13,7 @@ cursor.map()
 .. method:: cursor.map(function)
 
 
-   .. include:: /includes/fact-mongo-shell-method.rst
+   .. include:: /includes/fact-mongosh-shell-method.rst
 
 
    Applies ``function`` to each document visited by the cursor and

diff --git a/source/reference/method/cursor.max.txt b/source/reference/method/cursor.max.txt
@@ -16,7 +16,7 @@ Definition
 .. method:: cursor.max()
 
 
-   .. include:: /includes/fact-mongo-shell-method.rst
+   .. include:: /includes/fact-mongosh-shell-method.rst
 
 
    Specifies the *exclusive* upper bound for a specific index in order

diff --git a/source/reference/method/cursor.maxTimeMS.txt b/source/reference/method/cursor.maxTimeMS.txt
@@ -16,7 +16,7 @@ Definition
 .. method:: cursor.maxTimeMS(<time limit>)
 
 
-   .. include:: /includes/fact-mongo-shell-method.rst
+   .. include:: /includes/fact-mongosh-shell-method.rst
 
 
    Specifies a cumulative time limit in milliseconds for processing

diff --git a/source/reference/method/cursor.min.txt b/source/reference/method/cursor.min.txt
@@ -16,7 +16,7 @@ Definition
 .. method:: cursor.min()
 
 
-   .. include:: /includes/fact-mongo-shell-method.rst
+   .. include:: /includes/fact-mongosh-shell-method.rst
 
 
    Specifies the *inclusive* lower bound for a specific index in order

diff --git a/source/reference/method/cursor.next.txt b/source/reference/method/cursor.next.txt
@@ -13,7 +13,7 @@ cursor.next()
 .. method:: cursor.next()
 
 
-   .. include:: /includes/fact-mongo-shell-method.rst
+   .. include:: /includes/fact-mongosh-shell-method.rst
 
 
    :returns: The next document in the cursor returned by the

diff --git a/source/reference/method/cursor.noCursorTimeout.txt b/source/reference/method/cursor.noCursorTimeout.txt
@@ -10,7 +10,7 @@ Definition
 .. method:: cursor.noCursorTimeout()
 
 
-   .. include:: /includes/fact-mongo-shell-method.rst
+   .. include:: /includes/fact-mongosh-shell-method.rst
 
 
    Instructs the server to avoid closing a cursor automatically after a period

diff --git a/source/reference/method/cursor.objsLeftInBatch.txt b/source/reference/method/cursor.objsLeftInBatch.txt
@@ -13,7 +13,7 @@ cursor.objsLeftInBatch()
 .. method:: cursor.objsLeftInBatch()
 
 
-   .. include:: /includes/fact-mongo-shell-method.rst
+   .. include:: /includes/fact-mongosh-shell-method.rst
 
 
    :method:`cursor.objsLeftInBatch()` returns the number of

diff --git a/source/reference/method/cursor.pretty.txt b/source/reference/method/cursor.pretty.txt
@@ -16,7 +16,7 @@ Definition
 .. method:: cursor.pretty()
 
 
-   .. include:: /includes/fact-mongo-shell-method.rst
+   .. include:: /includes/fact-mongosh-shell-method.rst
 
 
    Configures the cursor to display results in an easy-to-read format.

diff --git a/source/reference/method/cursor.readConcern.txt b/source/reference/method/cursor.readConcern.txt
@@ -17,7 +17,7 @@ Definition
 .. method:: cursor.readConcern(level)
 
 
-   .. include:: /includes/fact-mongo-shell-method.rst
+   .. include:: /includes/fact-mongosh-shell-method.rst
 
 
    .. versionadded:: 3.2

diff --git a/source/reference/method/cursor.readPref.txt b/source/reference/method/cursor.readPref.txt
@@ -16,7 +16,7 @@ Definition
 .. method:: cursor.readPref(mode, tagSet, hedgeOptions)
 
 
-   .. include:: /includes/fact-mongo-shell-method.rst
+   .. include:: /includes/fact-mongosh-shell-method.rst
 
 
    Append :method:`~cursor.readPref()` to a cursor to

diff --git a/source/reference/method/cursor.returnKey.txt b/source/reference/method/cursor.returnKey.txt
@@ -16,7 +16,7 @@ Definition
 .. method:: cursor.returnKey()
 
 
-   .. include:: /includes/fact-mongo-shell-method.rst
+   .. include:: /includes/fact-mongosh-shell-method.rst
 
    .. tip::
 

diff --git a/source/reference/method/cursor.showRecordId.txt b/source/reference/method/cursor.showRecordId.txt
@@ -13,7 +13,7 @@ cursor.showRecordId()
 .. method:: cursor.showRecordId()
 
 
-   .. include:: /includes/fact-mongo-shell-method.rst
+   .. include:: /includes/fact-mongosh-shell-method.rst
 
 
    .. versionchanged:: 3.2

diff --git a/source/reference/method/cursor.size.txt b/source/reference/method/cursor.size.txt
@@ -13,7 +13,7 @@ cursor.size()
 .. method:: cursor.size()
 
 
-   .. include:: /includes/fact-mongo-shell-method.rst
+   .. include:: /includes/fact-mongosh-shell-method.rst
 
 
    :returns: A count of the number of documents that match the

diff --git a/source/reference/method/cursor.skip.txt b/source/reference/method/cursor.skip.txt
@@ -16,7 +16,7 @@ Definition
 .. method:: cursor.skip(<offset>)
 
 
-   .. include:: /includes/fact-mongo-shell-method.rst
+   .. include:: /includes/fact-mongosh-shell-method.rst
 
 
    Call the :method:`~cursor.skip()` method on a cursor to control where

diff --git a/source/reference/method/cursor.sort.txt b/source/reference/method/cursor.sort.txt
@@ -16,7 +16,7 @@ Definition
 .. method:: cursor.sort(sort)
 
 
-   .. include:: /includes/fact-mongo-shell-method.rst
+   .. include:: /includes/fact-mongosh-shell-method.rst
 
 
    Specifies the order in which the query returns matching documents.

diff --git a/source/reference/method/cursor.tailable.txt b/source/reference/method/cursor.tailable.txt
@@ -16,7 +16,7 @@ Definition
 .. method:: cursor.tailable()
 
 
-   .. include:: /includes/fact-mongo-shell-method.rst
+   .. include:: /includes/fact-mongosh-shell-method.rst
 
 
    .. versionadded:: 3.2

diff --git a/source/reference/method/cursor.toArray.txt b/source/reference/method/cursor.toArray.txt
@@ -13,7 +13,7 @@ cursor.toArray()
 .. method:: cursor.toArray()
 
 
-   .. include:: /includes/fact-mongo-shell-method.rst
+   .. include:: /includes/fact-mongosh-shell-method.rst
 
 
    The :method:`~cursor.toArray()` method returns an array that

diff --git a/source/reference/method/db.adminCommand.txt b/source/reference/method/db.adminCommand.txt
@@ -10,6 +10,8 @@ db.adminCommand()
    :depth: 1
    :class: singlecol
 
+.. include:: /includes/fact-mongosh-shell-method.rst
+
 Definition
 ----------
 

diff --git a/source/reference/method/db.collection.aggregate.txt b/source/reference/method/db.collection.aggregate.txt
@@ -16,7 +16,7 @@ Definition
 .. method:: db.collection.aggregate(pipeline, options)
 
 
-   .. include:: /includes/fact-mongo-shell-method.rst
+   .. include:: /includes/fact-mongosh-shell-method.rst
 
 
    Calculates aggregate values for the data in a collection or a :doc:`view </core/views>`.

diff --git a/source/reference/method/db.collection.bulkWrite.txt b/source/reference/method/db.collection.bulkWrite.txt
@@ -16,7 +16,7 @@ Definition
 .. method:: db.collection.bulkWrite()
 
 
-   .. include:: /includes/fact-mongo-shell-method.rst
+   .. include:: /includes/fact-mongosh-shell-method.rst
 
 
    .. versionadded:: 3.2

diff --git a/source/reference/method/db.collection.copyTo.txt b/source/reference/method/db.collection.copyTo.txt
@@ -16,7 +16,7 @@ Definition
 .. method:: db.collection.copyTo(newCollection)
 
 
-   .. include:: /includes/fact-mongo-shell-method.rst
+   .. include:: /includes/fact-mongosh-shell-method.rst
 
 
    .. deprecated:: 3.0