XCLAIM

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

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.

idsstrrequired#

The ID(s) of the message(s) to claim. Can be multiple IDs as separate arguments.

justidbool#

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

Response#

XAUTOCLAIM XDEL

# Claim messages that have been idle for more than 60 secondsresult = redis.xclaim(    "mystream",    "mygroup",    "consumer1",    60000,  # 60 seconds    "1638360173533-0", "1638360173533-1")

[  ["1638360173533-0", ["field1", "value1", "field2", "value2"]],  ["1638360173533-1", ["field1", "value3", "field2", "value4"]]]