DOCSP-42206-adds-atlas-compat-for-database-methods (#10290)

* DOCSP-42206 adds atlas compat for database methods * Removes duplicate getName compatibility * Fixes headings * Reverts db.stats compat to limited for free/shared instances
mongodb · Nov 20, 2024 · e81dc03 · e81dc03
1 parent 05c5f6a
commit e81dc03
Show file tree

Hide file tree

Showing 39 changed files with 293 additions and 59 deletions.
diff --git a/source/reference/method/db.adminCommand.txt b/source/reference/method/db.adminCommand.txt
@@ -39,9 +39,16 @@ Definition
           or as a string. If specified as a string, the command cannot include
           any arguments.
 
-
-
+Compatibility
+-------------
+
+This method is available in deployments hosted in the following environments: 
+
+.. include:: /includes/fact-environments-atlas-only.rst
+
+.. include:: /includes/fact-environments-atlas-support-all.rst
 
+.. include:: /includes/fact-environments-onprem-only.rst
 
 Behavior
 --------

diff --git a/source/reference/method/db.aggregate.txt b/source/reference/method/db.aggregate.txt
@@ -143,8 +143,6 @@ Definition
 Compatibility
 -------------
 
-.. |command| replace:: method
-
 This method is available in deployments hosted in the following environments:
 
 .. include:: /includes/fact-environments-atlas-only.rst

diff --git a/source/reference/method/db.commandHelp.txt b/source/reference/method/db.commandHelp.txt
@@ -38,5 +38,13 @@ Description
         - The name of a :term:`database command`.
 
 
-
+Compatibility
+-------------
+
+This method is available in deployments hosted in the following environments:
+
+.. include:: /includes/fact-environments-atlas-only.rst
+
+.. include:: /includes/fact-environments-atlas-support-limited-free-and-m10.rst
 
+.. include:: /includes/fact-environments-onprem-only.rst
diff --git a/source/reference/method/db.createCollection.txt b/source/reference/method/db.createCollection.txt
@@ -41,9 +41,14 @@ Definition
 Compatibility
 -------------
 
-.. |operator-method| replace:: ``db.createCollection()``
+This method is available in deployments hosted in the following environments: 
+
+.. include:: /includes/fact-environments-atlas-only.rst
+
+.. include:: /includes/fact-environments-atlas-support-all.rst
+
+.. include:: /includes/fact-environments-onprem-only.rst
 
-.. include:: /includes/fact-compatibility.rst
 
 Syntax
 ------

diff --git a/source/reference/method/db.createView.txt b/source/reference/method/db.createView.txt
@@ -24,6 +24,18 @@ db.createView()
 
    .. include:: /includes/extracts/views-restriction-output-to-disk.rst
 
+Compatibility
+-------------
+
+This method is available in deployments hosted in the following environments: 
+
+.. include:: /includes/fact-environments-atlas-only.rst
+
+.. include:: /includes/fact-environments-atlas-support-all.rst
+
+.. include:: /includes/fact-environments-onprem-only.rst
+
+
 Syntax
 ------
 

diff --git a/source/reference/method/db.currentOp.txt b/source/reference/method/db.currentOp.txt
@@ -33,13 +33,11 @@ Definition
 Compatibility
 -------------
 
-.. |command| replace:: method
-
 This method is available in deployments hosted in the following environments: 
 
 .. include:: /includes/fact-environments-atlas-only.rst
 
-.. include:: /includes/fact-environments-atlas-support-all.rst
+.. include:: /includes/fact-environments-atlas-support-no-free.rst
 
 .. include:: /includes/fact-environments-onprem-only.rst
 

diff --git a/source/reference/method/db.dropDatabase.txt b/source/reference/method/db.dropDatabase.txt
@@ -28,8 +28,6 @@ Definition
 Compatibility
 -------------
 
-.. |command| replace:: method
-
 This method is available in deployments hosted in the following environments: 
 
 .. include:: /includes/fact-environments-atlas-only.rst

diff --git a/source/reference/method/db.fsyncLock.txt b/source/reference/method/db.fsyncLock.txt
@@ -61,6 +61,15 @@ Definition
    :method:`db.fsyncLock()` is an administrative command. Use this method to
    lock a server or cluster before :ref:`backup operations <backup-methods>`.
 
+Compatibility
+-------------
+
+This method is available in deployments hosted in the following environments: 
+
+.. include:: /includes/fact-environments-no-atlas-support.rst
+
+.. include:: /includes/fact-environments-onprem-only.rst
+
 Behavior
 --------
 

diff --git a/source/reference/method/db.fsyncUnlock.txt b/source/reference/method/db.fsyncUnlock.txt
@@ -65,18 +65,14 @@ Definition
 Compatibility
 -------------
 
-.. |command| replace:: method
-
 This method is available in deployments hosted in the following environments:
 
-.. include:: /includes/fact-environments-atlas-only.rst
-
-.. include:: /includes/fact-environments-atlas-support-no-free.rst
+.. include:: /includes/fact-environments-no-atlas-support.rst
 
 .. include:: /includes/fact-environments-onprem-only.rst
 
 Compatibility with WiredTiger
------------------------------
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 .. include:: /includes/extracts/wt-fsync-lock-compatibility.rst
 

diff --git a/source/reference/method/db.getCollection.txt b/source/reference/method/db.getCollection.txt
@@ -42,7 +42,16 @@ Definition
         - The name of the collection.
 
 
-
+Compatibility
+-------------
+
+This method is available in deployments hosted in the following environments: 
+
+.. include:: /includes/fact-environments-atlas-only.rst
+
+.. include:: /includes/fact-environments-atlas-support-all.rst
+
+.. include:: /includes/fact-environments-onprem-only.rst
 
 
 Behavior

diff --git a/source/reference/method/db.getCollectionInfos.txt b/source/reference/method/db.getCollectionInfos.txt
@@ -84,6 +84,18 @@ Definition
           command when access control is enforced. Otherwise, the user is
           unauthorized to run the command.
 
+Compatibility
+-------------
+
+This method is available in deployments hosted in the following environments: 
+
+.. include:: /includes/fact-environments-atlas-only.rst
+
+.. include:: /includes/fact-environments-atlas-support-all.rst
+
+.. include:: /includes/fact-environments-onprem-only.rst
+
+
 .. _db.getCollectionInfo-access-control:
 
 Required Access

diff --git a/source/reference/method/db.getCollectionNames.txt b/source/reference/method/db.getCollectionNames.txt
@@ -20,6 +20,18 @@ Definition
    with access control, the names of the collections according to user's
    privilege. For details, see :ref:`db.collectionnames-access`.
 
+Compatibility
+-------------
+
+This method is available in deployments hosted in the following environments: 
+
+.. include:: /includes/fact-environments-atlas-only.rst
+
+.. include:: /includes/fact-environments-atlas-support-all.rst
+
+.. include:: /includes/fact-environments-onprem-only.rst
+
+
 .. _db.collectionnames-access:
 
 Required Access

diff --git a/source/reference/method/db.getLogComponents.txt b/source/reference/method/db.getLogComponents.txt
@@ -24,6 +24,18 @@ Definition
    :method:`db.getLogComponents()` displays ``-1`` for the component's
    verbosity.
 
+Compatibility
+-------------
+
+This method is available in deployments hosted in the following environments: 
+
+.. include:: /includes/fact-environments-atlas-only.rst
+
+.. include:: /includes/fact-environments-atlas-support-no-free.rst
+
+.. include:: /includes/fact-environments-onprem-only.rst
+
+
 Output
 ------
 

diff --git a/source/reference/method/db.getMongo.txt b/source/reference/method/db.getMongo.txt
@@ -27,3 +27,13 @@ db.getMongo()
    :binary:`mongosh`. In :binary:`mongosh`, use
    :method:`Mongo.setReadPref()` instead.
 
+Compatibility
+-------------
+
+This method is available in deployments hosted in the following environments: 
+
+.. include:: /includes/fact-environments-atlas-only.rst
+
+.. include:: /includes/fact-environments-atlas-support-all.rst
+
+.. include:: /includes/fact-environments-onprem-only.rst
diff --git a/source/reference/method/db.getName.txt b/source/reference/method/db.getName.txt
@@ -27,9 +27,14 @@ Definition
 Compatibility
 -------------
 
-.. |operator-method| replace:: ``db.getName()``
+This method is available in deployments hosted in the following environments: 
+
+.. include:: /includes/fact-environments-atlas-only.rst
+
+.. include:: /includes/fact-environments-atlas-support-all.rst
+
+.. include:: /includes/fact-environments-onprem-only.rst
 
-.. include:: /includes/fact-compatibility.rst
 
 Syntax
 ------

diff --git a/source/reference/method/db.getProfilingStatus.txt b/source/reference/method/db.getProfilingStatus.txt
@@ -27,3 +27,14 @@ db.getProfilingStatus()
              - the :method:`db.setProfilingLevel()` shell method, or
 
              - the :setting:`operationProfiling.filter` configuration file option.
+
+Compatibility
+-------------
+
+This method is available in deployments hosted in the following environments: 
+
+.. include:: /includes/fact-environments-atlas-only.rst
+
+.. include:: /includes/fact-environments-atlas-support-no-free.rst
+
+.. include:: /includes/fact-environments-onprem-only.rst
diff --git a/source/reference/method/db.getReplicationInfo.txt b/source/reference/method/db.getReplicationInfo.txt
@@ -19,6 +19,18 @@ Definition
    polled from the :term:`oplog`. Use this output when diagnosing
    issues with replication.
 
+Compatibility
+-------------
+
+This method is available in deployments hosted in the following environments: 
+
+.. include:: /includes/fact-environments-atlas-only.rst
+
+.. include:: /includes/fact-environments-atlas-support-all.rst
+
+.. include:: /includes/fact-environments-onprem-only.rst
+
+
 Output
 ------
 

diff --git a/source/reference/method/db.getSiblingDB.txt b/source/reference/method/db.getSiblingDB.txt
@@ -32,6 +32,18 @@ Definition
    Used to return another database without modifying the
    ``db`` variable in the shell environment.
 
+Compatibility
+-------------
+
+This method is available in deployments hosted in the following environments: 
+
+.. include:: /includes/fact-environments-atlas-only.rst
+
+.. include:: /includes/fact-environments-atlas-support-all.rst
+
+.. include:: /includes/fact-environments-onprem-only.rst
+
+
 Example
 -------
 

diff --git a/source/reference/method/db.hello.txt b/source/reference/method/db.hello.txt
@@ -30,12 +30,10 @@ db.hello()
 Compatibility
 -------------
 
-.. |command| replace:: method
-
-This method is available in deployments hosted in the following environments:
+This method is available in deployments hosted in the following environments: 
 
 .. include:: /includes/fact-environments-atlas-only.rst
 
 .. include:: /includes/fact-environments-atlas-support-all.rst
 
-.. include:: /includes/fact-environments-onprem-only.rst 
+.. include:: /includes/fact-environments-onprem-only.rst
diff --git a/source/reference/method/db.help.txt b/source/reference/method/db.help.txt
@@ -13,3 +13,14 @@ db.help()
 .. method:: db.help()
 
    :returns: Text output listing common methods on the ``db`` object.
+
+Compatibility
+-------------
+
+This method is available in deployments hosted in the following environments: 
+
+.. include:: /includes/fact-environments-atlas-only.rst
+
+.. include:: /includes/fact-environments-atlas-support-all.rst
+
+.. include:: /includes/fact-environments-onprem-only.rst
diff --git a/source/reference/method/db.hostInfo.txt b/source/reference/method/db.hostInfo.txt
@@ -59,12 +59,11 @@ db.hostInfo()
 Compatibility
 -------------
 
-.. |command| replace:: method
-
-This method is available in deployments hosted in the following environments:
+This method is available in deployments hosted in the following environments: 
 
 .. include:: /includes/fact-environments-atlas-only.rst
 
 .. include:: /includes/fact-environments-atlas-support-no-free.rst
 
 .. include:: /includes/fact-environments-onprem-only.rst
+
diff --git a/source/reference/method/db.killOp.txt b/source/reference/method/db.killOp.txt
@@ -49,16 +49,13 @@ Description
 Compatibility
 -------------
 
-.. |command| replace:: method
-
 This method is available in deployments hosted in the following environments: 
 
-.. include:: /includes/fact-environments-atlas-only.rst
-
-.. include:: /includes/fact-environments-atlas-support-limited-free-and-m10.rst
+.. include:: /includes/fact-environments-no-atlas-support.rst
 
 .. include:: /includes/fact-environments-onprem-only.rst
 
+
 Sharded Cluster
 ---------------
 

diff --git a/source/reference/method/db.listCommands.txt b/source/reference/method/db.listCommands.txt
@@ -20,12 +20,11 @@ db.listCommands()
 Compatibility
 -------------
 
-.. |command| replace:: method
-
-This method is available in deployments hosted in the following environments:
+This method is available in deployments hosted in the following environments: 
 
 .. include:: /includes/fact-environments-atlas-only.rst
 
 .. include:: /includes/fact-environments-atlas-support-all.rst
 
 .. include:: /includes/fact-environments-onprem-only.rst
+
diff --git a/source/reference/method/db.logout.txt b/source/reference/method/db.logout.txt
@@ -44,12 +44,11 @@ db.logout()
 Compatibility
 -------------
 
-.. |command| replace:: method
-
-This method is available in deployments hosted in the following environments:
+This method is available in deployments hosted in the following environments: 
 
 .. include:: /includes/fact-environments-atlas-only.rst
 
 .. include:: /includes/fact-environments-atlas-support-all.rst
 
 .. include:: /includes/fact-environments-onprem-only.rst
+