Skip to main content

​
Arguments

​
group
str
required
The consumer group name.
​
consumer
str
required
The consumer name within the group.
​
streams
Dict[str, str]
required
A dictionary mapping stream keys to their starting IDs. Use ”>” to read messages never delivered to any consumer in the group.
​
count
int
The maximum number of messages to return per stream.
​
noack
bool
Don’t add messages to the pending entries list (messages won’t need acknowledgment).

​
Response

Returns a list where each element represents a stream and contains:
  • The stream key
  • A list of messages (ID and field-value pairs)
Returns empty list if no data is available.
result = redis.xreadgroup("mygroup", "consumer1", {"mystream": ">"})

[
  ["mystream", [
    ["1638360173533-0", ["field", "value1"]],
    ["1638360173533-1", ["field", "value2"]]
  ]]
]
⌘I