Skip to content

Commit 1b2e41e

Browse files
authored
DOCS 23751 making tag set terminology consistent (#1518) (#1523)
* DOCS-23751 making tag set terminology consistent with Drivers * DOCS-23751 making tag set terminology consistent with Drivers * DOCS-23751 making tag set terminology consistent with Drivers * DOCS-23751 taking out ie * DOCS-23751 small fixes
1 parent 745f74d commit 1b2e41e

File tree

4 files changed

+42
-45
lines changed

4 files changed

+42
-45
lines changed

source/core/read-preference-tags.txt

Lines changed: 31 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22

33
.. _replica-set-read-preference-tag-sets:
44

5-
========================
6-
Read Preference Tag Sets
7-
========================
5+
=============================
6+
Read Preference Tag Set Lists
7+
=============================
88

99
.. default-domain:: mongodb
1010

@@ -15,8 +15,8 @@ Read Preference Tag Sets
1515
:class: singlecol
1616

1717
If a replica set member or members are associated with
18-
:rsconf:`~members[n].tags`, you can specify a tag set (array of tag
19-
specification documents) in the read preference to target those members.
18+
:rsconf:`~members[n].tags`, you can specify a tag set list (array of tag
19+
sets) in the read preference to target those members.
2020

2121
To :ref:`configure <replica-set-configuration-document>` a member with
2222
tags, set :rsconf:`members[n].tags` to a document that contains the tag
@@ -27,9 +27,9 @@ name and value pairs. The value of the tags must be a string.
2727

2828
{ "<tag1>": "<string1>", "<tag2>": "<string2>",... }
2929

30-
Then, you can include a tag set in the read preference to target tagged
31-
members. A tag set is an array of tag specification documents, where
32-
each tag specification document contains one or more tag/value pairs.
30+
Then, you can include a tag set list in the read preference to target
31+
tagged members. A tag set list is an array of tag sets, where each
32+
tag set contains one or more tag/value pairs.
3333

3434
.. code-block:: javascript
3535
:copyable: false
@@ -46,8 +46,8 @@ For example, if a secondary member has the following
4646

4747
{ "region": "South", "datacenter": "A" }
4848

49-
Then, the following tags sets can direct read operations to the aforementioned
50-
secondary (or other members with the same tags):
49+
Then, the following tag set lists can direct read operations to the
50+
aforementioned secondary (or other members with the same tags):
5151

5252
.. code-block:: javascript
5353
:copyable: false
@@ -65,21 +65,20 @@ secondary (or other members with the same tags):
6565
Order of Tag Matching
6666
---------------------
6767

68-
If the tag set lists multiple documents, MongoDB tries each document in
69-
succession until a match is found. Once a match is found, that tag
70-
specification document is used to find all eligible matching members,
71-
and the remaining tag specification documents are ignored. If no
72-
members match any of the tag specification documents, the read
73-
operation returns with an error.
68+
If the tag set list contains multiple documents, MongoDB tries each
69+
document in succession until a match is found. Once a match is found,
70+
that tag set is used to find all eligible matching members, and the
71+
remaining tag sets are ignored. If no members match any of the tag
72+
sets, the read operation returns with an error.
7473

7574
.. tip::
7675

7776
To avoid an error if no members match any of the tag specifications,
7877
you can add an empty document ``{ }`` as the last element of the tag
79-
set to read from any eligible member.
78+
set list to read from any eligible member.
8079

81-
For example, consider the following tag set with three tag
82-
specification documents:
80+
For example, consider the following tag set list with three tag
81+
sets:
8382

8483
.. code-block:: javascript
8584
:copyable: false
@@ -95,9 +94,8 @@ First, MongoDB tries to find members tagged with both ``"region":
9594
{ "region": "South", "datacenter": "A" }
9695

9796

98-
- If a member is found, the remaining tag specification documents are
99-
not considered. Instead, MongoDB uses this tag specification document
100-
to find all eligible members.
97+
- If a member is found, the remaining tag sets are not considered.
98+
Instead, MongoDB uses this tag set to find all eligible members.
10199

102100
- Else, MongoDB tries to find members with the tags specified in the
103101
second document
@@ -107,9 +105,8 @@ First, MongoDB tries to find members tagged with both ``"region":
107105

108106
{ "rack": "rack-1" }
109107

110-
- If a member is found tagged, the remaining tag specification
111-
document is not considered. Instead, MongoDB uses this tag
112-
specification document to find all eligible members.
108+
- If a member is found tagged, the remaining tag set is not considered.
109+
Instead, MongoDB uses this tag set to find all eligible members.
113110

114111
- Else, the third document is considered.
115112

@@ -120,13 +117,13 @@ First, MongoDB tries to find members tagged with both ``"region":
120117

121118
The empty document matches any eligible member.
122119

123-
Tag Set and Read Preference Modes
124-
---------------------------------
120+
Tag Set List and Read Preference Modes
121+
--------------------------------------
125122

126123
Tags are not compatible with mode :readmode:`primary`, and in general,
127124
only apply when :ref:`selecting <replica-set-read-preference-behavior-member-selection>`
128125
a :term:`secondary` member of a set for a read operation. However, the
129-
:readmode:`nearest` read mode, when combined with a tag set, selects
126+
:readmode:`nearest` read mode, when combined with a tag set list, selects
130127
the matching member with the lowest network latency. This member may be a
131128
primary or secondary.
132129

@@ -138,22 +135,22 @@ primary or secondary.
138135
- Notes
139136

140137
* - :readmode:`primaryPreferred`
141-
- Specified tag set only applies if selecting eligible secondaries.
138+
- Specified tag set list only applies if selecting eligible secondaries.
142139

143140
* - :readmode:`secondary`
144-
- Specified tag set always applies.
141+
- Specified tag set list always applies.
145142

146143
* - :readmode:`secondaryPreferred`
147-
- Specified tag set only applies if selecting eligible secondaries.
144+
- Specified tag set list only applies if selecting eligible secondaries.
148145

149146
* - :readmode:`nearest`
150147

151-
- Specified tag set applies whether selecting either primary or eligible secondaries.
148+
- Specified tag set list applies whether selecting either primary or eligible secondaries.
152149

153150
For information on the interaction between the :ref:`modes
154-
<replica-set-read-preference-modes>` and tag sets, refer to the
151+
<replica-set-read-preference-modes>` and tag set lists, refer to the
155152
:ref:`specific read preference mode documentation
156153
<replica-set-read-preference-modes>`.
157154

158-
For information on configuring tag sets, see the
155+
For information on configuring tag set lists, see the
159156
:doc:`/tutorial/configure-replica-set-tag-sets` tutorial.

source/core/read-preference.txt

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Read Preference
1919
.. include:: /includes/introduction-read-preference.rst
2020

2121
Read preference consists of the :ref:`read preference mode
22-
<read-pref-modes-summary>` and optionally, a :ref:`tag set
22+
<read-pref-modes-summary>` and optionally, a :ref:`tag set list
2323
<replica-set-read-preference-tag-sets>`, the :ref:`maxStalenessSeconds
2424
<replica-set-read-preference-max-staleness>` option, and the
2525
:ref:`hedged read <read-preference-hedged-read>` option. :ref:`Hedged read
@@ -85,10 +85,10 @@ Read Preference Modes
8585
error or throw an exception.
8686

8787
The :readmode:`primary` read preference mode is not compatible with
88-
read preference modes that use :ref:`tag sets
88+
read preference modes that use :ref:`tag set lists
8989
<replica-set-read-preference-tag-sets>` or :ref:`maxStalenessSeconds
9090
<replica-set-read-preference-max-staleness>`.
91-
If you specify tag sets or a ``maxStalenessSeconds`` value
91+
If you specify tag set lists or a ``maxStalenessSeconds`` value
9292
with :readmode:`primary`, the driver will produce an error.
9393

9494
.. include:: /includes/extracts/transactions-read-pref.rst
@@ -99,7 +99,7 @@ Read Preference Modes
9999
of the set. However, if the primary is unavailable, as is the case
100100
during :term:`failover` situations, operations read from :term:`secondary`
101101
members that satisfy the read preference's ``maxStalenessSeconds`` and
102-
tag sets.
102+
tag set lists.
103103

104104
.. include:: /includes/extracts/maxStaleness-primaryPreferred.rst
105105

@@ -181,9 +181,9 @@ Read Preference Modes
181181
:ref:`acceptable latency window
182182
<replica-set-read-preference-behavior-nearest>`.
183183

184-
If you specify a :ref:`tag set
184+
If you specify a :ref:`tag set list
185185
<replica-set-read-preference-tag-sets>`, the client attempts to
186-
find a replica set member that matches the specified tag sets and
186+
find a replica set member that matches the specified tag set lists and
187187
directs reads to an arbitrary member from among the :ref:`nearest
188188
group <replica-set-read-preference-behavior-nearest>`.
189189

source/includes/extracts-read-preference-modes.yaml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -46,10 +46,10 @@ replacement:
4646
---
4747
ref: _tagSets
4848
content: |
49-
When the read preference includes a :ref:`tag set (i.e. a list of tag
50-
specifications) <replica-set-read-preference-tag-sets>`{{noPrimary}},
49+
When the read preference includes a :ref:`tag set list (an array of tag
50+
sets) <replica-set-read-preference-tag-sets>`{{noPrimary}},
5151
the client attempts to find secondary members with matching tags
52-
(trying the tag specifications in order until a match is found). If
52+
(trying the tag sets in order until a match is found). If
5353
matching secondaries are found, the client selects a
5454
random secondary from the :ref:`nearest group
5555
<replica-set-read-preference-behavior-nearest>` of matching
@@ -82,7 +82,7 @@ replacement:
8282
ref: _maxStaleness-and-tagSets
8383
content: |
8484
When the read preference includes a ``maxStalenessSeconds`` value
85-
**and** a tag set, the client filters by staleness first and
85+
**and** a tag set list, the client filters by staleness first and
8686
then by the specified tags. {{nearestBehavior}}
8787
---
8888
ref: maxStaleness-and-tagSets-general

source/includes/read-preference-modes-table.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@
4444
- The :ref:`maxStalenessSeconds
4545
<replica-set-read-preference-max-staleness>` read preference
4646
option
47-
- Any specified :doc:`tag sets
47+
- Any specified :doc:`tag set lists
4848
</tutorial/configure-replica-set-tag-sets>`
4949

5050
Starting in version 4.4, :readmode:`nearest` supports

0 commit comments

Comments
 (0)