Skip to content

Commit 70f73b5

Browse files
jdestefano-mongokay-kim
authored andcommitted
DOCSP-632 - Document replSetAbortPrimaryCatchUp command and update info on catchUpTimeoutMillis.
1 parent 2d4ff60 commit 70f73b5

File tree

3 files changed

+45
-3
lines changed

3 files changed

+45
-3
lines changed

source/includes/ref-toc-command-replication.yaml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,11 @@ name: ":dbcommand:`isMaster`"
66
file: /reference/command/isMaster
77
description: "Displays information about this member's role in the replica set, including whether it is the master."
88
---
9+
name: ":dbcommand:`replSetAbortPrimaryCatchUp`"
10+
file: /reference/command/replSetAbortPrimaryCatchUp
11+
description: "Forces the elected :term:`primary` to abort sync (catch
12+
up) then complete the transition to primary."
13+
---
914
name: ":dbcommand:`replSetFreeze`"
1015
file: /reference/command/replSetFreeze
1116
description: "Prevents the current member from seeking election as :term:`primary` for a period of time."
Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
==========================
2+
replSetAbortPrimaryCatchUp
3+
==========================
4+
5+
.. default-domain:: mongodb
6+
7+
.. contents:: On this page
8+
:local:
9+
:backlinks: none
10+
:depth: 1
11+
:class: singlecol
12+
13+
Definition
14+
----------
15+
16+
.. dbcommand:: replSetAbortPrimaryCatchUp
17+
18+
The ``replSetAbortPrimaryCatchUp`` command forces the elected
19+
: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:
22+
23+
.. code-block:: javascript
24+
25+
{ replSetAbortPrimaryCatchUp: 1 }

source/reference/replica-configuration.txt

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -480,18 +480,30 @@ Replica Set Configuration Fields
480480

481481
*Type*: int
482482

483-
*Default*: 2000 (2 seconds)
483+
.. list-table::
484+
:header-rows: 1
485+
:widths: 50 50
486+
487+
* - Default Value
488+
- MongoDB Version
489+
490+
* - 60000 (60 seconds)
491+
- 3.4.6+
492+
493+
* - 2000 (2 seconds)
494+
- 3.4.0 - 3.4.5
484495

485496
Time limit in milliseconds for a newly elected primary to sync
486497
(catch up) with the other replica set members that may have more
487-
recent writes. Specifying a higher time limit may reduce the
498+
recent writes. Infinite or high time limits may reduce the
488499
amount of data that the other members would need to roll back
489500
after an election but may increase the failover time.
490501

491502
The newly elected primary ends the catchup period early once it
492503
is fully caught up with other members of the set. During the
493504
catchup period, the newly elected primary is unavailable for
494-
writes from clients.
505+
writes from clients. Use :dbcommand:`replSetAbortPrimaryCatchUp`
506+
to abort the catchup then complete the transition to primary.
495507

496508
The setting only applies when using :rsconf:`protocolVersion: 1`.
497509

0 commit comments

Comments
 (0)