Skip to content

Commit

Permalink
[Issue 5309][docs] Clarify wording around retention policies (apache#…
Browse files Browse the repository at this point in the history
…5482)

* [Issue 5309][docs] Clarify wording around retention policies

Fixes apache#5309

Docs are confusing.

Replaced retention wording to make distinction between acked and
non-acked messages clearer.

* [Issue 5309][docs] Remove TODO
  • Loading branch information
rocketraman authored and Jennifer88huang-zz committed Oct 30, 2019
1 parent de4bbe1 commit 418362e
Showing 1 changed file with 1 addition and 3 deletions.
4 changes: 1 addition & 3 deletions site2/docs/cookbooks-retention-expiry.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,7 @@ By default, when a Pulsar message arrives at a broker it will be stored until it

Retention policies are particularly useful if you intend to exclusively use the Reader interface. Because the Reader interface does not use acknowledgements, messages will never exist within backlogs. Most realistic Reader-only use cases require that retention be configured.

When you set a size limit of, say, 10 gigabytes, then messages in all topics in the namespace, *even acknowledged messages*, will be retained until the size limit for the topic is reached; if you set a time limit of, say, 1 day, then messages for all topics in the namespace will be retained for 24 hours.

TODO: Confirm this behavior?
When you set a size limit of, say, 10 gigabytes, then acknowledged messages in all topics in the namespace will be retained until the size limit for the topic is reached; if you set a time limit of, say, 1 day, then acknowledged messages for all topics in the namespace will be retained for 24 hours. The retention settings apply to all messages on topics that do not have any subscriptions, or if there are subscriptions, to messages that have been acked by all subscriptions. The retention policy settings do not affect unacknowledged messages on topics with subscriptions -- these are instead controlled by the backlog quota (see below).

When a retention limit is exceeded, the oldest message is marked for deletion until the set of retained messages falls within the specified limits again.

Expand Down

0 comments on commit 418362e

Please sign in to comment.