This is an automated email from the ASF dual-hosted git repository.
sijie pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/pulsar.git
The following commit(s) were added to refs/heads/master by this push:
new 73c013e [docs] improve statement on ordering guarantees for
multi-topic subscriptions (#6132)
73c013e is described below
commit 73c013eba4e452aaeb811991733e9b1620ae4093
Author: EugenDueck <eu...@dueck.org>
AuthorDate: Sat Jan 25 12:31:21 2020 +0900
[docs] improve statement on ordering guarantees for multi-topic
subscriptions (#6132)
### Motivation
*The statement "ordering guarantees [..] on single topics do not hold" on
https://pulsar.apache.org/docs/en/concepts-messaging/#no-ordering-guarantees
can lead readers to believe that messages on the same topic are not guaranteed
to be delivered in order, which I believe to be false, as discussed in this
thread https://apache-pulsar.slack.com/archives/C5Z4T36F7/p1578264274257300*
### Modifications
*I've applied the same change of wording to the current
`site2/docs/concepts-messaging.md` and all the various versions under
`site2/website/versioned_docs/`, as this is independent of the version.*
#5995
---
site2/docs/concepts-messaging.md | 6 +++---
.../versioned_docs/version-2.1.0-incubating/concepts-messaging.md | 4 ++--
site2/website/versioned_docs/version-2.3.0/concepts-messaging.md | 4 ++--
site2/website/versioned_docs/version-2.3.1/concepts-messaging.md | 4 ++--
site2/website/versioned_docs/version-2.3.2/concepts-messaging.md | 4 ++--
site2/website/versioned_docs/version-2.4.0/concepts-messaging.md | 4 ++--
site2/website/versioned_docs/version-2.4.1/concepts-messaging.md | 4 ++--
site2/website/versioned_docs/version-2.4.2/concepts-messaging.md | 4 ++--
site2/website/versioned_docs/version-2.5.0/concepts-messaging.md | 4 ++--
9 files changed, 19 insertions(+), 19 deletions(-)
diff --git a/site2/docs/concepts-messaging.md b/site2/docs/concepts-messaging.md
index f950701..b6f49c3 100644
--- a/site2/docs/concepts-messaging.md
+++ b/site2/docs/concepts-messaging.md
@@ -239,8 +239,8 @@ When a consumer subscribes to a Pulsar topic, by default it
subscribes to one sp
When subscribing to multiple topics, the Pulsar client will automatically make
a call to the Pulsar API to discover the topics that match the regex
pattern/list and then subscribe to all of them. If any of the topics don't
currently exist, the consumer will auto-subscribe to them once the topics are
created.
-> #### No ordering guarantees
-> When a consumer subscribes to multiple topics, all ordering guarantees
normally provided by Pulsar on single topics do not hold. If your use case for
Pulsar involves any strict ordering requirements, we would strongly recommend
against using this feature.
+> #### No ordering guarantees across multiple topics
+> When a producer sends messages to a single topic, all messages are
guaranteed to be read from that topic in the same order. However, these
guarantees do not hold across multiple topics. So when a producer sends message
to multiple topics, the order in which messages are read from those topics is
not guaranteed to be the same.
Here are some multi-topic subscription examples for Java:
@@ -454,4 +454,4 @@ The following is an example of delayed message delivery for
a producer in Java:
```java
// message to be delivered at the configured delay interval
producer.newMessage().deliverAfter(3L, TimeUnit.Minute).value("Hello
Pulsar!").send();
-```
\ No newline at end of file
+```
diff --git
a/site2/website/versioned_docs/version-2.1.0-incubating/concepts-messaging.md
b/site2/website/versioned_docs/version-2.1.0-incubating/concepts-messaging.md
index 9b0caf3..1df8f92 100644
---
a/site2/website/versioned_docs/version-2.1.0-incubating/concepts-messaging.md
+++
b/site2/website/versioned_docs/version-2.1.0-incubating/concepts-messaging.md
@@ -150,8 +150,8 @@ When a consumer subscribes to a Pulsar topic, by default it
subscribes to one sp
When subscribing to multiple topics, the Pulsar client will automatically make
a call to the Pulsar API to discover the topics that match the regex
pattern/list and then subscribe to all of them. If any of the topics don't
currently exist, the consumer will auto-subscribe to them once the topics are
created.
-> #### No ordering guarantees
-> When a consumer subscribes to multiple topics, all ordering guarantees
normally provided by Pulsar on single topics do not hold. If your use case for
Pulsar involves any strict ordering requirements, we would strongly recommend
against using this feature.
+> #### No ordering guarantees across multiple topics
+> When a producer sends messages to a single topic, all messages are
guaranteed to be read from that topic in the same order. However, these
guarantees do not hold across multiple topics. So when a producer sends message
to multiple topics, the order in which messages are read from those topics is
not guaranteed to be the same.
Here are some multi-topic subscription examples for Java:
diff --git a/site2/website/versioned_docs/version-2.3.0/concepts-messaging.md
b/site2/website/versioned_docs/version-2.3.0/concepts-messaging.md
index 015d00c..2ecc6ef 100644
--- a/site2/website/versioned_docs/version-2.3.0/concepts-messaging.md
+++ b/site2/website/versioned_docs/version-2.3.0/concepts-messaging.md
@@ -151,8 +151,8 @@ When a consumer subscribes to a Pulsar topic, by default it
subscribes to one sp
When subscribing to multiple topics, the Pulsar client will automatically make
a call to the Pulsar API to discover the topics that match the regex
pattern/list and then subscribe to all of them. If any of the topics don't
currently exist, the consumer will auto-subscribe to them once the topics are
created.
-> #### No ordering guarantees
-> When a consumer subscribes to multiple topics, all ordering guarantees
normally provided by Pulsar on single topics do not hold. If your use case for
Pulsar involves any strict ordering requirements, we would strongly recommend
against using this feature.
+> #### No ordering guarantees across multiple topics
+> When a producer sends messages to a single topic, all messages are
guaranteed to be read from that topic in the same order. However, these
guarantees do not hold across multiple topics. So when a producer sends message
to multiple topics, the order in which messages are read from those topics is
not guaranteed to be the same.
Here are some multi-topic subscription examples for Java:
diff --git a/site2/website/versioned_docs/version-2.3.1/concepts-messaging.md
b/site2/website/versioned_docs/version-2.3.1/concepts-messaging.md
index acf6a8a..715ec19 100644
--- a/site2/website/versioned_docs/version-2.3.1/concepts-messaging.md
+++ b/site2/website/versioned_docs/version-2.3.1/concepts-messaging.md
@@ -151,8 +151,8 @@ When a consumer subscribes to a Pulsar topic, by default it
subscribes to one sp
When subscribing to multiple topics, the Pulsar client will automatically make
a call to the Pulsar API to discover the topics that match the regex
pattern/list and then subscribe to all of them. If any of the topics don't
currently exist, the consumer will auto-subscribe to them once the topics are
created.
-> #### No ordering guarantees
-> When a consumer subscribes to multiple topics, all ordering guarantees
normally provided by Pulsar on single topics do not hold. If your use case for
Pulsar involves any strict ordering requirements, we would strongly recommend
against using this feature.
+> #### No ordering guarantees across multiple topics
+> When a producer sends messages to a single topic, all messages are
guaranteed to be read from that topic in the same order. However, these
guarantees do not hold across multiple topics. So when a producer sends message
to multiple topics, the order in which messages are read from those topics is
not guaranteed to be the same.
Here are some multi-topic subscription examples for Java:
diff --git a/site2/website/versioned_docs/version-2.3.2/concepts-messaging.md
b/site2/website/versioned_docs/version-2.3.2/concepts-messaging.md
index 6e5d4ba..4bef883 100644
--- a/site2/website/versioned_docs/version-2.3.2/concepts-messaging.md
+++ b/site2/website/versioned_docs/version-2.3.2/concepts-messaging.md
@@ -206,8 +206,8 @@ When a consumer subscribes to a Pulsar topic, by default it
subscribes to one sp
When subscribing to multiple topics, the Pulsar client will automatically make
a call to the Pulsar API to discover the topics that match the regex
pattern/list and then subscribe to all of them. If any of the topics don't
currently exist, the consumer will auto-subscribe to them once the topics are
created.
-> #### No ordering guarantees
-> When a consumer subscribes to multiple topics, all ordering guarantees
normally provided by Pulsar on single topics do not hold. If your use case for
Pulsar involves any strict ordering requirements, we would strongly recommend
against using this feature.
+> #### No ordering guarantees across multiple topics
+> When a producer sends messages to a single topic, all messages are
guaranteed to be read from that topic in the same order. However, these
guarantees do not hold across multiple topics. So when a producer sends message
to multiple topics, the order in which messages are read from those topics is
not guaranteed to be the same.
Here are some multi-topic subscription examples for Java:
diff --git a/site2/website/versioned_docs/version-2.4.0/concepts-messaging.md
b/site2/website/versioned_docs/version-2.4.0/concepts-messaging.md
index 9b91235..c110ccf 100644
--- a/site2/website/versioned_docs/version-2.4.0/concepts-messaging.md
+++ b/site2/website/versioned_docs/version-2.4.0/concepts-messaging.md
@@ -206,8 +206,8 @@ When a consumer subscribes to a Pulsar topic, by default it
subscribes to one sp
When subscribing to multiple topics, the Pulsar client will automatically make
a call to the Pulsar API to discover the topics that match the regex
pattern/list and then subscribe to all of them. If any of the topics don't
currently exist, the consumer will auto-subscribe to them once the topics are
created.
-> #### No ordering guarantees
-> When a consumer subscribes to multiple topics, all ordering guarantees
normally provided by Pulsar on single topics do not hold. If your use case for
Pulsar involves any strict ordering requirements, we would strongly recommend
against using this feature.
+> #### No ordering guarantees across multiple topics
+> When a producer sends messages to a single topic, all messages are
guaranteed to be read from that topic in the same order. However, these
guarantees do not hold across multiple topics. So when a producer sends message
to multiple topics, the order in which messages are read from those topics is
not guaranteed to be the same.
Here are some multi-topic subscription examples for Java:
diff --git a/site2/website/versioned_docs/version-2.4.1/concepts-messaging.md
b/site2/website/versioned_docs/version-2.4.1/concepts-messaging.md
index d76ade6..b67ca93 100644
--- a/site2/website/versioned_docs/version-2.4.1/concepts-messaging.md
+++ b/site2/website/versioned_docs/version-2.4.1/concepts-messaging.md
@@ -227,8 +227,8 @@ When a consumer subscribes to a Pulsar topic, by default it
subscribes to one sp
When subscribing to multiple topics, the Pulsar client will automatically make
a call to the Pulsar API to discover the topics that match the regex
pattern/list and then subscribe to all of them. If any of the topics don't
currently exist, the consumer will auto-subscribe to them once the topics are
created.
-> #### No ordering guarantees
-> When a consumer subscribes to multiple topics, all ordering guarantees
normally provided by Pulsar on single topics do not hold. If your use case for
Pulsar involves any strict ordering requirements, we would strongly recommend
against using this feature.
+> #### No ordering guarantees across multiple topics
+> When a producer sends messages to a single topic, all messages are
guaranteed to be read from that topic in the same order. However, these
guarantees do not hold across multiple topics. So when a producer sends message
to multiple topics, the order in which messages are read from those topics is
not guaranteed to be the same.
Here are some multi-topic subscription examples for Java:
diff --git a/site2/website/versioned_docs/version-2.4.2/concepts-messaging.md
b/site2/website/versioned_docs/version-2.4.2/concepts-messaging.md
index 3d6f0f7..4758e9c 100644
--- a/site2/website/versioned_docs/version-2.4.2/concepts-messaging.md
+++ b/site2/website/versioned_docs/version-2.4.2/concepts-messaging.md
@@ -227,8 +227,8 @@ When a consumer subscribes to a Pulsar topic, by default it
subscribes to one sp
When subscribing to multiple topics, the Pulsar client will automatically make
a call to the Pulsar API to discover the topics that match the regex
pattern/list and then subscribe to all of them. If any of the topics don't
currently exist, the consumer will auto-subscribe to them once the topics are
created.
-> #### No ordering guarantees
-> When a consumer subscribes to multiple topics, all ordering guarantees
normally provided by Pulsar on single topics do not hold. If your use case for
Pulsar involves any strict ordering requirements, we would strongly recommend
against using this feature.
+> #### No ordering guarantees across multiple topics
+> When a producer sends messages to a single topic, all messages are
guaranteed to be read from that topic in the same order. However, these
guarantees do not hold across multiple topics. So when a producer sends message
to multiple topics, the order in which messages are read from those topics is
not guaranteed to be the same.
Here are some multi-topic subscription examples for Java:
diff --git a/site2/website/versioned_docs/version-2.5.0/concepts-messaging.md
b/site2/website/versioned_docs/version-2.5.0/concepts-messaging.md
index 86fae65..0bbe5ec 100644
--- a/site2/website/versioned_docs/version-2.5.0/concepts-messaging.md
+++ b/site2/website/versioned_docs/version-2.5.0/concepts-messaging.md
@@ -227,8 +227,8 @@ When a consumer subscribes to a Pulsar topic, by default it
subscribes to one sp
When subscribing to multiple topics, the Pulsar client will automatically make
a call to the Pulsar API to discover the topics that match the regex
pattern/list and then subscribe to all of them. If any of the topics don't
currently exist, the consumer will auto-subscribe to them once the topics are
created.
-> #### No ordering guarantees
-> When a consumer subscribes to multiple topics, all ordering guarantees
normally provided by Pulsar on single topics do not hold. If your use case for
Pulsar involves any strict ordering requirements, we would strongly recommend
against using this feature.
+> #### No ordering guarantees across multiple topics
+> When a producer sends messages to a single topic, all messages are
guaranteed to be read from that topic in the same order. However, these
guarantees do not hold across multiple topics. So when a producer sends message
to multiple topics, the order in which messages are read from those topics is
not guaranteed to be the same.
Here are some multi-topic subscription examples for Java:
