Skip to content

Commit 948bcb0

Browse files
devkevkay-kim
authored andcommitted
replSetStepDown: it's secondaryCatchUpPeriodSecs, not secondaryCatchupPeriodSecs
This might seem minor, but the effect is that after copy-pasting the option, it apparently has no effect on the command. This makes it seem like the option is broken in the server, when in fact it's just a small typo in the docs. Signed-off-by: kay <kay.kim@10gen.com>
1 parent 351b3f3 commit 948bcb0

File tree

2 files changed

+11
-11
lines changed

2 files changed

+11
-11
lines changed

source/includes/apiargs-command-replSetStepDown-field.yaml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ description: |
66
77
The stepdown period starts from the time that the
88
:program:`mongod` receives the command. The stepdown period must
9-
be greater than the ``secondaryCatchupPeriodSecs``.
9+
be greater than the ``secondaryCatchUpPeriodSecs``.
1010
interface: command
1111
name: replSetStepDown
1212
operation: replSetStepDown
@@ -19,11 +19,11 @@ description: |
1919
The number of seconds that the :program:`mongod` will wait for
2020
an electable secondary to catch up to the primary.
2121
22-
When specified, ``secondaryCatchupPeriodSecs`` overrides the default
22+
When specified, ``secondaryCatchUpPeriodSecs`` overrides the default
2323
wait time of either ``10`` seconds or if ``force: true``, ``0``
2424
seconds.
2525
interface: command
26-
name: secondaryCatchupPeriodSecs
26+
name: secondaryCatchUpPeriodSecs
2727
operation: replSetStepDown
2828
optional: true
2929
position: 2

source/reference/command/replSetStepDown.txt

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Description
2929

3030
db.runCommand( {
3131
replSetStepDown: <seconds>,
32-
secondaryCatchupPeriodSecs: <seconds>,
32+
secondaryCatchUpPeriodSecs: <seconds>,
3333
force: <true|false>
3434
} )
3535

@@ -50,7 +50,7 @@ map-reduce job.
5050
To avoid rollbacks, :dbcommand:`replSetStepDown`, by default, only
5151
steps down the primary if an electable secondary is completely caught up
5252
with the primary. The command will wait up to the
53-
``secondaryCatchupPeriodSecs`` for a secondary to catch up.
53+
``secondaryCatchUpPeriodSecs`` for a secondary to catch up.
5454

5555
If no electable secondary meets this criterion by the waiting period,
5656
the primary does not step down and the command errors. However, you can
@@ -93,8 +93,8 @@ does not step down and the command errors.
9393
use admin
9494
db.runCommand( { replSetStepDown: 120 } )
9595

96-
Specify Wait Time for Secondary Catchup
97-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
96+
Specify Wait Time for Secondary Catch Up
97+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
9898

9999
The following example, run on the current primary, attempts to step
100100
down the member for ``120`` seconds, waiting up to ``15`` seconds for
@@ -108,10 +108,10 @@ the primary does not step down and the command errors.
108108
.. code-block:: javascript
109109

110110
use admin
111-
db.runCommand( { replSetStepDown: 120, secondaryCatchupPeriodSecs: 15 } )
111+
db.runCommand( { replSetStepDown: 120, secondaryCatchUpPeriodSecs: 15 } )
112112

113-
Specify Secondary Catchup with Force Step Down
114-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
113+
Specify Secondary Catch Up with Force Step Down
114+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
115115

116116
The following example, run on the current primary, attempts to step
117117
down the member for ``120`` seconds, waiting up to ``15`` seconds for
@@ -125,7 +125,7 @@ option, the primary steps down even if no suitable secondary exists.
125125
.. code-block:: javascript
126126

127127
use admin
128-
db.runCommand( { replSetStepDown: 120, secondaryCatchupPeriodSecs: 15, force: true } )
128+
db.runCommand( { replSetStepDown: 120, secondaryCatchUpPeriodSecs: 15, force: true } )
129129

130130
.. seealso:: :method:`rs.stepDown()`
131131

0 commit comments

Comments
 (0)