On this page本页内容
You can access the configuration of a replica set using the 可以使用rs.conf() method or the replSetGetConfig command.rs.conf()方法或replSetGetConfig命令访问副本集的配置。
To modify the configuration for a replica set, use the 要修改副本集的配置，请使用rs.reconfig() method, passing a configuration document to the method. rs.reconfig()方法，将配置文档传递给该方法。See 有关详细信息，请参阅rs.reconfig() for more information.rs.reconfig()。
Avoid reconfiguring replica sets that contain members of different MongoDB versions as validation rules may differ across MongoDB versions.避免重新配置包含不同MongoDB版本成员的副本集，因为验证规则可能因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>
}
}
_id
Type: string
The name of the replica set.副本集的名称。
_id must be identical to the replication.replSetName or the value of --replSet specified to mongod on the command line._id必须与命令行上为mongod指定的replication.replSetName或--replSet值相同。
version
Type: int
An incrementing number used to distinguish revisions of the replica set configuration document from previous iterations of the configuration.用于将副本集配置文档的修订版本与以前的配置迭代版本区分开来的递增编号。
Changed in version 4.4.在版本4.4中更改。
term and version to achieve consensus on the "newest" replica configuration. term和version来就“最新”副本配置达成共识。term is considered the "newest". term的配置文档被视为“最新”。term is the same or absent, the configuration document with the larger version is considered "newest".term相同或不存在，则具有较大version的配置文件被视为“最新”。
term
Type: int
New in version 4.4.在版本4.4中新增。
Only available with featureCompatibilityVersion (fCV) "4.4" or later.仅适用于featureCompatibilityVersion (fCV) "4.4"或更高版本的功能。
An incrementing number used to distinguish revisions of the replica set configuration document from previous iterations of the configuration. 用于将副本集配置文档的修订版本与以前的配置迭代版本区分开来的递增编号。The 配置文档的term of a configuration document matches the term of the replica set primary which performed the reconfiguration. term与执行重新配置的副本集primary的术语相匹配。The primary increments its term each time it steps up after winning an election. primary在赢得选举后，每次都会增加任期。The primary ignores the 如果在term field if set explicitly in the replSetReconfig operation.replSetReconfig操作中显式设置，则主键将忽略term字段。
Issuing a force reconfiguration removes the 发布term field. force重新配置将删除term字段。When the primary next issues 当主要的下一个问题没有强制地replSetReconfig without force, it sets the term to its own term.replSetReconfig时，它会将term设置为自己的术语。
Replica set members use 副本集成员使用term and version to achieve consensus on the "newest" replica configuration. term和version来就“最新”副本配置达成共识。When members compare replica configuration documents, the configuration document with a larger 当成员比较副本配置文档时，具有较大term is considered the "newest". term的配置文档被视为“最新”。If 如果term is the same or absent, the configuration document with the larger version is considered "newest".term相同或不存在，则具有较大version的配置文件被视为“最新”。
configsvr
Type: boolean
Default: false
Indicates whether the replica set is used for a sharded cluster's config servers. 指示副本集是否用于分片群集的配置服务器。Set to 如果副本集用于分片集群的配置服务器，则设置为true if the replica set is for a sharded cluster's config servers.true。
protocolVersion
Type: number
Default: 1
Starting in 4.0, MongoDB only supports 从4.0开始，MongoDB只支持protocolVersion: 1 and no longer supports protocolVersion: 0.protocolVersion:1，不再支持protocolVersion:0。
writeConcernMajorityJournalDefault
Type: boolean
Default: true
Determines the behavior of 如果写入关注点未显式指定日志选项j，则确定{ w: "majority" } write concern if the write concern does not explicitly specify the journal option j.{ w: "majority" }写入关注点的行为。
The following table lists the 下表列出了writeConcernMajorityJournalDefault values and the associated { w: "majority" } behavior:writeConcernMajorityJournalDefault值和关联的{ w: "majority" }行为：
{ w: "majority" } | |
|---|---|
| true |
|
| false |
|
membersmembers
Type: array
An array of member configuration documents, one for each member of the replica set. 一组成员配置文档，副本集的每个成员对应一个。The members array is a zero-indexed array.members数组是一个零索引数组。
Each member-specific configuration document can contain the following fields:每个特定于成员的配置文档可以包含以下字段：
members[n]._id
Type: integer
An integer identifier for the member in the replica set, unique among all members.副本集中成员的整数标识符，在所有成员中唯一。
Starting in MongoDB 5.0, values may be any integer value greater than or equal to 从MongoDB 5.0开始，值可以是大于或等于0. 0的任何整数值。Previously, this value was limited to an integer between 以前，此值限制为0 and 255 inclusive0到255之间的整数（含0和255）.
Each replica set member must have a unique 每个副本集成员必须具有唯一的_id. _id。Avoid re-using 避免重新使用_id values even if no members[n] entry is using that _id in the current configuration._id值，即使当前配置中没有members[n]条目使用该_id。
Once set, you cannot change the 一旦设置，就不能更改成员的_id of a member._id。
When updating the replica configuration object, access the replica set members in the 更新副本配置对象时，使用数组索引访问members array with the array index. members数组中的副本集成员。The array index begins with 数组索引以0. 0开头。Do not confuse this index value with the value of the 不要将此索引值与members[n]._id field in each document in the members array.members数组中每个文档中的members[n]._id字段的值混淆。
members[n].host
Type: string
The hostname and, if specified, the port number, of the set member.集合成员的主机名和端口号（如果指定）。
The hostname name must be resolvable for every host in the replica set.对于副本集中的每个主机，主机名必须是可解析的。
members[n].host cannot hold a value that resolves to localhost or the local interface unless all members of the set are on hosts that resolve to localhost.
members[n].arbiterOnly
Optional.
Type: boolean
Default: false
A boolean that identifies an arbiter. A value of true indicates that the member is an arbiter.
When using the rs.addArb() method to add an arbiter, the method automatically sets members[n].arbiterOnly to true for the added member.
For the following MongoDB versions, pv1 increases the likelihood of w:1 rollbacks compared to pv0(no longer supported in MongoDB 4.0+) for replica sets with arbiters:
members[n].buildIndexes
Optional.
Type: boolean
Default: true
A boolean that indicates whether the mongod builds indexes on this member. You can only set this value when adding a member to a replica set. You cannot change members[n].buildIndexes field after the member has been added to the set. To add a member, see rs.add() and rs.reconfig().
Do not set to false for mongod instances that receive queries from clients.
Setting buildIndexes to false may be useful if allthe following conditions are true:
mongodump, andEven if set to false, secondaries will build indexes on the _id field in order to facilitate operations required for replication.
If you set members[n].buildIndexes to false, you must also set members[n].priority to 0. If members[n].priority is not 0, MongoDB will return an error when attempting to add a member with members[n].buildIndexes equal to false.
To ensure the member receives no queries, you should make all instances that do not build indexes hidden.为了确保成员没有收到任何查询，应该隐藏所有未构建索引的实例。
Other secondaries cannot replicate from a member where members[n].buildIndexes is false.
members[n].hidden
Optional.
Type: boolean
Default: false
When this value is true, the replica set hides this instance and does not include the member in the output of db.hello() or hello. This prevents read operations (i.e. queries) from ever reaching this host by way of secondary read preference.
Hidden members can acknowledge write operations issued with Write Concern. For write operations issued with "majority" write concern, the member must also be a voting member (i.e. votes is greater than 0).
members[n].priority
Changed in version 3.6.在版本3.6中更改。
0. If an arbiter has a priority of 1, MongoDB 3.6 reconfigures the arbiter to have a priority of 0.
Optional.
Type: Number between 0 and 1000 for primary/secondary; 0 or 1 for arbiters.
Default: 1.0 for primary/secondary; 0 for arbiters.
A number that indicates the relative eligibility of a member to become a primary.
Specify higher values to make a member more eligible to become primary, and lower values to make the member lesseligible. A member with a members[n].priority of 0 is ineligible to become primary.
Members with priority greater than 0 cannot have 0 votes.
Changing the balance of priority in a replica set will trigger one or more elections. If a lower priority secondary is elected over a higher priority secondary, replica set members will continue to call elections until the highest priority available member becomes primary.
Members with priority of 0 can acknowledge write operations issued with Write Concern. For write operations issued with "majority" write concern, the member must also be a voting member (i.e. votes is greater than 0).
members[n].tags
Optional.
Type: document
Default: none
A tags document contains user-defined tag field and value pairs for the replica set member.
{ "<tag1>": "<string1>", "<tag2>": "<string2>",... }
settings.getLastErrorModes and settings.getLastErrorDefaults.For more information, see Configure Replica Set Tag Sets.
members[n].secondaryDelaySecs
Optional.
Type: integer
Default: 0
The number of seconds "behind" the primary that this replica set member should "lag".
Use this option to create delayed members. Delayed members maintain a copy of the data that reflects the state of the data at some time in the past.
Delayed members can contribute to acknowledging write operations issued with Write Concern. However, they return write acknowledgment no earlier than the configured delay value. For write operations issued with "majority" write concern, the member must also be a voting member (i.e. votes is greater than 0).
members[n].votes
Optional.
Type: integer
Default: 1
The number of votes a server will cast in a replica set election. The number of votes each member has is either 1 or 0, and arbiters always have exactly 1 vote.
Members with priority greater than 0 cannot have 0 votes.
A replica set can have up to 50 members but only 7 voting members. If you need more than 7 members in one replica set, set members[n].votes to 0 for the additional non-voting members.
Non-voting (i.e. votes is 0) members must have priority of 0.
Starting in MongoDB 5.0, a newly added secondary does not count as a voting member and cannot be elected until it has reached SECONDARY state.
Non-voting members cannot acknowledge write operations issued with a "majority" write concern.
settingssettings
Optional.
Type: document
A document that contains configuration options that apply to the whole replica set.
The settings document contain the following fields:
settings.chainingAllowed
Optional.
Type: boolean
Default: true
In MongoDB 5.0.1, 4.2.15, 4.4.7, and earlier, if settings.chainingAllowed is:
true, replica set secondary members can replicate data from other secondary members.false, secondary members can replicate data only from the primary.Starting in MongoDB 5.0.2, 4.2.16, and 4.4.8:
settings.chainingAllowed is false.settings.chainingAllowed, set the enableOverrideClusterChainingSetting server parameter to true.enableOverrideClusterChainingSetting is false.settings.getLastErrorDefaults
Optional.
Type: document
Unavailable starting in MongoDB 5.0.
Starting in MongoDB 5.0, you cannot specify a default write concern with settings.getLastErrorDefaults other than the default of { w: 1, wtimeout: 0 } . Instead, use the setDefaultRWConcern command to set the default read or write concern configuration for a replica set or sharded cluster.
settings.getLastErrorModes
Optional.
Type: document
A document used to define a custom write concern through the use of members[n].tags. The custom write concern can provide data-center awareness.
{ getLastErrorModes: {
<name of write concern> : { <tag1>: <number>, .... },
...
} }
The <number> refers to the number of different tag values required to satisfy the write concern. For example, the following settings.getLastErrorModes defines a write concern named datacenter that requires the write to propagate to two members whose dc tag values differ.
{ getLastErrorModes: { datacenter: { "dc": 2 } } }
To use the custom write concern, pass in the write concern name to the w Option, e.g.
{ w: "datacenter" }
See Configure Replica Set Tag Sets for more information and example.
settings.heartbeatTimeoutSecs
Optional.
Type: int
Default: 10
Number of seconds that the replica set members wait for a successful heartbeat from each other. If a member does not respond in time, other members mark the delinquent member as inaccessible.
For pv1, settings.electionTimeoutMillis has a greater influence on whether the secondary members call for an election than the settings.heartbeatTimeoutSecs.
settings.electionTimeoutMillis
Optional.
Type: int
Default: 10000 (10 seconds)
The time limit in milliseconds for detecting when a replica set's primary is unreachable:
The setting only applies when using protocolVersion: 1.
Changed in version 4.0.2.在版本4.0.2中更改。
enableElectionHandoff is true (default), when a primary steps down from rs.stepDown()(or the replSetStepDown command without the force:
true), the stepped-down primary nominates an eligible secondary to call an election immediately. Otherwise, secondaries can wait up to settings.electionTimeoutMillis before calling an election. The stepped down primary does not wait for the effects of the handoff. For more information, see enableElectionHandoff.
settings.catchUpTimeoutMillis
Optional.
Type: int
Changed in version 3.6.在版本3.6中更改。
Default: -1, infinite catchup time.
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. 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. Use replSetAbortPrimaryCatchUp to abort the catchup then complete the transition to primary.
The setting only applies when using protocolVersion: 1.
To downgrade a replica set initiated in version 3.6 to 3.4, change catchUpTimeoutMillis from -1 to a positive number. Failure to change this value to a positive number causes nodes running version 3.4 to neither restart nor join the replica set.
settings.catchUpTakeoverDelayMillis
Optional.
Type: int
Default: 30000 (30 seconds)
Time in milliseconds a node waits to initiate a catchup takeover after determining it is ahead of the current primary. During a catchup takeover, the node ahead of the current primary initiates an election to become the new primary of the replica set.
After the node initiating the takeover determines that it is ahead of the current primary, it waits the specified number of milliseconds and then verifies the following:
Once determining that all of these conditions are met, the node initiating the takeover immediately runs for election.
For more information on Replica Set Elections, see Replica Set Elections.
Setting catchUpTakeoverDelayMillis to -1 disables catchup takeover. Setting catchUpTimeoutMillis to 0 disables primary catchup and consequently also catchup takeover.
settings.heartbeatIntervalMillis
Internal use only.
The frequency in milliseconds of the heartbeats.
settings.replicaSetId
Type: ObjectId
The ObjectId associated with the replica set and automatically created during rs.initiate() or replSetInitiate. You cannot change the replicaSetId.