DOCSP-42214-mongosh-connection-atlas-compatibility (#10316)

* DOCSP-42214-mongosh-connection-atlas-compatibility * DOCSP-42214-mongosh-connection-atlas-compatibility
mongodb · Nov 20, 2024 · 583eb82 · 583eb82
1 parent fc89b5e
commit 583eb82
Show file tree

Hide file tree

Showing 14 changed files with 126 additions and 10 deletions.
diff --git a/source/reference/method/Mongo.getDB.txt b/source/reference/method/Mongo.getDB.txt
@@ -36,10 +36,15 @@ Description
         - string
 
         - The name of the database to access.
-
-
-
+
+Compatibility
+-------------
+
+This method is available in deployments hosted in the following environments: 
+
+.. include:: /includes/fact-environments-atlas-only.rst
 
+.. include:: /includes/fact-environments-onprem-only.rst
 
 Example
 -------

diff --git a/source/reference/method/Mongo.getDBNames.txt b/source/reference/method/Mongo.getDBNames.txt
@@ -20,6 +20,14 @@ Description
 
    The :method:`Mongo.getDBNames()` method doesn't take any parameters.
 
+Compatibility
+-------------
+
+This method is available in deployments hosted in the following environments: 
+
+.. include:: /includes/fact-environments-atlas-only.rst
+
+.. include:: /includes/fact-environments-onprem-only.rst
 
 Examples
 --------

diff --git a/source/reference/method/Mongo.getDBs.txt b/source/reference/method/Mongo.getDBs.txt
@@ -21,6 +21,14 @@ Description
 
    The :method:`Mongo.getDBs()` method doesn't take any parameters.
 
+Compatibility
+-------------
+
+This method is available in deployments hosted in the following environments: 
+
+.. include:: /includes/fact-environments-atlas-only.rst
+
+.. include:: /includes/fact-environments-onprem-only.rst
 
 Example
 -------

diff --git a/source/reference/method/Mongo.getReadPrefMode.txt b/source/reference/method/Mongo.getReadPrefMode.txt
@@ -40,9 +40,18 @@ Mongo.getReadPrefMode()
    - :readmode:`secondaryPreferred`
    - :readmode:`nearest`
 
-   .. seealso::
+Compatibility
+-------------
 
-      - :doc:`/core/read-preference`
-      - :method:`~cursor.readPref()`
-      - :method:`~Mongo.setReadPref()`
-      - :method:`~Mongo.getReadPrefTagSet()`
+This method is available in deployments hosted in the following environments: 
+
+.. include:: /includes/fact-environments-atlas-only.rst
+
+.. include:: /includes/fact-environments-onprem-only.rst
+
+.. seealso::
+
+   - :doc:`/core/read-preference`
+   - :method:`~cursor.readPref()`
+   - :method:`~Mongo.setReadPref()`
+   - :method:`~Mongo.getReadPrefTagSet()`
diff --git a/source/reference/method/Mongo.getReadPrefTagSet.txt b/source/reference/method/Mongo.getReadPrefTagSet.txt
@@ -31,6 +31,15 @@ Mongo.getReadPrefTagSet()
 
       printjson(db.getMongo().getReadPrefTagSet());
 
+Compatibility
+-------------
+
+This method is available in deployments hosted in the following environments: 
+
+.. include:: /includes/fact-environments-atlas-only.rst
+
+.. include:: /includes/fact-environments-onprem-only.rst
+
    .. seealso::
 
       - :doc:`/core/read-preference`

diff --git a/source/reference/method/Mongo.getWriteConcern.txt b/source/reference/method/Mongo.getWriteConcern.txt
@@ -21,6 +21,15 @@ Definition
    See the :ref:`write-concern` for an introduction to write concerns
    in MongoDB.
 
+Compatibility
+-------------
+
+This method is available in deployments hosted in the following environments: 
+
+.. include:: /includes/fact-environments-atlas-only.rst
+
+.. include:: /includes/fact-environments-onprem-only.rst
+
 Syntax
 ------
 

diff --git a/source/reference/method/Mongo.setCausalConsistency.txt b/source/reference/method/Mongo.setCausalConsistency.txt
@@ -47,6 +47,15 @@ Definition
 
         conn.setCausalConsistency(false);
 
+Compatibility
+-------------
+
+This method is available in deployments hosted in the following environments: 
+
+.. include:: /includes/fact-environments-atlas-only.rst
+
+.. include:: /includes/fact-environments-onprem-only.rst
+
 Example
 -------
 

diff --git a/source/reference/method/Mongo.setReadPref.txt b/source/reference/method/Mongo.setReadPref.txt
@@ -102,6 +102,15 @@ Parameters
 :ref:`replica-set-read-preference-max-staleness` option for read
 preference.
 
+Compatibility
+-------------
+
+This method is available in deployments hosted in the following environments: 
+
+.. include:: /includes/fact-environments-atlas-only.rst
+
+.. include:: /includes/fact-environments-onprem-only.rst
+
 Behavior
 --------
 

diff --git a/source/reference/method/Mongo.setWriteConcern.txt b/source/reference/method/Mongo.setWriteConcern.txt
@@ -21,6 +21,15 @@ Definition
    See the :ref:`write-concern` for an introduction to write concerns
    in MongoDB.
 
+Compatibility
+-------------
+
+This method is available in deployments hosted in the following environments: 
+
+.. include:: /includes/fact-environments-atlas-only.rst
+
+.. include:: /includes/fact-environments-onprem-only.rst
+
 Syntax
 ------
 

diff --git a/source/reference/method/Mongo.txt b/source/reference/method/Mongo.txt
@@ -74,6 +74,15 @@ Description
 
    :method:`Mongo.getDB()` and :method:`db.getMongo()`
 
+Compatibility
+-------------
+
+This method is available in deployments hosted in the following environments: 
+
+.. include:: /includes/fact-environments-atlas-only.rst
+
+.. include:: /includes/fact-environments-onprem-only.rst
+
 .. _{+auto-encrypt-options+}:
 
 ``{+title-auto-encrypt-options+}``

diff --git a/source/reference/method/Mongo.watch.txt b/source/reference/method/Mongo.watch.txt
@@ -167,6 +167,15 @@ Definition
 
       :method:`db.collection.watch()` and :method:`db.watch()`
 
+Compatibility
+-------------
+
+This method is available in deployments hosted in the following environments: 
+
+.. include:: /includes/fact-environments-atlas-only.rst
+
+.. include:: /includes/fact-environments-onprem-only.rst
+
 Availability
 ------------
 

diff --git a/source/reference/method/Session.startTransaction.txt b/source/reference/method/Session.startTransaction.txt
@@ -83,6 +83,15 @@ Definition
           For MongoDB Drivers, transactions use the client-level write
           concern as the default.
 
+Compatibility
+-------------
+
+This method is available in deployments hosted in the following environments: 
+
+.. include:: /includes/fact-environments-atlas-only.rst
+
+.. include:: /includes/fact-environments-onprem-only.rst
+
 Behavior
 --------
 

diff --git a/source/reference/method/SessionOptions.txt b/source/reference/method/SessionOptions.txt
@@ -92,3 +92,12 @@ Definition
 Verify which options are enabled for the session by running
 ``Session.getOptions()``.
 
+Compatibility
+-------------
+
+This method is available in deployments hosted in the following environments: 
+
+.. include:: /includes/fact-environments-atlas-only.rst
+
+.. include:: /includes/fact-environments-onprem-only.rst
+
diff --git a/source/reference/method/connect.txt b/source/reference/method/connect.txt
@@ -59,9 +59,14 @@ Description
         - Optional unless the ``user`` parameter is specified. Specifies the
           password for the ``user``.
 
-
-
+Compatibility
+-------------
+
+This method is available in deployments hosted in the following environments: 
+
+.. include:: /includes/fact-environments-atlas-only.rst
 
+.. include:: /includes/fact-environments-onprem-only.rst
 
 Example
 -------