Skip to content

Commit 700dbf5

Browse files
jwilson-mdbpierwill
jwilson-mdb
and
pierwill
authored
DOCSP-34779 Add info on Atlas Support for Replication Commands (#5791) (#9510)
* DOCSP-34779 Add info on Atlas Support for Replication Commands (#5791) * Fixes formatting issues --------- Co-authored-by: pierwill <19642016+pierwill@users.noreply.github.com>
1 parent b5cea63 commit 700dbf5

12 files changed

+332
-160
lines changed

‎source/reference/command/applyOps.txt

+11
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,17 @@ Definition
1919
instance. The :dbcommand:`applyOps` command is an internal
2020
command.
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-serverless.rst
30+
31+
.. include:: /includes/fact-environments-onprem-only.rst
32+
2233
Behavior
2334
--------
2435

‎source/reference/command/hello.txt

+11
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,17 @@ Definition
4040
members and to discover additional members of a :term:`replica
4141
set`.
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-all.rst
51+
52+
.. include:: /includes/fact-environments-onprem-only.rst
53+
4354
Syntax
4455
------
4556

‎source/reference/command/replSetAbortPrimaryCatchUp.txt

+19-4
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,24 @@ Definition
1717

1818
The ``replSetAbortPrimaryCatchUp`` command forces the elected
1919
:term:`primary` member of the replica set to abort sync (catch up)
20-
then complete the transition to primary. The command has the
21-
following prototype form:
20+
then complete the transition to primary.
2221

23-
.. code-block:: javascript
22+
Compatibility
23+
-------------
2424

25-
{ replSetAbortPrimaryCatchUp: 1 }
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+
33+
Syntax
34+
------
35+
36+
The command has the following syntax:
37+
38+
.. code-block:: javascript
39+
40+
{ replSetAbortPrimaryCatchUp: 1 }

‎source/reference/command/replSetFreeze.txt

+31-13
Original file line numberDiff line numberDiff line change
@@ -21,24 +21,42 @@ replSetFreeze
2121
.. |method| replace:: :method:`rs.freeze` helper method
2222
.. include:: /includes/fact-dbcommand-tip
2323

24-
The :dbcommand:`replSetFreeze` command uses the following syntax:
24+
Compatibility
25+
-------------
2526

26-
.. code-block:: javascript
27+
This command is available in deployments hosted in the following environments:
2728

28-
{ replSetFreeze: <seconds> }
29+
.. include:: /includes/fact-environments-atlas-only.rst
2930

30-
If you want to unfreeze a replica set member before the specified number
31-
of seconds has elapsed, you can issue the command with a seconds
32-
value of ``0``:
31+
.. include:: /includes/fact-environments-atlas-support-no-free-or-m10.rst
3332

34-
.. code-block:: javascript
33+
.. include:: /includes/fact-environments-onprem-only.rst
3534

36-
{ replSetFreeze: 0 }
3735

38-
Restarting the :binary:`~bin.mongod` process also unfreezes a replica
39-
set member.
36+
Syntax
37+
------
4038

41-
:dbcommand:`replSetFreeze` is an administrative command, and you
42-
must issue it against the :term:`admin database`.
39+
The command has the following syntax:
4340

44-
.. slave-ok, admin-only
41+
.. code-block:: javascript
42+
43+
{ replSetFreeze: <seconds> }
44+
45+
Behavior
46+
--------
47+
48+
If you want to unfreeze a replica set member before the specified number
49+
of seconds has elapsed, you can issue the command with a seconds
50+
value of ``0``:
51+
52+
.. code-block:: javascript
53+
54+
{ replSetFreeze: 0 }
55+
56+
Restarting the :binary:`~bin.mongod` process also unfreezes a replica
57+
set member.
58+
59+
:dbcommand:`replSetFreeze` is an administrative command, and you
60+
must issue it against the :term:`admin database`.
61+
62+
.. slave-ok, admin-only

‎source/reference/command/replSetGetConfig.txt

+12
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,18 @@ Definition
2121
.. |method| replace:: :method:`rs.conf` 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-no-free.rst
32+
33+
.. include:: /includes/fact-environments-onprem-only.rst
34+
35+
2436
Syntax
2537
------
2638

‎source/reference/command/replSetGetStatus.txt

+10
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,16 @@ Definition
3030
.. |method| replace:: :method:`rs.status` 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-free.rst
41+
42+
.. include:: /includes/fact-environments-onprem-only.rst
3343

3444
Syntax
3545
------

‎source/reference/command/replSetInitiate.txt

+30-16
Original file line numberDiff line numberDiff line change
@@ -26,28 +26,42 @@ replSetInitiate
2626
Run the command on only one of the :binary:`~bin.mongod` instances
2727
for the replica set.
2828

29-
Use the following syntax:
29+
Compatibility
30+
-------------
3031

31-
.. code-block:: javascript
32+
This command is available in deployments hosted in the following environments:
3233

33-
{ replSetInitiate : <config_document> }
34+
.. include:: /includes/fact-environments-atlas-only.rst
3435

35-
The ``<config_document>`` is a :term:`document` that specifies
36-
the replica set's configuration. For instance, here's a config document
37-
for creating a simple 3-member replica set:
36+
.. include:: /includes/fact-environments-atlas-support-no-free-or-m10.rst
3837

39-
.. code-block:: javascript
38+
.. include:: /includes/fact-environments-onprem-only.rst
4039

41-
{
42-
_id : <setname>,
43-
members : [
44-
{_id : 0, host : <host0>},
45-
{_id : 1, host : <host1>},
46-
{_id : 2, host : <host2>},
47-
]
48-
}
40+
Syntax
41+
------
4942

50-
.. include:: /includes/important-hostnames.rst
43+
The command has the following syntax:
44+
45+
.. code-block:: javascript
46+
47+
{ replSetInitiate : <config_document> }
48+
49+
The ``<config_document>`` is a :term:`document` that specifies
50+
the replica set's configuration. For instance, here's a config document
51+
for creating a simple 3-member replica set:
52+
53+
.. code-block:: javascript
54+
55+
{
56+
_id : <setname>,
57+
members : [
58+
{_id : 0, host : <host0>},
59+
{_id : 1, host : <host1>},
60+
{_id : 2, host : <host2>},
61+
]
62+
}
63+
64+
.. include:: /includes/important-hostnames.rst
5165

5266
IP Binding
5367
----------

‎source/reference/command/replSetMaintenance.txt

+17-3
Original file line numberDiff line numberDiff line change
@@ -19,11 +19,25 @@ Definition
1919
maintenance mode for a :term:`secondary` member of a :term:`replica
2020
set`.
2121

22-
The command has the following prototype form:
22+
Compatibility
23+
-------------
2324

24-
.. code-block:: javascript
25+
This command is available in deployments hosted in the following environments:
2526

26-
{ replSetMaintenance: <boolean> }
27+
.. include:: /includes/fact-environments-atlas-only.rst
28+
29+
.. include:: /includes/fact-environments-atlas-support-no-free-or-m10.rst
30+
31+
.. include:: /includes/fact-environments-onprem-only.rst
32+
33+
Syntax
34+
------
35+
36+
The command has the following syntax:
37+
38+
.. code-block:: javascript
39+
40+
{ replSetMaintenance: <boolean> }
2741

2842
Behavior
2943
--------

‎source/reference/command/replSetReconfig.txt

+51-34
Original file line numberDiff line numberDiff line change
@@ -21,52 +21,69 @@ replSetReconfig
2121
.. |method| replace:: :method:`rs.reconfig` helper method
2222
.. include:: /includes/fact-dbcommand-tip
2323

24-
The command has the following syntax:
24+
Compatibility
25+
-------------
2526

26-
.. code-block:: javascript
27+
This command is available in deployments hosted in the following environments:
2728

28-
db.adminCommand({
29-
replSetReconfig: <new_config_document>,
30-
force: <boolean>,
31-
maxTimeMS: <int>
32-
})
29+
.. include:: /includes/fact-environments-atlas-only.rst
3330

34-
The command takes the following optional field:
31+
.. include:: /includes/fact-environments-atlas-support-no-free-or-m10.rst
3532

36-
.. list-table::
37-
:header-rows: 1
38-
:widths: 20 80
33+
.. include:: /includes/fact-environments-onprem-only.rst
3934

40-
* - Field
41-
- Description
35+
Syntax
36+
------
4237

43-
* - .. _replSetReconfig-cmd-force:
44-
45-
:ref:`force <replSetReconfig-cmd-force>`
38+
The command has the following syntax:
4639

47-
- Defaults to ``false``. Specify ``true`` to force the
48-
available replica set members to accept the new configuration.
40+
.. code-block:: javascript
41+
42+
db.adminCommand({
43+
replSetReconfig: <new_config_document>,
44+
force: <boolean>,
45+
maxTimeMS: <int>
46+
})
47+
48+
Command Fields
49+
--------------
50+
51+
The command takes the following optional field:
52+
53+
.. list-table::
54+
:header-rows: 1
55+
:widths: 20 80
56+
57+
* - Field
58+
- Description
59+
60+
* - .. _replSetReconfig-cmd-force:
61+
62+
:ref:`force <replSetReconfig-cmd-force>`
63+
64+
- Defaults to ``false``. Specify ``true`` to force the
65+
available replica set members to accept the new configuration.
4966

50-
Force reconfiguration can result in unexpected or
51-
undesired behavior, including :ref:`rollback
52-
<replica-set-rollbacks>` of :writeconcern:`"majority"`
53-
committed writes.
67+
Force reconfiguration can result in unexpected or
68+
undesired behavior, including :ref:`rollback
69+
<replica-set-rollbacks>` of :writeconcern:`"majority"`
70+
committed writes.
5471

55-
* - .. _replSetReconfig-cmd-maxTimeMS:
72+
* - .. _replSetReconfig-cmd-maxTimeMS:
5673

57-
:ref:`maxTimeMS <replSetReconfig-cmd-maxTimeMS>`
74+
:ref:`maxTimeMS <replSetReconfig-cmd-maxTimeMS>`
5875

59-
- Optional. Specifies a cumulative time limit in milliseconds
60-
for processing the :dbcommand:`replSetReconfig`. By default,
61-
:dbcommand:`replSetReconfig` waits indefinitely for the
62-
replica configuration to propagate to a majority of replica
63-
set members. Setting ``maxTimeMS`` may result
64-
in the operation failing *before* it can apply the new
65-
configuration. See :ref:`replSetReconfig-cmd-majority-install`
66-
for more information.
76+
- Optional. Specifies a cumulative time limit in milliseconds
77+
for processing the :dbcommand:`replSetReconfig`. By default,
78+
:dbcommand:`replSetReconfig` waits indefinitely for the
79+
replica configuration to propagate to a majority of replica
80+
set members. Setting ``maxTimeMS`` may result
81+
in the operation failing *before* it can apply the new
82+
configuration. See :ref:`replSetReconfig-cmd-majority-install`
83+
for more information.
6784

68-
You may also run :dbcommand:`replSetReconfig` with the shell's
69-
:method:`rs.reconfig()` method.
85+
You may also run :dbcommand:`replSetReconfig` with the shell's
86+
:method:`rs.reconfig()` method.
7087

7188
.. slave-ok, admin-only
7289

‎source/reference/command/replSetResizeOplog.txt

+27-10
Original file line numberDiff line numberDiff line change
@@ -29,19 +29,36 @@ Definition
2929

3030
You must run this command against the ``admin`` database.
3131

32-
The command has the following form:
32+
Compatibility
33+
-------------
3334

34-
.. code-block:: javascript
35+
This command is available in deployments hosted in the following environments:
3536

36-
db.adminCommand(
37-
{
38-
replSetResizeOplog: <int>,
39-
size: <double>,
40-
minRetentionHours: <double>
41-
}
42-
)
37+
.. include:: /includes/fact-environments-atlas-only.rst
4338

44-
:dbcommand:`replSetResizeOplog` takes the following fields:
39+
.. include:: /includes/fact-environments-atlas-support-no-m10.rst
40+
41+
.. include:: /includes/fact-environments-onprem-only.rst
42+
43+
Syntax
44+
------
45+
46+
The command has the following form:
47+
48+
.. code-block:: javascript
49+
50+
db.adminCommand(
51+
{
52+
replSetResizeOplog: <int>,
53+
size: <double>,
54+
minRetentionHours: <double>
55+
}
56+
)
57+
58+
Command Fields
59+
--------------
60+
61+
The command takes the following fields:
4562

4663
.. list-table::
4764
:header-rows: 1

0 commit comments

Comments
 (0)