Skip to content

Commit 7338740

Browse files
Update xreadgroup.md to clarify entry deletion (#2412)
* Update xreadgroup.md to clarify entry deletion Clarify the conditions under which entries can be deleted from the stream, including trimming and explicit deletion commands. * Fix formatting and punctuation in xreadgroup.md * Update content/commands/xreadgroup.md --------- Co-authored-by: David Dougherty <[email protected]>
1 parent f93c8a6 commit 7338740

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

content/commands/xreadgroup.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -232,8 +232,12 @@ To see how the command actually replies, please check the [`XREAD`]({{< relref "
232232

233233
## What happens when a pending message is deleted?
234234

235-
Entries may be deleted from the stream due to trimming or explicit calls to [`XDEL`]({{< relref "/commands/xdel" >}}) at any time.
236-
By design, Redis doesn't prevent the deletion of entries that are present in the stream's PELs.
235+
Entries may be deleted from the stream due to trimming with [`XADD`]({{< relref "/commands/xall" >}}) or [`XTRIM`]({{< relref "/commands/xtrim" >}}),
236+
or explicit calls to [`XDEL`]({{< relref "/commands/xdel" >}}), [`XDELEX`]({{< relref "/commands/xdelex" >}}), or [`XACKDEL`]({{< relref "/commands/xackdel" >}}).
237+
238+
When an entry is trimmed with [`XADD`]({{< relref "/commands/xall" >}}) or [`XTRIM`]({{< relref "/commands/xtrim" >}}) and `DELREF` or `ACKED` are not specified,
239+
deleted with [`XDEL`]({{< relref "/commands/xdel" >}}), or deleted with [`XDELEX`]({{< relref "/commands/xdelex" >}}) or [`XACKDEL`]({{< relref "/commands/xackdel" >}})
240+
and `DELREF` or `ACKED` are not specified, Redis doesn't prevent the deletion of entries that are present in the stream's PELs.
237241
When this happens, the PELs retain the deleted entries' IDs, but the actual entry payload is no longer available.
238242
Therefore, when reading such PEL entries, Redis will return a null value in place of their respective data.
239243

0 commit comments

Comments
 (0)