Docs Menu

Docs HomeDevelop ApplicationsMongoDB Manual


On this page

  • Definition
  • Output

Returns the replica set status from the point of view of the member where the method is run.


mongosh Method

This page documents a mongosh method. This is not the documentation for database commands or language-specific drivers, such as Node.js.

For the database command, see the replSetGetStatus command.

For MongoDB API drivers, refer to the language-specific MongoDB driver documentation.

For the legacy mongo shell documentation, refer to the documentation for the corresponding MongoDB Server release:

mongo shell v4.4

This output reflects the current status of the replica set, using data derived from the heartbeat packets sent by the other members of the replica set.

For an example and details on the output, see replSetGetStatus.

  • Starting in MongoDB 4.2.1

    If you run the mongosh helper method rs.status() (or the replSetGetStatus command) on a member during its initial sync (i.e. STARTUP2 state), the command returns replSetGetStatus.initialSyncStatus metrics.

    Once the member completes its initial sync, the replSetGetStatus.initialSyncStatus metrics becomes unavailable.

  • In earlier versions (3.4.x-4.2.0)

    To return initial sync status information, you must the replSetGetStatus command with the initialSync: 1 option on a secondary member or a member in STARTUP2 state:

    db.adminCommand( { replSetGetStatus: 1, initialSync: 1 } )

    The replSetGetStatus.initialSyncStatus metrics remains available after the member completes its initial sync. That is, you can run the replSetGetStatus command with the initialSync: 1 on the secondary member to return its initial sync information.

    You cannot specify initialSync: 1 to the mongosh helper method rs.status().

← rs.remove()

On this page