File tree 14 files changed +47
-22
lines changed
14 files changed +47
-22
lines changed Original file line number Diff line number Diff line change @@ -21,6 +21,10 @@ Definition
21
21
:dbcommand:`replSetStepDown` command to make a different node in
22
22
the replica set a primary.
23
23
24
+ .. |method| replace:: :method:`rs.freeze` helper method
25
+ .. include:: /includes/fact-dbcommand-tip
26
+
27
+
24
28
Syntax
25
29
------
26
30
Original file line number Diff line number Diff line change @@ -18,6 +18,9 @@ Definition
18
18
Returns a document that describes the current :ref:`configuration
19
19
<replica-set-configuration-document>` of the :term:`replica set`.
20
20
21
+ .. |method| replace:: :method:`rs.conf` helper method
22
+ .. include:: /includes/fact-dbcommand-tip
23
+
21
24
Syntax
22
25
------
23
26
Original file line number Diff line number Diff line change @@ -27,6 +27,10 @@ Definition
27
27
Because of the frequency of heartbeats, these data can be several
28
28
seconds out of date.
29
29
30
+ .. |method| replace:: :method:`rs.status` helper method
31
+ .. include:: /includes/fact-dbcommand-tip
32
+
33
+
30
34
Syntax
31
35
------
32
36
Original file line number Diff line number Diff line change @@ -19,6 +19,9 @@ Definition
19
19
20
20
.. |command| replace:: ``replSetInitiate``
21
21
22
+ .. |method| replace:: :method:`rs.initiate` helper method
23
+ .. include:: /includes/fact-dbcommand-tip
24
+
22
25
.. include:: /includes/fact-dbcommand.rst
23
26
24
27
.. note::
Original file line number Diff line number Diff line change @@ -21,6 +21,10 @@ Definition
21
21
members. You must run this command on the ``admin``
22
22
database of the :term:`primary` replica set member.
23
23
24
+ .. |method| replace:: :method:`rs.reconfig` helper method
25
+ .. include:: /includes/fact-dbcommand-tip
26
+
27
+
24
28
Syntax
25
29
------
26
30
Original file line number Diff line number Diff line change @@ -21,6 +21,9 @@ Description
21
21
22
22
.. include:: /includes/stepdown-intro.rst
23
23
24
+ .. |method| replace:: :method:`rs.stepDown` helper method
25
+ .. include:: /includes/fact-dbcommand-tip
26
+
24
27
The :dbcommand:`replSetStepDown` can only run on the ``admin`` database.
25
28
26
29
Syntax
Original file line number Diff line number Diff line change @@ -20,7 +20,8 @@ Description
20
20
patterns and in situations where a set member is not replicating
21
21
from the desired host.
22
22
23
- .. include:: /includes/fact-voting-node-sync-incompatibility.rst
23
+ .. |method| replace:: :method:`rs.syncFrom` helper method
24
+ .. include:: /includes/fact-dbcommand-tip
24
25
25
26
Run :dbcommand:`replSetSyncFrom` in the ``admin`` database.
26
27
Original file line number Diff line number Diff line change @@ -18,7 +18,8 @@ Definition
18
18
Returns a document that contains the current :term:`replica set`
19
19
configuration.
20
20
21
- The method wraps the :dbcommand:`replSetGetConfig` command.
21
+ .. |dbcommand| replace:: :dbcommand:`replSetGetConfig` command
22
+ .. include:: /includes/fact-mongosh-shell-method-alt
22
23
23
24
.. include:: /includes/extracts/4.4-replSetGetConfiguration-commitmentStatus.rst
24
25
Original file line number Diff line number Diff line change @@ -18,6 +18,9 @@ Description
18
18
Makes the current :term:`replica set` member ineligible to become
19
19
:term:`primary` for the period specified.
20
20
21
+ .. |dbcommand| replace:: :dbcommand:`replSetFreeze` command
22
+ .. include:: /includes/fact-mongosh-shell-method-alt
23
+
21
24
The :method:`rs.freeze()` method has the following parameter:
22
25
23
26
@@ -37,9 +40,3 @@ Description
37
40
38
41
- The duration the member is ineligible to become primary.
39
42
40
-
41
-
42
-
43
-
44
- :method:`rs.freeze()` provides a wrapper around the :term:`database
45
- command` :dbcommand:`replSetFreeze`.
Original file line number Diff line number Diff line change @@ -20,6 +20,9 @@ Description
20
20
:ref:`configuration of a replica set
21
21
<replica-set-configuration-document>`.
22
22
23
+ .. |dbcommand| replace:: :dbcommand:`replSetInitiate` command
24
+ .. include:: /includes/fact-mongosh-shell-method-alt
25
+
23
26
The :method:`rs.initiate()` method has the following parameter:
24
27
25
28
@@ -38,9 +41,6 @@ Description
38
41
configuration is not specified, MongoDB uses a default
39
42
replica set configuration.
40
43
41
- The :method:`rs.initiate()` method provides a wrapper around the
42
- :dbcommand:`replSetInitiate` command.
43
-
44
44
IP Binding
45
45
----------
46
46
Original file line number Diff line number Diff line change @@ -19,6 +19,9 @@ Definition
19
19
replica set configuration. To run the method, you must connect to
20
20
the :term:`primary` of the replica set.
21
21
22
+ .. |dbcommand| replace:: :dbcommand:`replSetReconfig` command
23
+ .. include:: /includes/fact-mongosh-shell-method-alt
24
+
22
25
The :method:`rs.reconfig()` method has the following syntax:
23
26
24
27
.. code-block:: bash
@@ -86,9 +89,6 @@ Definition
86
89
current configuration with :method:`rs.conf()`, modify the
87
90
configuration document as needed, and then pass the modified
88
91
document to :method:`rs.reconfig()`.
89
-
90
- :method:`rs.reconfig()` provides a wrapper around the
91
- :dbcommand:`replSetReconfig` command.
92
92
93
93
The ``force`` parameter allows a reconfiguration command to be issued
94
94
to a non-primary node.
Original file line number Diff line number Diff line change @@ -16,8 +16,10 @@ Definition
16
16
.. method:: rs.status()
17
17
18
18
Returns the replica set status from the point of view of the member
19
- where the method is run. This method provides a wrapper around the
20
- :dbcommand:`replSetGetStatus` command.
19
+ where the method is run.
20
+
21
+ .. |dbcommand| replace:: :dbcommand:`replSetGetStatus` command
22
+ .. include:: /includes/fact-mongosh-shell-method-alt
21
23
22
24
This output reflects the current status of the replica set, using
23
25
data derived from the heartbeat packets sent by the other members
Original file line number Diff line number Diff line change @@ -20,6 +20,9 @@ Description
20
20
.. |behavior-ref| replace:: :ref:`rs.stepDown-behavior`
21
21
22
22
.. include:: /includes/stepdown-intro.rst
23
+
24
+ .. |dbcommand| replace:: :dbcommand:`replSetStepDown` command
25
+ .. include:: /includes/fact-mongosh-shell-method-alt
23
26
24
27
The :method:`rs.stepDown()` method has the following parameters:
25
28
@@ -62,8 +65,6 @@ Description
62
65
63
66
64
67
65
- :method:`rs.stepDown()` provides a wrapper around the
66
- command :dbcommand:`replSetStepDown`.
67
68
68
69
.. _rs.stepDown-behavior:
69
70
Original file line number Diff line number Diff line change @@ -12,12 +12,14 @@ rs.syncFrom()
12
12
13
13
.. method:: rs.syncFrom()
14
14
15
- Provides a wrapper around the :dbcommand:`replSetSyncFrom`, which
16
- allows administrators to temporarily override the default sync
17
- target for the current member. Specify the name of the member you
15
+ Temporarily overrides the default sync target for the current member.
16
+
17
+ .. |dbcommand| replace:: :dbcommand:`replSetFreeze` command
18
+ .. include:: /includes/fact-mongosh-shell-method-alt
19
+
20
+ Specify the name of the member you
18
21
want to replicate from in the form of ``[hostname]:[port]``.
19
22
20
- .. include:: /includes/fact-voting-node-sync-incompatibility.rst
21
23
22
24
Behavior
23
25
--------
You can’t perform that action at this time.
0 commit comments