XAUTOCLAIM

Changes the ownership of pending messages from one consumer to another in a stream consumer group automatically.

1 min read

Arguments#

keystrrequired#

The key of the stream.

groupstrrequired#

The consumer group name.

consumerstrrequired#

The consumer name that will claim the messages.

min_idle_timeintrequired#

The minimum idle time in milliseconds for messages to be claimed.

startstrrequired#

The stream entry ID to start claiming from.

countint#

The maximum number of messages to claim.

justidbool#

Return only the message IDs instead of the full message data.

Response#

XADD XCLAIM

# Auto-claim messages that have been idle for more than 60 secondsresult = redis.xautoclaim(    "mystream",    "mygroup",     "consumer1",    60000,  # 60 seconds    start="0-0")

[  "1638360173533-1",  # next start ID  [["1638360173533-0", ["field1", "value1", "field2", "value2"]]],  # claimed messages  []  # deleted message IDs]