XPENDING

Returns information about pending messages in a stream consumer group.

1 min read

Arguments#

keystrrequired#

The key of the stream.

groupstrrequired#

The consumer group name.

startstr#

The minimum pending ID to return (use with end and count).

endstr#

The maximum pending ID to return (use with start and count).

countint#

The maximum number of pending messages to return.

consumerstr#

Filter results by a specific consumer.

idleint#

Filter by minimum idle time in milliseconds.

Response#

XLEN XRANGE

result = redis.xpending("mystream", "mygroup")

[  2,  # total pending count  "1638360173533-0",  # smallest pending ID  "1638360173533-1",  # greatest pending ID  [["consumer1", "2"]]  # consumers and their pending counts]