Skip to content

Commit bd3f609

Browse files
jason-price-mongodbjason-price-mongodb
andauthored
DOCSP-24523-read-concern-definition (#1755)
* DOCSP-24523-read-concern-definition * DOCSP-24523-read-concern-definition * DOCSP-24523-read-concern-definition * DOCSP-24523-read-concern-definition * DOCSP-24523-read-concern-definition * DOCSP-24523-read-concern-definition * DOCSP-24523-read-concern-definition * DOCSP-24523-read-concern-definition * DOCSP-24523-read-concern-definition Co-authored-by: jason-price-mongodb <[email protected]>
1 parent 06cc8fe commit bd3f609

File tree

4 files changed

+15
-8
lines changed

4 files changed

+15
-8
lines changed
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
A snapshot is a complete copy of the data in a :binary:`mongod` instance
2+
at a specific point in time. You can retrieve snapshot metadata for the
3+
whole cluster or replica set, or for a single config server in a
4+
cluster. For more details, see `snapshots
5+
<https://www.mongodb.com/docs/cloud-manager/reference/api/snapshots>`__.

source/reference/glossary.txt

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1002,6 +1002,9 @@ Glossary
10021002
consistency and is the replication topology employed by MongoDB.
10031003
See :doc:`/core/replica-set-primary`.
10041004

1005+
snapshot
1006+
.. include:: /includes/snapshot-definition.rst
1007+
10051008
snappy
10061009
A compression/decompression library designed to balance
10071010
efficient computation requirements with reasonable compression rates.

source/reference/read-concern-snapshot.txt

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,14 +21,16 @@ Read Concern ``"snapshot"``
2121
.. versionadded:: 4.0
2222
.. versionchanged:: 5.0
2323

24+
.. include:: /includes/snapshot-definition.rst
25+
2426
Read concern ``"snapshot"`` is available for :doc:`multi-document
2527
transactions </core/transactions>`, and starting in MongoDB 5.0, certain
2628
read operations outside of multi-document transactions.
2729

2830
- If the transaction is not part of a :ref:`causally consistent session
2931
<sessions>`, upon transaction commit with write concern
3032
:writeconcern:`"majority"`, the transaction operations are guaranteed
31-
to have read from a snapshot of majority-committed data.
33+
to have read from a :term:`snapshot` of majority-committed data.
3234

3335
- If the transaction is part of a :ref:`causally consistent session
3436
<sessions>`, upon transaction commit with write concern

source/reference/read-concern.txt

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,6 @@ of consistency and availability guarantees as appropriate, such as
2222
waiting for stronger consistency guarantees, or loosening consistency
2323
requirements to provide higher availability.
2424

25-
2625
MongoDB drivers updated for MongoDB 3.2 or later support specifying
2726
read concern.
2827

@@ -161,12 +160,14 @@ The following read concern levels are available:
161160

162161
* - :readconcern:`"snapshot"`
163162

164-
- | If a transaction is not part of a :ref:`causally consistent
163+
- .. include:: /includes/snapshot-definition.rst
164+
165+
| If a transaction is not part of a :ref:`causally consistent
165166
session <sessions>`, upon transaction commit with write
166167
concern :writeconcern:`"majority"`, the transaction operations
167168
are guaranteed to have read from a snapshot of
168169
majority-committed data.
169-
170+
170171
| If a transaction is part of a :ref:`causally consistent
171172
session <sessions>`, upon transaction commit with write
172173
concern :writeconcern:`"majority"`, the transaction operations
@@ -190,8 +191,6 @@ The following read concern levels are available:
190191
All other read operations prohibit
191192
:readconcern:`"snapshot"`.
192193

193-
194-
195194
.. include:: /includes/fact-readConcern-most-recent-data-in-node.rst
196195

197196
For more information on each read concern level, see:
@@ -203,7 +202,6 @@ For more information on each read concern level, see:
203202
- :doc:`/reference/read-concern-snapshot`
204203
- :doc:`/reference/mongodb-defaults`
205204

206-
207205
``readConcern`` Support
208206
-----------------------
209207

@@ -268,7 +266,6 @@ concern.
268266
For more information, see :ref:`Transaction Read Concern
269267
<transactions-read-concern>`.
270268

271-
272269
Causally Consistent Sessions and Available Read Concerns
273270
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
274271

0 commit comments

Comments
 (0)