Skip to content

DOCSP-47041: Causal consistency #623

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 8 commits into from
Feb 28, 2025
Merged
Changes from 5 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
62 changes: 54 additions & 8 deletions source/crud/transactions.txt
Original file line number Diff line number Diff line change
Expand Up @@ -28,14 +28,10 @@ error, the driver cancels the transaction and discards all data changes
before they ever become visible.

In MongoDB, transactions run within logical **sessions**. A
:manual:`session </reference/server-sessions/>` is a grouping of related
read or write operations that you intend to run sequentially. Sessions
enable :manual:`causal consistency
</core/read-isolation-consistency-recency/#causal-consistency>` for a
group of operations or allow you to execute operations in an
:website:`ACID transaction </basics/acid-transactions>`. MongoDB
guarantees that the data involved in your transaction operations remains
consistent, even if the operations encounter unexpected errors.
session is a grouping of related read or write operations that you
intend to run sequentially. Sessions allow you to run operations
in an ACID-compliant transaction, which is a transaction that meets
an expectation of atomicity, consistency, isolation, and durability.

When using the {+driver-short+}, you can create a new session from a
``MongoClient`` instance as a ``ClientSession`` type. We recommend that you reuse
Expand All @@ -54,6 +50,56 @@ instantiating a new client each time.
You must include the ``session`` as a parameter for any operations that you
want to include in a transaction.

Causal Consistency
~~~~~~~~~~~~~~~~~~

MongoDB enables **causal consistency** in client sessions.
The causal consistency model guarantees that operations within a session
run in a causal order. Additionally, clients observe results that
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: Not sure that "additionally" is necessary here

Suggested change
run in a causal order. Additionally, clients observe results that
run in a causal order. Clients observe results that

are consistent with the causal relationships, or the dependencies between
operations. If you perform a series of operations where one operation
logically depends on the result of another, any subsequent
reads reflect the dependent relationship.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

S: Clarify that this is giving an example of the preceding descriptions

Suggested change
operations. If you perform a series of operations where one operation
logically depends on the result of another, any subsequent
reads reflect the dependent relationship.
operations. For example, if you perform a series of operations where one operation
logically depends on the result of another, any subsequent
reads reflect the dependent relationship.


The following table describes the guarantees that causally
consistent sessions provide:

.. list-table::
:widths: 40 60
:header-rows: 1

* - Guarantee
- Description

* - Read your writes
- Read operations reflect the results of preceding write operations.

* - Monotonic reads
- Read operations do not return results that reflect an earlier data state than
a preceding read operation.

* - Monotonic writes
- The driver runs write operations that logically must precede other write operations
before these dependent writes.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This was a little confusing to me. Would it make sense to simplify it to something like this?

Suggested change
- The driver runs write operations that logically must precede other write operations
before these dependent writes.
- The driver runs write operations before first when they logically must precede other write operations.

An example might help make this more clear as well


* - Writes follow reads
- The driver runs write operations that logically must follow other read operations
after these reads.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Similar to the above, could this be simplified and/or have an example added?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I reworded and added an example, let me know what you think!


In a causally consistent session, MongoDB ensures a
causal relationship between the following operations:

- Read operations that have a ``MAJORITY`` read concern
- Write operations that have a ``MAJORITY`` write concern

.. tip::

To learn more about the concepts mentioned in this section, see the
following {+mdb-server+} manual entries:

- :manual:`Causal Consistency </core/read-isolation-consistency-recency/#causal-consistency>`
- :manual:`Causal Consistency and Read and Write Concerns </core/causal-consistency-read-write-concerns/>`

Methods
-------

Expand Down
Loading