Skip to content

Commit aadf07b

Browse files
pierwillajhuh-mdb
andauthored
DOCSP-34780 Add info on Atlas Support for sharding commands (#5691)
Co-authored-by: Alison Huh <[email protected]>
1 parent 615cf46 commit aadf07b

40 files changed

+442
-2
lines changed
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
.. note::
2+
3+
This command is *not supported* in M0, M2, and M5 clusters or in serverless instances.
4+
For more information, see :atlas:`Unsupported Commands </unsupported-commands>`.
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
.. note::
2+
3+
This command is *not supported* in M10 clusters or serverless instances.
4+
For more information, see :atlas:`Unsupported Commands </unsupported-commands>`.

source/reference/command/abortReshardCollection.txt

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,16 @@ Definition
3434
helper method
3535
.. include:: /includes/fact-dbcommand-tip
3636

37+
Compatibility
38+
-------------
39+
40+
This command is available in deployments hosted in the following environments:
41+
42+
.. include:: /includes/fact-environments-atlas-only.rst
43+
44+
.. include:: /includes/fact-environments-atlas-support-all.rst
45+
46+
.. include:: /includes/fact-environments-onprem-only.rst
3747

3848
Syntax
3949
------

source/reference/command/addShard.txt

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,16 @@ Definition
2020
.. |method| replace:: :method:`sh.addShard` helper method
2121
.. include:: /includes/fact-dbcommand-tip
2222

23+
Compatibility
24+
-------------
25+
26+
This command is available in deployments hosted in the following environments:
27+
28+
.. include:: /includes/fact-environments-atlas-only.rst
29+
30+
.. include:: /includes/fact-environments-atlas-support-no-serverless.rst
31+
32+
.. include:: /includes/fact-environments-onprem-only.rst
2333

2434
Syntax
2535
------

source/reference/command/addShardToZone.txt

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,18 @@ Definition
2727
You can only run :dbcommand:`addShardToZone` on the ``admin`` database
2828
from a :binary:`~bin.mongos` instance.
2929

30+
Compatibility
31+
-------------
32+
33+
This command is available in deployments hosted in the following environments:
34+
35+
.. include:: /includes/fact-environments-atlas-only.rst
36+
37+
.. include:: /includes/fact-environments-atlas-support-no-serverless.rst
38+
39+
.. include:: /includes/fact-environments-onprem-only.rst
40+
41+
3042
Syntax
3143
------
3244

source/reference/command/analyzeShardKey.txt

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,17 @@ Definition
2424
can use :dbcommand:`configureQueryAnalyzer` to configure query
2525
sampling on a collection.
2626

27+
Compatibility
28+
-------------
29+
30+
This command is available in deployments hosted in the following environments:
31+
32+
.. include:: /includes/fact-environments-atlas-only.rst
33+
34+
.. include:: /includes/fact-environments-atlas-support-all.rst
35+
36+
.. include:: /includes/fact-environments-onprem-only.rst
37+
2738
Syntax
2839
------
2940

source/reference/command/balancerCollectionStatus.txt

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,17 @@ Definition
3030
helper method
3131
.. include:: /includes/fact-dbcommand-tip
3232

33+
Compatibility
34+
-------------
35+
36+
This command is available in deployments hosted in the following environments:
37+
38+
.. include:: /includes/fact-environments-atlas-only.rst
39+
40+
.. include:: /includes/fact-environments-atlas-support-no-serverless.rst
41+
42+
.. include:: /includes/fact-environments-onprem-only.rst
43+
3344

3445
Syntax
3546
------

source/reference/command/balancerStart.txt

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,18 @@ Definition
3030
when the balancer is enabled, you can use
3131
:method:`sh.disableAutoSplit()`.
3232

33+
Compatibility
34+
-------------
35+
36+
This command is available in deployments hosted in the following environments:
37+
38+
.. include:: /includes/fact-environments-atlas-only.rst
39+
40+
.. include:: /includes/fact-environments-atlas-support-no-serverless.rst
41+
42+
.. include:: /includes/fact-environments-onprem-only.rst
43+
44+
3345
Syntax
3446
------
3547

source/reference/command/balancerStatus.txt

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,16 @@ Definition
2525
helper method
2626
.. include:: /includes/fact-dbcommand-tip
2727

28+
Compatibility
29+
-------------
30+
31+
This command is available in deployments hosted in the following environments:
32+
33+
.. include:: /includes/fact-environments-atlas-only.rst
34+
35+
.. include:: /includes/fact-environments-atlas-support-no-serverless.rst
36+
37+
.. include:: /includes/fact-environments-onprem-only.rst
2838

2939
Syntax
3040
------

source/reference/command/balancerStop.txt

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,17 @@ Definition
3333
auto-splitting for the sharded cluster. To enable auto-splitting when
3434
the balancer is disabled, you can use :method:`sh.enableAutoSplit()`.
3535

36+
Compatibility
37+
-------------
38+
39+
This command is available in deployments hosted in the following environments:
40+
41+
.. include:: /includes/fact-environments-atlas-only.rst
42+
43+
.. include:: /includes/fact-environments-atlas-support-no-serverless.rst
44+
45+
.. include:: /includes/fact-environments-onprem-only.rst
46+
3647
Syntax
3748
------
3849

0 commit comments

Comments
 (0)