Skip to content

Commit 36576f3

Browse files
pierwillpierwill
authored
DOCSP-34782 Atlas Support for Administration Commands (#5745)
1 parent 37e6216 commit 36576f3

34 files changed

+372
-5
lines changed

‎source/includes/fact-environments-atlas-support-limited-free-and-m10.rst

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

‎source/reference/command/cloneCollectionAsCapped.txt

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,16 @@ Definition
2020
within the same database. The operation does not affect the
2121
original non-capped collection.
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-free-or-serverless.rst
31+
32+
.. include:: /includes/fact-environments-onprem-only.rst
2333

2434
Syntax
2535
------

‎source/reference/command/collMod.txt

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,17 @@ Definition
3232
views. For discussion of on-demand materialized views, see
3333
:pipeline:`$merge` instead.
3434

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

‎source/reference/command/compact.txt

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,17 @@ Definition
2121
:ref:`WiredTiger <storage-wiredtiger>` databases, this command
2222
releases unneeded disk space to the operating system.
2323

24+
Compatibility
25+
-------------
26+
27+
This command is available in deployments hosted in the following environments:
28+
29+
.. include:: /includes/fact-environments-atlas-only.rst
30+
31+
.. include:: /includes/fact-environments-atlas-support-no-free.rst
32+
33+
.. include:: /includes/fact-environments-onprem-only.rst
34+
2435
Syntax
2536
------
2637

‎source/reference/command/compactStructuredEncryptionData.txt

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,17 @@ Definition
2020
Compacts documents specified in the metadata collections and deletes
2121
redundant documents.
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-all.rst
31+
32+
.. include:: /includes/fact-environments-onprem-only.rst
33+
2334
Syntax
2435
------
2536

‎source/reference/command/convertToCapped.txt

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,17 @@ Definition
2525
non-capped collection to a :term:`capped collection` within the same
2626
database.
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
38+
2839
Syntax
2940
------
3041

‎source/reference/command/create.txt

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,17 @@ Definition
2323
views. For discussion of on-demand materialized views, see
2424
:pipeline:`$merge` instead.
2525

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

‎source/reference/command/createIndexes.txt

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,16 @@ Definition
2121
:method:`db.collection.createIndexes()` helper methods.
2222
.. include:: /includes/fact-dbcommand-tip
2323

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

2535
Syntax
2636
------

‎source/reference/command/currentOp.txt

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,18 @@ Definition
2626

2727
.. include:: /includes/fact-currentOp-aggregation-stage.rst
2828

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

‎source/reference/command/drop.txt

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,18 @@ Definition
2121
.. |method| replace:: :method:`~db.collection.drop` helper method
2222
.. include:: /includes/fact-dbcommand-tip
2323

24+
Compatibility
25+
-------------
26+
27+
This command is available in deployments hosted in the following environments:
28+
29+
.. include:: /includes/fact-environments-atlas-only.rst
30+
31+
.. include:: /includes/fact-environments-atlas-support-all.rst
32+
33+
.. include:: /includes/fact-environments-onprem-only.rst
34+
35+
2436
Syntax
2537
------
2638

‎source/reference/command/dropConnections.txt

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,17 @@ Definition
2222
connections to the specified hosts. The :dbcommand:`dropConnections`
2323
must be run against the ``admin`` database.
2424

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

‎source/reference/command/dropDatabase.txt

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,18 @@ Definition
1818
The :dbcommand:`dropDatabase` command drops the current database, deleting
1919
the associated data files.
2020

21+
Compatibility
22+
-------------
23+
24+
This command is available in deployments hosted in the following environments:
25+
26+
.. include:: /includes/fact-environments-atlas-only.rst
27+
28+
.. include:: /includes/fact-environments-atlas-support-all.rst
29+
30+
.. include:: /includes/fact-environments-onprem-only.rst
31+
32+
2133
Syntax
2234
------
2335

‎source/reference/command/dropIndexes.txt

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,17 @@ Definition
2525
:method:`db.collection.dropIndexes()` helper methods.
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-all.rst
36+
37+
.. include:: /includes/fact-environments-onprem-only.rst
38+
2839
Syntax
2940
------
3041

‎source/reference/command/filemd5.txt

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,17 @@ Definition
2121
The command takes the ``files_id`` of the file in question and the
2222
name of the GridFS root collection as arguments.
2323

24+
Compatibility
25+
-------------
26+
27+
This command is available in deployments hosted in the following environments:
28+
29+
.. include:: /includes/fact-environments-atlas-only.rst
30+
31+
.. include:: /includes/fact-environments-atlas-support-all.rst
32+
33+
.. include:: /includes/fact-environments-onprem-only.rst
34+
2435
Syntax
2536
------
2637

‎source/reference/command/fsync.txt

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,8 +42,19 @@ Definition
4242

4343
.. |method| replace:: :method:`db.fsyncLock` helper method
4444
.. include:: /includes/fact-dbcommand-tip
45-
46-
45+
46+
47+
Compatibility
48+
-------------
49+
50+
This command is available in deployments hosted in the following environments:
51+
52+
.. include:: /includes/fact-environments-atlas-only.rst
53+
54+
.. include:: /includes/fact-environments-atlas-support-no-free-or-serverless.rst
55+
56+
.. include:: /includes/fact-environments-onprem-only.rst
57+
4758
Syntax
4859
------
4960

‎source/reference/command/fsyncUnlock.txt

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,18 @@ Definition
3838

3939
.. |method| replace:: :method:`db.fsyncUnlock` helper method
4040
.. include:: /includes/fact-dbcommand-tip
41-
41+
42+
Compatibility
43+
-------------
44+
45+
This command is available in deployments hosted in the following environments:
46+
47+
.. include:: /includes/fact-environments-atlas-only.rst
48+
49+
.. include:: /includes/fact-environments-atlas-support-no-free.rst
50+
51+
.. include:: /includes/fact-environments-onprem-only.rst
52+
4253
Syntax
4354
------
4455

‎source/reference/command/getClusterParameter.txt

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,17 @@ Definition
2424

2525
.. include:: /includes/fact-getClusterParameter-availability.rst
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/getDefaultRWConcern.txt

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,17 @@ Definition
2323
- For sharded clusters, issue the :dbcommand:`getDefaultRWConcern`
2424
on a :binary:`~bin.mongos`.
2525

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

‎source/reference/command/getParameter.txt

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,18 @@ Definition
1919
retrieving the values of parameters. Use the :method:`db.adminCommand(
2020
{ command } )<db.adminCommand()>` method to run the
2121
:dbcommand:`getParameter` command in the ``admin`` database.
22-
22+
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-limited-free.rst
31+
32+
.. include:: /includes/fact-environments-onprem-only.rst
33+
2334
Syntax
2435
------
2536

‎source/reference/command/killCursors.txt

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,17 @@ Definition
3131

3232
.. include:: /includes/fact-dbcommand.rst
3333

34+
Compatibility
35+
-------------
36+
37+
This command is available in deployments hosted in the following environments:
38+
39+
.. include:: /includes/fact-environments-atlas-only.rst
40+
41+
.. include:: /includes/fact-environments-atlas-support-all.rst
42+
43+
.. include:: /includes/fact-environments-onprem-only.rst
44+
3445
Syntax
3546
------
3647

‎source/reference/command/killOp.txt

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,17 @@ Definition
2727

2828
.. include:: /includes/fact-dbcommand.rst
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-limited-free-and-m10.rst
38+
39+
.. include:: /includes/fact-environments-onprem-only.rst
40+
3041
Syntax
3142
------
3243

‎source/reference/command/listCollections.txt

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,17 @@ Definition
2525
:binary:`~bin.mongosh` provides the :method:`db.getCollectionInfos()`
2626
and the :method:`db.getCollectionNames()` helper methods.
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-all.rst
36+
37+
.. include:: /includes/fact-environments-onprem-only.rst
38+
2839
Syntax
2940
------
3041

0 commit comments

Comments
 (0)