Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add description for XREAD new '+' special ID for last stream entry (#… #2687

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

ronen-kalish
Copy link

@ronen-kalish ronen-kalish commented Mar 13, 2024

Adding description of the '+' new special stream ID for the XREAD command.
see redis/redis#13117

Copy link

netlify bot commented Mar 13, 2024

👷 Deploy request for redis-doc pending review.

Visit the deploys page to approve it

Name Link
🔨 Latest commit 4ba326a

requesting the last available entry in a stream. For example:

```
> XREAD STREAM streamA streamB streamC streamD + + + +
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

do we want to mention that the pattern is usually that you start iterating on a stream with + and then switch to $ on the next call?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't know if this is the common use-case, maybe sometimes users just need to peep at the last element and don't continue from there. But I can add a mention if you think it's required.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@majklik, @guybe7 please advise.

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One nice use case is the mentioned peek fro last value in multiple streams. In this case is perfect one time shoot with: XREAD STREAM streamA streamB streamC streamD + + + +
But for reliable reading of the content of streams, when I need to start from the last available value (which is my case), after the initial "XREAD STREAM streamA streamB streamC streamD + + + +" it is convenient to continue with the obtained IDs from the streams in the style: "XREAD STREAM streamA streamB streamC streamD idA idB idC idD". If the initial reading shows that one of the streams is empty, I will use 0 as the id for subsequent readings.

@oranagra oranagra added the to-be-merged should probably be merged soon label Mar 13, 2024
@CLAassistant
Copy link

CLAassistant commented Mar 21, 2024

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you all sign our Contributor License Agreement before we can accept your contribution.
1 out of 2 committers have signed the CLA.

✅ ronen-kalish
❌ oranagra
You have signed the CLA already but the status is still pending? Let us recheck it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
to-be-merged should probably be merged soon
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants