Skip to content

Commit c3c1910

Browse files
authored
Removing references to voting and adding info about nodes with buildIndexes:false (#940) (#975)
* Removing references to voting and adding info about nodes with buildIndexes:false * Minor fixes * Updating buildIndex:false information * Bugfix * Incorporating review comments * Incorporating external review comments
1 parent 7a95fce commit c3c1910

File tree

3 files changed

+34
-33
lines changed

3 files changed

+34
-33
lines changed

source/reference/command/createIndexes.txt

Lines changed: 15 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -82,43 +82,39 @@ Definition
8282
- Optional. A document expressing the :doc:`write concern
8383
</reference/write-concern>`. Omit to use the default write concern.
8484

85-
* - :ref:`commitQuorum <createIndexes-cmd-commitQuorum>`
85+
* - ``commitQuorum``
8686

8787
- integer or string
8888

8989
- .. _createIndexes-cmd-commitQuorum:
9090

91-
Optional. The minimum number of data-bearing voting replica
91+
Optional. The minimum number of data-bearing replica
9292
set members (i.e. commit quorum), including the primary, that
9393
must report a successful :ref:`index build
9494
<index-operations-replicated-build>` before the primary
95-
marks the ``indexes`` as ready. A "voting" member is any
96-
replica set member where :rsconf:`members[n].votes` is greater
97-
than ``0``.
95+
marks the ``indexes`` as ready.
9896

99-
Starting in MongoDB v5.0 you can resume some
97+
Starting in MongoDB v5.0, you can resume some
10098
:ref:`interupted index builds<index-operations-build-failure>`
10199
when the
102100
:dbcommand:`commit quorum is set<setIndexCommitQuorum>` to
103101
``"votingMembers"``.
104102

105-
The ``"votingMembers"`` commit quorum cannot be used if any
106-
voting replica set node is configured with
107-
:rsconf:`members[n].buildIndexes` set to ``false``. Either
108-
configure all nodes with :rsconf:`members[n].buildIndexes` set
109-
to ``true`` or select a commit quorum that requires fewer
110-
votes.
103+
Replica set nodes in a commit quorum must have :rsconf:`members[n].buildIndexes`
104+
set to ``true``. If any voting nodes have ``members[n].buildIndexes``
105+
set to ``false``, you can't use the default ``"votingMembers"`` commit
106+
quorum. Either configure all nodes with ``members[n].buildIndexes``
107+
set to ``true``, or select a different commit quorum.
111108

112109
Supports the following values:
113110

114111
- ``"votingMembers"`` - all data-bearing voting replica set
115-
members (*Default*).
112+
members (*Default*). A "voting" member is any replica set member
113+
where :rsconf:`members[n].votes` is greater than ``0``.
116114

117-
- ``"majority"`` - a simple majority of data-bearing voting
118-
replica set members.
115+
- ``"majority"`` - a simple majority of data-bearing replica set members.
119116

120-
- ``<int>`` - a specific number of data-bearing voting
121-
replica set members.
117+
- ``<int>`` - a specific number of data-bearing replica set members.
122118

123119
- ``0`` - Disables quorum-voting behavior. Members
124120
start the index build simultaneously but do *not*
@@ -989,11 +985,11 @@ to the :dbcommand:`createIndexes` operation to set the minimum
989985
number of data-bearing voting members (i.e commit quorum), including the
990986
primary, which must complete the index build before the
991987
primary marks the indexes as ready. The default commit quorum is
992-
``votingMembers``, or all data-bearing voting replica set members.
988+
``votingMembers``, or all data-bearing replica set members.
993989

994990
The following operation creates an index with a :ref:`commit quorum
995991
<createIndexes-cmd-commitQuorum>` of ``"majority"``, or a
996-
simple majority of data-bearing voting members:
992+
simple majority of data-bearing members:
997993

998994
.. code-block:: javascript
999995

source/reference/command/setIndexCommitQuorum.txt

Lines changed: 17 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -69,34 +69,32 @@ setIndexCommitQuorum
6969

7070
- .. _setIndexCommitQuorum-cmd-commitQuorum:
7171

72-
The minimum number of data-bearing voting replica
72+
The minimum number of data-bearing replica
7373
set members (i.e. commit quorum), including the primary, that
7474
must report a successful :ref:`index build
7575
<index-operations-replicated-build>` before the primary
76-
marks the ``indexes`` as ready. A "voting" member is any
77-
replica set member where :rsconf:`members[n].votes` is
78-
greater than ``0``.
76+
marks the ``indexes`` as ready.
7977

80-
Starting in MongoDB v5.0 it is possible to resume some
78+
Starting in MongoDB v5.0, it's possible to resume some
8179
:ref:`interupted index builds<index-operations-build-failure>`
8280
when the commit quorum is set to ``"votingMembers"``.
8381

84-
The ``"votingMembers"`` commit quorum cannot be used if any
85-
voting replica set node is configured with
86-
:rsconf:`members[n].buildIndexes` set to ``false``. Either
87-
configure all nodes with :rsconf:`members[n].buildIndexes` set
88-
to ``true`` or select a commit quorum that requires fewer
89-
votes.
82+
Replica set nodes in a commit quorum must have :rsconf:`members[n].buildIndexes`
83+
set to ``true``. If any voting nodes have ``members[n].buildIndexes``
84+
set to ``false``, you can't use the default ``"votingMembers"`` commit
85+
quorum. Either configure all nodes with ``members[n].buildIndexes``
86+
set to ``true``, or select a different commit quorum.
9087

9188
Supports the following values:
9289

9390
- ``"votingMembers"`` - all data-bearing voting replica set
94-
members. (*Default*)
91+
members (*Default*). A "voting" member is any replica set member
92+
where :rsconf:`members[n].votes` is greater than ``0``.
9593

96-
- ``"majority"`` - a simple majority of data-bearing voting
94+
- ``"majority"`` - a simple majority of data-bearing
9795
replica set members.
9896

99-
- ``<int>`` - a specific number of data-bearing voting
97+
- ``<int>`` - a specific number of data-bearing
10098
replica set members. Specify an integer greater than
10199
``0``.
102100

@@ -122,6 +120,11 @@ Issuing :dbcommand:`setIndexCommitQuorum` has no effect on index builds
122120
started with :ref:`commitQuorum <createIndexes-cmd-commitQuorum>` of
123121
``0``.
124122

123+
.. important::
124+
125+
Replica set nodes with :ref:`buildIndexes <replica-set-configuration-buildIndexes>`
126+
set to ``false`` can't be included in a commit quorum.
127+
125128
Examples
126129
--------
127130

source/reference/replica-configuration.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -177,6 +177,8 @@ Replica Set Configuration Fields
177177
- :ref:`wc-ack-behavior`
178178
- :doc:`/reference/replica-set-protocol-versions`
179179

180+
.. _replica-set-configuration-buildIndexes:
181+
180182
``members``
181183
~~~~~~~~~~~
182184

0 commit comments

Comments
 (0)