js-replication.txt

===================
Replication Methods
===================

.. default-domain:: mongodb

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

.. include:: /includes/extracts/methods-toc-explanation.rst

.. list-table::
   :widths: 30,70
   :header-rows: 1

   * - Name

     - Description

   * - :method:`rs.add()`

     - Adds a member to a replica set.

   * - :method:`rs.addArb()`

     - Adds an :term:`arbiter` to a replica set.

   * - :method:`rs.conf()`

     - Returns the replica set configuration document.

   * - :method:`rs.freeze()`

     - Prevents the current member from seeking election as primary for a period of time.

   * - :method:`rs.help()`

     - Returns basic help text for :term:`replica set` functions.

   * - :method:`rs.initiate()`

     - Initializes a new replica set.

   * - :method:`rs.printReplicationInfo()`

     - Prints a formatted report of the replica set status from the
       perspective of the primary.

   * - :method:`rs.printSecondaryReplicationInfo()`

     - Prints a formatted report of the replica set status from the
       perspective of the secondaries.

   * - :method:`rs.reconfig()`

     - Reconfigures a replica set by applying a new replica set configuration object.

   * - :method:`rs.reconfigForPSASet()`

     - Safely perform some reconfiguration changes on a
       primary-secondary-arbiter (PSA) replica set or on a replica set that
       is changing to a PSA architecture.

   * - :method:`rs.remove()`

     - Remove a member from a replica set.

   * - :method:`rs.status()`

     - Returns a document with information about the state of the replica set.

   * - :method:`rs.stepDown()`

     - Causes the current :term:`primary` to become a secondary which forces an :term:`election`.

   * - :method:`rs.syncFrom()`

     - Sets the member that this replica set member will sync from, overriding the default sync target selection logic.


.. toctree::
   :titlesonly:
   :hidden:

   rs.add </reference/method/rs.add>
   rs.addArb </reference/method/rs.addArb>
   rs.conf </reference/method/rs.conf>
   rs.freeze </reference/method/rs.freeze>
   rs.help </reference/method/rs.help>
   rs.initiate </reference/method/rs.initiate>
   rs.printReplicationInfo </reference/method/rs.printReplicationInfo>
   rs.printSecondaryReplicationInfo </reference/method/rs.printSecondaryReplicationInfo>
   rs.reconfig </reference/method/rs.reconfig>
   rs.reconfigForPSASet </reference/method/rs.reconfigForPSASet>
   rs.remove </reference/method/rs.remove>
   rs.status </reference/method/rs.status>
   rs.stepDown </reference/method/rs.stepDown>
   rs.syncFrom </reference/method/rs.syncFrom>