Skip to content

Commit 1c5cf55

Browse files
committed
CDRIVER-2229 link to docs for causal consistency
1 parent bb977d1 commit 1c5cf55

File tree

3 files changed

+3
-3
lines changed

3 files changed

+3
-3
lines changed

doc/includes/session-lifecycle.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
Start a session with :symbol:`mongoc_client_start_session`, use the session for a sequence of operations, then free it with :symbol:`mongoc_client_session_destroy()`. A session must be freed before the :symbol:`mongoc_client_t` it came from.
22

3-
By default, sessions are causally consistent. To disable causal consistency, before starting a session create a :symbol:`mongoc_session_opt_t` with :symbol:`mongoc_session_opts_new()` and call :symbol:`mongoc_session_opts_set_causal_consistency()`, then free the struct with :symbol:`mongoc_session_opts_destroy`.
3+
By default, sessions are `causally consistent <http://dochub.mongodb.org/core/causal-consistency>`_. To disable causal consistency, before starting a session create a :symbol:`mongoc_session_opt_t` with :symbol:`mongoc_session_opts_new()` and call :symbol:`mongoc_session_opts_set_causal_consistency()`, then free the struct with :symbol:`mongoc_session_opts_destroy`.
44

55
Unacknowledged writes are not causally consistent. If you execute a write operation with a :symbol:`mongoc_write_concern_t` on which you have called :symbol:`mongoc_write_concern_set_w` with a value of 0, the write does not participate in causal consistency.
66

doc/mongoc_client_session_t.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
mongoc_client_session_t
55
=======================
66

7-
Use a session for a sequence of operations, optionally with causal consistency.
7+
Use a session for a sequence of operations, optionally with causal consistency. See `the MongoDB Manual Entry for Causal Consistency <http://dochub.mongodb.org/core/causal-consistency>`_.
88

99
Synopsis
1010
--------

doc/mongoc_session_opts_set_causal_consistency.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Synopsis
1212
mongoc_session_opts_set_causal_consistency (mongoc_session_opt_t *opts,
1313
bool causal_consistency);
1414
15-
Configure causal consistency in a session. If true (the default), each operation in the session will be causally ordered after the previous read or write operation. Set to false to disable causal consistency.
15+
Configure causal consistency in a session. If true (the default), each operation in the session will be causally ordered after the previous read or write operation. Set to false to disable causal consistency. See `the MongoDB Manual Entry for Causal Consistency <http://dochub.mongodb.org/core/causal-consistency>`_.
1616

1717
Unacknowledged writes are not causally consistent. If you execute a write operation with a :symbol:`mongoc_write_concern_t` on which you have called :symbol:`mongoc_write_concern_set_w` with a value of 0, the write does not participate in causal consistency.
1818

0 commit comments

Comments
 (0)