You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@james.apache.org by bt...@apache.org on 2021/04/08 03:57:01 UTC

[james-project] 11/12: JAMES-3435 Document mailbox.read.strong.consistency

This is an automated email from the ASF dual-hosted git repository.

btellier pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/james-project.git

commit db59e02645bee7d3b7e498d6420e866dce69ce11
Author: Benoit Tellier <bt...@linagora.com>
AuthorDate: Sun Mar 28 23:08:21 2021 +0700

    JAMES-3435 Document mailbox.read.strong.consistency
---
 .../servers/pages/distributed/configure/cassandra.adoc        | 11 +++++++++--
 src/site/xdoc/server/config-cassandra.xml                     | 11 +++++++++--
 2 files changed, 18 insertions(+), 4 deletions(-)

diff --git a/docs/modules/servers/pages/distributed/configure/cassandra.adoc b/docs/modules/servers/pages/distributed/configure/cassandra.adoc
index b9810d8..25c4789 100644
--- a/docs/modules/servers/pages/distributed/configure/cassandra.adoc
+++ b/docs/modules/servers/pages/distributed/configure/cassandra.adoc
@@ -185,16 +185,23 @@ Controls the number of messages to be retrieved in parallel.
 | Optional. Defaults to 102400 (100KB).
 Controls the size of blob parts used to store messages in the Cassandra blobStore.
 
+| mailbox.read.strong.consistency
+| Optional. Boolean, defaults to true. Disabling should be considered experimental.
+If enabled, regular consistency level is used for read transactions for mailbox. Not doing so might result
+in stale reads as the system.paxos table will not be checked for latest updates. Better performance are expected
+by turning it off. Note that reads performed as part of write transactions are always performed with a strong
+consistency.
+
 | message.read.strong.consistency
 | Optional. Boolean, defaults to true. Disabling should be considered experimental.
-If enabled, regular consistency level is used for read transactions for message. This might result
+If enabled, regular consistency level is used for read transactions for message. Not doing so might result
 in stale reads as the system.paxos table will not be checked for latest updates. Better performance are expected
 by turning it off. Note that reads performed as part of write transactions are always performed with a strong
 consistency.
 
 | message.write.strong.consistency.unsafe
 | Optional. Boolean, defaults to true. Disabling should be considered experimental and unsafe.
-If enabled, Lightweight transactions will no longer be used upon messages operation (table `imapUidTable`).
+If disabled, Lightweight transactions will no longer be used upon messages operation (table `imapUidTable`).
 As message flags updates relies so far on a read-before-write model, it exposes yourself to data races leading to
 potentially update loss. Better performance are expected
 by turning it off. Reads performed as part of write transaction are also performed with a relaxed consistency.
diff --git a/src/site/xdoc/server/config-cassandra.xml b/src/site/xdoc/server/config-cassandra.xml
index 904247f..f91ed83 100644
--- a/src/site/xdoc/server/config-cassandra.xml
+++ b/src/site/xdoc/server/config-cassandra.xml
@@ -149,16 +149,23 @@
         <dt><strong>mailbox.blob.part.size</strong></dt>
         <dd>Optional. Defaults to 102400 (100KB).<br/> Controls the size of blob parts used to store messages.</dd>
 
+        <dt><strong>mailbox.read.strong.consistency</strong></dt>
+        <dd>Optional. Boolean, defaults to true. Disabling should be considered experimental.
+            If enabled, regular consistency level is used for read transactions for mailbox. Not doing so might result
+            in stale reads as the system.paxos table will not be checked for latest updates. Better performance are expected
+            by turning it off. Note that reads performed as part of write transactions are always performed with a strong
+            consistency.</dd>
+
         <dt><strong>message.read.strong.consistency</strong></dt>
         <dd>Optional. Boolean, defaults to true. Disabling should be considered experimental.
-            If enabled, regular consistency level is used for read transactions for message. This might result
+            If enabled, regular consistency level is used for read transactions for message. Not doing so might result
             in stale reads as the system.paxos table will not be checked for latest updates. Better performance are expected
             by turning it off. Note that reads performed as part of write transactions are always performed with a strong
             consistency.</dd>
 
         <dt><strong>message.write.strong.consistency.unsafe</strong></dt>
         <dd>Optional. Boolean, defaults to true. Disabling should be considered experimental and unsafe.
-            If enabled, Lightweight transactions will no longer be used upon messages operation (table `imapUidTable`).
+            If disabled, Lightweight transactions will no longer be used upon messages operation (table `imapUidTable`).
             As message flags updates relies so far on a read-before-write model, it exposes yourself to data races leading to
             potentially update loss. Better performance are expected
             by turning it off. Reads performed as part of write transaction are also performed with a relaxed consistency.</dd>

---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@james.apache.org
For additional commands, e-mail: notifications-help@james.apache.org