This is an automated email from the ASF dual-hosted git repository.
He-Pin pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/pekko.git
The following commit(s) were added to refs/heads/main by this push:
new b1a028c2da docs: list the read consistency levels on the classic
Distributed Data page (#3594)
b1a028c2da is described below
commit b1a028c2daa46a8d9658e74234416d31402daf61
Author: PJ Fanning <[email protected]>
AuthorDate: Fri Oct 9 05:22:41 2026 +0100
docs: list the read consistency levels on the classic Distributed Data page
(#3594)
Motivation:
The Get section of distributed-data.md says "You supply a consistency
level which has the following meaning:" but the list of levels is
missing, so the sentence leads straight into the code snippet.
Modification:
Add the list of read consistency levels (ReadLocal/readLocal,
ReadFrom(n), ReadMajority, ReadMajorityPlus, ReadAll), adapted from the
typed Distributed Data page and matching the classic Replicator API,
and link to the typed page's Read consistency section for details.
Result:
The classic Get section explains the consistency levels it refers to.
Tests:
- Not run - docs only
References:
None - found during a review of the docs
---
docs/src/main/paradox/distributed-data.md | 12 ++++++++++++
1 file changed, 12 insertions(+)
diff --git a/docs/src/main/paradox/distributed-data.md
b/docs/src/main/paradox/distributed-data.md
index d9ae7a2f24..f40c6a2684 100644
--- a/docs/src/main/paradox/distributed-data.md
+++ b/docs/src/main/paradox/distributed-data.md
@@ -120,6 +120,18 @@ For the full documentation of this feature and for new
projects see @ref:[Distri
To retrieve the current value of a data you send
@apidoc[Replicator.Get](cluster.ddata.Replicator.Get) message to the
`Replicator`. You supply a consistency level which has the following meaning:
+ * @scala[`ReadLocal`]@java[`readLocal`] the value will only be read from the
local replica
+ * `ReadFrom(n)` the value will be read and merged from `n` replicas,
+ including the local replica
+ * `ReadMajority` the value will be read and merged from a majority of
replicas, i.e.
+ at least **N/2 + 1** replicas, where N is the number of nodes in the cluster
+ (or cluster role group)
+ * `ReadMajorityPlus` is like `ReadMajority` but with the given number of
`additional` nodes added
+ to the majority count. At most all nodes.
+ * `ReadAll` the value will be read and merged from all nodes in the cluster
(or all nodes in the cluster role group)
+
+See @ref:[Read consistency](typed/distributed-data.md#read-consistency) for
more details.
+
Scala
: @@snip
[DistributedDataDocSpec.scala](/docs/src/test/scala/docs/ddata/DistributedDataDocSpec.scala)
{ #get }
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
