Skip to content

Commit 1c83be4

Browse files
author
Dave
authored
DOCSP-19786 validate warning clarification v5.1 (#65)
* DOCSP-19786 validate warning clarification * Fix whitespace * Update tip * White space * Review updates * Remove tip * External feedback * Tweaks * Move primary note to warning
1 parent df894f8 commit 1c83be4

File tree

3 files changed

+28
-6
lines changed

3 files changed

+28
-6
lines changed

source/reference/method/db.collection.validate.txt

Lines changed: 25 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,6 @@ Syntax
3636

3737
.. note:: Changed in version 4.4
3838

39-
4039
:method:`db.collection.validate()` no longer accepts just a boolean
4140
parameter. See :ref:`4.4-validate-method-signature`.
4241

@@ -112,11 +111,31 @@ finishes.
112111

113112
.. warning::
114113

115-
Due to the performance impact of validation, consider running
116-
:method:`db.collection.validate()` only on :term:`secondary` replica
117-
set nodes. You can use :method:`rs.stepDown()` to instruct the
118-
current :term:`primary` node to become a secondary to avoid
119-
impacting a live primary node.
114+
Validation has exclusive lock requirements that affect performance
115+
on primaries and on secondaries that are servicing reads. Consider
116+
only running :method:`db.collection.validate()` on nodes that are
117+
not servicing reads or writes.
118+
119+
To minimize impact on the primary, the majority of the data-bearing
120+
(non-arbiter), voting members in the cluster must be available and
121+
must not have significant replication lag.
122+
123+
To minimize the impact of the validation operation on client
124+
applications, run :method:`db.collection.validate()` on a secondary
125+
node that is not servicing read requests. You can convert the
126+
current primary node to a secondary node, by running the
127+
:method:`rs.stepDown()` method.
128+
129+
To completely isolate the :method:`db.collection.validate()`
130+
operation from client traffic, choose one of the following options:
131+
132+
- Isolate a replica set member by following the :ref:`rolling
133+
maintenance procedure <perform-maint-on-replica-set>` to
134+
temporarily remove it from the cluster.
135+
- :ref:`Convert a secondary node
136+
<configure-hidden-replica-set-member>` to a replica set
137+
:ref:`hidden member <replica-set-hidden-members>` and perform the
138+
validation on the hidden node.
120139

121140
Data Throughput Metrics
122141
~~~~~~~~~~~~~~~~~~~~~~~

source/tutorial/configure-a-hidden-replica-set-member.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,7 @@ set its :rsconf:`members[n].hidden` value to
4747
"hidden" : true
4848
}
4949

50+
.. _configure-hidden-replica-set-member:
5051

5152
Configuration Procedure
5253
~~~~~~~~~~~~~~~~~~~~~~~

source/tutorial/perform-maintence-on-replica-set-members.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. _perform-maint-on-replica-set:
2+
13
==========================================
24
Perform Maintenance on Replica Set Members
35
==========================================

0 commit comments

Comments
 (0)