rs.conf() (original) (raw)

rs.conf()

Returns a document that contains the current replica setconfiguration.

Important

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 replSetGetConfig command.

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

The replSetGetConfig command can specify a new option commitmentStatus: true when run on the primary. When run with the option, the command includes in the output acommitmentStatusfield. This output field indicates whether the replica set's previous reconfig has been committed, so that the replica set is ready to be reconfigured again. The option is only available with the replSetGetConfigcommand.

This method is available in deployments hosted in the following environments:

• MongoDB Atlas: The fully managed service for MongoDB deployments in the cloud

Important

This command is not supported in M0, M2, M5, and Flex clusters. For more information, see Unsupported Commands.

• MongoDB Enterprise: The subscription-based, self-managed version of MongoDB
• MongoDB Community: The source-available, free-to-use, and self-managed version of MongoDB

The following document provides a representation of a replica set configuration document. The configuration of your replica set may include only a subset of these settings:

{

  _id: <string>,

  version: <int>,

  term: <int>,

  protocolVersion: <number>,

  writeConcernMajorityJournalDefault: <boolean>,

  configsvr: <boolean>,

  members: [

    {

      _id: <int>,

      host: <string>,

      arbiterOnly: <boolean>,

      buildIndexes: <boolean>,

      hidden: <boolean>,

      priority: <number>,

      tags: <document>,

      secondaryDelaySecs: <int>,

      votes: <number>

    },

    ...

  ],

  settings: {

    chainingAllowed : <boolean>,

    heartbeatIntervalMillis : <int>,

    heartbeatTimeoutSecs: <int>,

    electionTimeoutMillis : <int>,

    catchUpTimeoutMillis : <int>,

    getLastErrorModes : <document>,

    getLastErrorDefaults : <document>,

    replicaSetId: <ObjectId>

  }

}

For description of the configuration settings, seeSelf-Managed Replica Set Configuration.

rs.config()

rs.config() is an alias of rs.conf().