Skip to content

Commit 37e6216

Browse files
authored
DOCSP-34783 Atlas Support for Diagnostics Commands (#5750)
1 parent 75c582b commit 37e6216

24 files changed

+266
-0
lines changed

source/reference/command/buildInfo.txt

+11
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,17 @@ Definition
1919
returns a build summary for the current
2020
:binary:`~bin.mongod`.
2121

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

source/reference/command/collStats.txt

+11
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,17 @@ Definition
4141

4242
.. include:: /includes/fact-dbcommand.rst
4343

44+
Compatibility
45+
-------------
46+
47+
This command is available in deployments hosted in the following environments:
48+
49+
.. include:: /includes/fact-environments-atlas-only.rst
50+
51+
.. include:: /includes/fact-environments-atlas-support-all.rst
52+
53+
.. include:: /includes/fact-environments-onprem-only.rst
54+
4455
Syntax
4556
------
4657

source/reference/command/connPoolStats.txt

+11
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,17 @@ Definition
2626

2727
.. include:: /includes/note-conn-pool-stats.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+
2940
Syntax
3041
------
3142

source/reference/command/connectionStatus.txt

+11
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,17 @@ Definition
1818
Returns information about the current connection, specifically the
1919
state of authenticated users and their available permissions.
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+
2132
Syntax
2233
------
2334

source/reference/command/dataSize.txt

+12
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,18 @@ Definition
1818
The :dbcommand:`dataSize` command returns the size in bytes for
1919
the specified data.
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-no-free.rst
29+
30+
.. include:: /includes/fact-environments-onprem-only.rst
31+
32+
2133
Syntax
2234
------
2335

source/reference/command/dbHash.txt

+11
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,17 @@ Definition
2525
The :dbcommand:`dbHash` command obtains a shared (S) lock on the
2626
database, which prevents writes until the command completes.
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-free-or-serverless.rst
36+
37+
.. include:: /includes/fact-environments-onprem-only.rst
38+
2839
Syntax
2940
------
3041

source/reference/command/dbStats.txt

+12
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,18 @@ Definition
1818
The :dbcommand:`dbStats` command returns storage statistics for a
1919
given database.
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-limited-free.rst
29+
30+
.. include:: /includes/fact-environments-onprem-only.rst
31+
32+
2133
Syntax
2234
------
2335

source/reference/command/driverOIDTest.txt

+11
Original file line numberDiff line numberDiff line change
@@ -15,3 +15,14 @@ driverOIDTest
1515
:dbcommand:`driverOIDTest` is an internal command.
1616

1717
.. slave-ok
18+
19+
Compatibility
20+
-------------
21+
22+
This command is available in deployments hosted in the following environments:
23+
24+
.. include:: /includes/fact-environments-atlas-only.rst
25+
26+
.. include:: /includes/fact-environments-atlas-support-all.rst
27+
28+
.. include:: /includes/fact-environments-onprem-only.rst

source/reference/command/explain.txt

+11
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,17 @@ Definition
2626

2727
.. include:: /includes/fact-dbcommand-tip
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+
2940
Syntax
3041
------
3142

source/reference/command/features.txt

+11
Original file line numberDiff line numberDiff line change
@@ -16,3 +16,14 @@ features
1616
feature settings.
1717

1818
.. slave-ok
19+
20+
Compatibility
21+
-------------
22+
23+
This command is available in deployments hosted in the following environments:
24+
25+
.. include:: /includes/fact-environments-atlas-only.rst
26+
27+
.. include:: /includes/fact-environments-atlas-support-all.rst
28+
29+
.. include:: /includes/fact-environments-onprem-only.rst

source/reference/command/getCmdLineOpts.txt

+11
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,17 @@ Definition
2020
:binary:`~bin.mongod` or :binary:`~bin.mongos`. Run
2121
:dbcommand:`getCmdLineOpts` in the ``admin`` database.
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/getLog.txt

+11
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,17 @@ Definition
2626
</reference/mongodb-extended-json>` format. Previously, log data
2727
was returned as plaintext.
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+
2940
Syntax
3041
------
3142

source/reference/command/hostInfo.txt

+11
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,17 @@ Definition
2323
You must run the :dbcommand:`hostInfo` command, which takes no
2424
arguments, against the ``admin`` database.
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-no-free.rst
34+
35+
.. include:: /includes/fact-environments-onprem-only.rst
36+
2637
Syntax
2738
------
2839

source/reference/command/isSelf.txt

+11
Original file line numberDiff line numberDiff line change
@@ -15,3 +15,14 @@ isSelf
1515
:dbcommand:`_isSelf` is an internal command.
1616

1717
.. slave-ok
18+
19+
Compatibility
20+
-------------
21+
22+
This command is available in deployments hosted in the following environments:
23+
24+
.. include:: /includes/fact-environments-atlas-only.rst
25+
26+
.. include:: /includes/fact-environments-atlas-support-all.rst
27+
28+
.. include:: /includes/fact-environments-onprem-only.rst

source/reference/command/listCommands.txt

+11
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,17 @@ Definition
1919
database commands implemented for the current :binary:`~bin.mongod` or
2020
:binary:`~bin.mongos` instance.
2121

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

source/reference/command/lockInfo.txt

+11
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,17 @@ Definition
1919
pending. :dbcommand:`lockInfo` is an internal command available on
2020
:binary:`~bin.mongod` instances only.
2121

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

source/reference/command/netstat.txt

+11
Original file line numberDiff line numberDiff line change
@@ -14,3 +14,14 @@ netstat
1414

1515
:dbcommand:`netstat` is an internal command that is only
1616
available on :binary:`~bin.mongos` instances.
17+
18+
Compatibility
19+
-------------
20+
21+
This command is available in deployments hosted in the following environments:
22+
23+
.. include:: /includes/fact-environments-atlas-only.rst
24+
25+
.. include:: /includes/fact-environments-atlas-support-all.rst
26+
27+
.. include:: /includes/fact-environments-onprem-only.rst

source/reference/command/ping.txt

+11
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,17 @@ Definition
1919
server is responding to commands. This command will return
2020
immediately even if the server is write-locked:
2121

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

source/reference/command/profile.txt

+11
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,17 @@ Definition
6767

6868
.. include:: /includes/warning-profiler-performance.rst
6969

70+
Compatibility
71+
-------------
72+
73+
This command is available in deployments hosted in the following environments:
74+
75+
.. include:: /includes/fact-environments-atlas-only.rst
76+
77+
.. include:: /includes/fact-environments-atlas-support-all.rst
78+
79+
.. include:: /includes/fact-environments-onprem-only.rst
80+
7081
Syntax
7182
------
7283

source/reference/command/serverStatus.txt

+11
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,17 @@ Definition
2525
applications can run this command at a regular interval to
2626
collect statistics about the instance.
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/shardConnPoolStats.txt

+11
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,17 @@ Definition
4040
MongoDB returns the connection to the connection pool after every
4141
operation.
4242

43+
Compatibility
44+
-------------
45+
46+
This command is available in deployments hosted in the following environments:
47+
48+
.. include:: /includes/fact-environments-atlas-only.rst
49+
50+
.. include:: /includes/fact-environments-atlas-support-no-serverless.rst
51+
52+
.. include:: /includes/fact-environments-onprem-only.rst
53+
4354
Output
4455
------
4556

source/reference/command/top.txt

+11
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,17 @@ Redaction
3838
When using :ref:`Queryable Encryption <qe-manual-feature-qe>`, the
3939
``top`` command only returns the collection name.
4040

41+
Compatibility
42+
-------------
43+
44+
This command is available in deployments hosted in the following environments:
45+
46+
.. include:: /includes/fact-environments-atlas-only.rst
47+
48+
.. include:: /includes/fact-environments-atlas-support-no-serverless.rst
49+
50+
.. include:: /includes/fact-environments-onprem-only.rst
51+
4152
Syntax
4253
------
4354

0 commit comments

Comments
 (0)