Skip to content

DOCSP-632 - Document replSetAbortPrimaryCatchUp command and update in… #3136

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 30, 2017
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions source/includes/ref-toc-command-replication.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,11 @@ name: ":dbcommand:`isMaster`"
file: /reference/command/isMaster
description: "Displays information about this member's role in the replica set, including whether it is the master."
---
name: ":dbcommand:`replSetAbortPrimaryCatchUp`"
file: /reference/command/replSetAbortPrimaryCatchUp
description: "Forces the elected :term:`primary` to abort sync (catch
up) then complete the transition to primary."
---
name: ":dbcommand:`replSetFreeze`"
file: /reference/command/replSetFreeze
description: "Prevents the current member from seeking election as :term:`primary` for a period of time."
Expand Down
25 changes: 25 additions & 0 deletions source/reference/command/replSetAbortPrimaryCatchUp.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
==========================
replSetAbortPrimaryCatchUp
==========================

.. default-domain:: mongodb

.. contents:: On this page
:local:
:backlinks: none
:depth: 1
:class: singlecol

Definition
----------

.. dbcommand:: replSetAbortPrimaryCatchUp

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

.. code-block:: javascript

{ replSetAbortPrimaryCatchUp: 1 }
18 changes: 15 additions & 3 deletions source/reference/replica-configuration.txt
Original file line number Diff line number Diff line change
Expand Up @@ -480,18 +480,30 @@ Replica Set Configuration Fields

*Type*: int

*Default*: 2000 (2 seconds)
.. list-table::
:header-rows: 1
:widths: 50 50

* - Default Value
- MongoDB Version

* - 60000 (60 seconds)
- 3.4.6+

* - 2000 (2 seconds)
- 3.4.0 - 3.4.5

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

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

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

Expand Down