Skip to content

Commit b274a55

Browse files
authored
Removing references to voting and adding info about nodes with buildIndexes:false (#940) (#976)
* 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 0ad9fc8 commit b274a55

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
@@ -84,43 +84,39 @@ Definition
8484

8585
.. versionadded:: 3.4
8686

87-
* - :ref:`commitQuorum <createIndexes-cmd-commitQuorum>`
87+
* - ``commitQuorum``
8888

8989
- integer or string
9090

9191
- .. _createIndexes-cmd-commitQuorum:
9292

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

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

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

114111
Supports the following values:
115112

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

119-
- ``"majority"`` - a simple majority of data-bearing voting
120-
replica set members.
117+
- ``"majority"`` - a simple majority of data-bearing replica set members.
121118

122-
- ``<int>`` - a specific number of data-bearing voting
123-
replica set members.
119+
- ``<int>`` - a specific number of data-bearing replica set members.
124120

125121
- ``0`` - Disables quorum-voting behavior. Members
126122
start the index build simultaneously but do *not*
@@ -997,11 +993,11 @@ to the :dbcommand:`createIndexes` operation to set the minimum
997993
number of data-bearing voting members (i.e commit quorum), including the
998994
primary, which must complete the index build before the
999995
primary marks the indexes as ready. The default commit quorum is
1000-
``votingMembers``, or all data-bearing voting replica set members.
996+
``votingMembers``, or all data-bearing replica set members.
1001997

1002998
The following operation creates an index with a :ref:`commit quorum
1003999
<createIndexes-cmd-commitQuorum>` of ``"majority"``, or a
1004-
simple majority of data-bearing voting members:
1000+
simple majority of data-bearing members:
10051001

10061002
.. code-block:: javascript
10071003

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
@@ -183,6 +183,8 @@ Replica Set Configuration Fields
183183
- :ref:`wc-ack-behavior`
184184
- :doc:`/reference/replica-set-protocol-versions`
185185

186+
.. _replica-set-configuration-buildIndexes:
187+
186188
``members``
187189
~~~~~~~~~~~
188190

0 commit comments

Comments
 (0)