Skip to content

Commit b7a7a30

Browse files
committed
Update rs.reconfig.txt
1 parent f3341f4 commit b7a7a30

File tree

1 file changed

+10
-13
lines changed

1 file changed

+10
-13
lines changed

source/reference/method/rs.reconfig.txt

Lines changed: 10 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -15,33 +15,30 @@ Definition
1515

1616
.. include:: /includes/apiargs/method-rs.reconfig-param.rst
1717

18-
When used to reconfigure an existing replica set, first retrieve the
18+
To reconfigure an existing replica set, first retrieve the
1919
current configuration with :method:`rs.conf()`, modify the
2020
configuration document as needed, and then pass the modified
2121
document to :method:`rs.reconfig()`.
2222

2323
:method:`rs.reconfig()` provides a wrapper around the
2424
:dbcommand:`replSetReconfig` command.
25+
26+
The ``force`` parameter allows a reconfiguration command to be issued
27+
to a non-primary node.
2528

2629
Behavior
2730
--------
2831

29-
The method disconnects the :program:`mongo` shell and forces a
30-
reconnection as the replica set renegotiates which member will be
31-
:term:`primary`. As a result, the shell will display an error even if
32-
this command succeeds.
33-
34-
The :method:`rs.reconfig()` shell method can force the current primary
35-
to step down and triggers an election in some situations. When the
36-
primary steps down, the primary closes all client connections. This is
37-
by design. Since this typically takes 10-20 seconds, attempt to make
38-
such changes during scheduled maintenance periods.
32+
The :method:`rs.reconfig()` shell method can trigger the current primary
33+
to step down in some situations. When the
34+
primary steps down, it forceably closes all client connections. This is
35+
by design. Since it may take a period of time to elect a new primary,
36+
schedule reconfiguration changes during maintenance periods to minimize loss of write availability.
3937

4038
.. warning::
4139

4240
Using :method:`rs.reconfig()` with ``{ force: true }`` can lead to
43-
:term:`rollback` situations and other difficult-to-recover-from
44-
situations. Exercise caution when using this option.
41+
:term:`rollback` of committed writes. Exercise caution when using this option.
4542

4643
.. _replica-set-reconfiguration-usage:
4744

0 commit comments

Comments
 (0)