DOCSP-35872 Atlas support for Sharding methods (#6151)

pierwill · web-flow · commit 10e9f6d5158b · 2024-02-08T15:27:24.000-06:00
* DOCSP-35872 Atlas support for sharding methods * Fix build error * Add two more methods * fix typos --------- Co-authored-by: pierwill <pierwill@users.noreply.github.com>
diff --git a/source/includes/fact-environments-atlas-support-no-free-or-m10.rst b/source/includes/fact-environments-atlas-support-no-free-or-m10.rst
@@ -1,4 +1,4 @@
 .. note::
 
-   This |command| has *limited support* in M0, M2, M5, and M10 clusters.
+   This command has *limited support* in M0, M2, M5, and M10 clusters.
    For more information, see :atlas:`Unsupported Commands </unsupported-commands>`.
diff --git a/source/reference/method/db.checkMetadataConsistency.txt b/source/reference/method/db.checkMetadataConsistency.txt
@@ -39,6 +39,18 @@ Definition
       which contains a document for each inconsistency found in 
       the sharding metadata.
 
+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-onprem-only.rst
 
 Syntax
 -------
diff --git a/source/reference/method/db.collection.analyzeShardKey.txt b/source/reference/method/db.collection.analyzeShardKey.txt
@@ -22,6 +22,20 @@ Definition
    can use :dbcommand:`configureQueryAnalyzer` to configure query
    sampling on a collection.
 
+
+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-onprem-only.rst
+
 Syntax
 ------
 
diff --git a/source/reference/method/db.collection.checkMetadataConsistency.txt b/source/reference/method/db.collection.checkMetadataConsistency.txt
@@ -35,6 +35,20 @@ Definition
       the sharding metadata.
 
 
+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-onprem-only.rst
+
+
 Syntax
 -------
 
diff --git a/source/reference/method/db.collection.configureQueryAnalyzer.txt b/source/reference/method/db.collection.configureQueryAnalyzer.txt
@@ -29,6 +29,19 @@ Definition
       details, see :ref:`<cqa-output>`.
 
 
+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-onprem-only.rst
+
 Syntax
 ------
 
diff --git a/source/reference/method/db.collection.getShardVersion.txt b/source/reference/method/db.collection.getShardVersion.txt
@@ -21,3 +21,16 @@ db.collection.getShardVersion()
    with a sharded cluster.
 
    For internal and diagnostic use only.
+
+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-or-serverless.rst
+
+.. include:: /includes/fact-environments-onprem-only.rst
diff --git a/source/reference/method/sh.abortReshardCollection.txt b/source/reference/method/sh.abortReshardCollection.txt
@@ -32,6 +32,18 @@ Definition
    .. |dbcommand| replace:: :dbcommand:`abortReshardCollection` command
    .. include:: /includes/fact-mongosh-shell-method-alt.rst
 
+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-onprem-only.rst
 
 Syntax
 ------
diff --git a/source/reference/method/sh.addShard.txt b/source/reference/method/sh.addShard.txt
@@ -67,6 +67,19 @@ Definition
 
    .. include:: /includes/extracts/mongos-operations-wc-add-shard.rst
 
+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-serverless.rst
+
+.. include:: /includes/fact-environments-onprem-only.rst
+
 Considerations
 --------------
 
diff --git a/source/reference/method/sh.addShardToZone.txt b/source/reference/method/sh.addShardToZone.txt
@@ -57,6 +57,20 @@ Definition
    Only issue :method:`sh.addShardToZone()` when connected to a
    :binary:`~bin.mongos` instance.
 
+
+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-serverless.rst
+
+.. include:: /includes/fact-environments-onprem-only.rst
+
 Behavior
 --------
 
diff --git a/source/reference/method/sh.balancerCollectionStatus.txt b/source/reference/method/sh.balancerCollectionStatus.txt
@@ -26,6 +26,20 @@ Definition
    .. |dbcommand| replace:: :dbcommand:`balancerCollectionStatus` command
    .. include:: /includes/fact-mongosh-shell-method-alt.rst
 
+
+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-serverless.rst
+
+.. include:: /includes/fact-environments-onprem-only.rst
+
 Syntax
 ------
 
diff --git a/source/reference/method/sh.checkMetadataConsistency.txt b/source/reference/method/sh.checkMetadataConsistency.txt
@@ -36,6 +36,18 @@ Definition
       which contains a document for each inconsistency found in 
       the sharding metadata.
 
+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-onprem-only.rst
 
 Syntax
 -------
diff --git a/source/reference/method/sh.enableSharding.txt b/source/reference/method/sh.enableSharding.txt
@@ -31,6 +31,19 @@ Definition
    .. include:: /includes/fact-mongosh-shell-method-alt.rst
 
 
+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-serverless.rst
+
+.. include:: /includes/fact-environments-onprem-only.rst
+
 Syntax
 ------
 
diff --git a/source/reference/method/sh.moveChunk.txt b/source/reference/method/sh.moveChunk.txt
@@ -91,6 +91,20 @@ Definition
    - :doc:`/sharding`, and :ref:`chunk migration
      <sharding-chunk-migration>`
 
+
+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-serverless.rst
+
+.. include:: /includes/fact-environments-onprem-only.rst
+
 Example
 -------
 
diff --git a/source/reference/method/sh.removeShardFromZone.txt b/source/reference/method/sh.removeShardFromZone.txt
@@ -56,6 +56,19 @@ Definition
    Only issue :method:`sh.removeShardFromZone()` when connected to a
    :binary:`~bin.mongos` instance.
 
+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-serverless.rst
+
+.. include:: /includes/fact-environments-onprem-only.rst
+
 Behavior
 --------
 
diff --git a/source/reference/method/sh.reshardCollection.txt b/source/reference/method/sh.reshardCollection.txt
@@ -111,6 +111,20 @@ The ``options`` field supports the following fields:
              ...
           ]
 
+
+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-onprem-only.rst
+
 .. _resharding-process-details:
 
 Resharding Process
diff --git a/source/reference/method/sh.updateZoneKeyRange.txt b/source/reference/method/sh.updateZoneKeyRange.txt
@@ -88,6 +88,20 @@ Definition
    Only issue :method:`sh.updateZoneKeyRange()` when connected to a
    :binary:`~bin.mongos` instance.
 
+
+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-serverless.rst
+
+.. include:: /includes/fact-environments-onprem-only.rst
+
 Behavior
 --------
 
