diff options
Diffstat (limited to 'iredis/data/commands/xinfo-consumers.md')
-rw-r--r-- | iredis/data/commands/xinfo-consumers.md | 29 |
1 files changed, 29 insertions, 0 deletions
diff --git a/iredis/data/commands/xinfo-consumers.md b/iredis/data/commands/xinfo-consumers.md new file mode 100644 index 0000000..f65366d --- /dev/null +++ b/iredis/data/commands/xinfo-consumers.md @@ -0,0 +1,29 @@ +This command returns the list of consumers that belong to the `<groupname>` consumer group of the stream stored at `<key>`. + +The following information is provided for each consumer in the group: + +* **name**: the consumer's name +* **pending**: the number of pending messages for the client, which are messages that were delivered but are yet to be acknowledged +* **idle**: the number of milliseconds that have passed since the consumer last interacted with the server + +@reply + +@array-reply: a list of consumers. + +@examples + +``` +> XINFO CONSUMERS mystream mygroup +1) 1) name + 2) "Alice" + 3) pending + 4) (integer) 1 + 5) idle + 6) (integer) 9104628 +2) 1) name + 2) "Bob" + 3) pending + 4) (integer) 1 + 5) idle + 6) (integer) 83841983 +``` |