XINFO STREAM

Syntax

  1. XINFO STREAM key [FULL [COUNT count]]

ACL categories: @read, @stream, @slow

XINFO STREAM command returns information about the stream stored at <key>.

The informative details provided by this command are:

  • length: the number of entries in the stream (see XLEN)
  • radix-tree-keys: the number of keys in the underlying radix data structure
  • radix-tree-nodes: the number of nodes in the underlying radix data structure
  • groups: the number of consumer groups defined for the stream
  • last-generated-id: the ID of the least-recently entry that was added to the stream
  • max-deleted-entry-id: the maximal entry ID that was deleted from the stream
  • entries-added: the count of all entries added to the stream during its lifetime
  • first-entry: the ID and field-value tuples of the first entry in the stream
  • last-entry: the ID and field-value tuples of the last entry in the stream

The optional FULL modifier provides a more verbose reply. When provided, the FULL reply includes an entries array that consists of the stream entries (ID and field-value tuples) in ascending order. Furthermore, groups is also an array, and for each of the consumer groups it consists of the information reported by XINFO GROUPS and XINFO CONSUMERS.

The COUNT option can be used to limit the number of stream and PEL entries that are returned (The first <count> entries are returned). The default COUNT is 10 and a COUNT of 0 means that all entries will be returned (execution time may be long if the stream has a lot of entries).

Return

Array reply: a list of informational bits.

Example

  1. dragonfly> XINFO STREAM mystream
  2.  1) "length"
  3.  2) (integer) 2
  4.  3) "radix-tree-keys"
  5.  4) (integer) 1
  6.  5) "radix-tree-nodes"
  7.  6) (integer) 2
  8.  7) "last-generated-id"
  9.  8) "1638125141232-0"
  10.  9) "max-deleted-entry-id"
  11. 10) "0-0"
  12. 11) "entries-added"
  13. 12) (integer) 2
  14. 13) "groups"
  15. 14) (integer) 1
  16. 15) "first-entry"
  17. 16) 1) "1638125133432-0"
  18.     2) 1) "message"
  19.        2) "apple"
  20. 17) "last-entry"
  21. 18) 1) "1638125141232-0"
  22.     2) 1) "message"
  23.        2) "banana"

Full reply:

  1. dragonfly> XADD mystream * foo bar
  2. "1638125133432-0"
  4. dragonfly> XADD mystream * foo bar2
  5. "1638125141232-0"
  7. dragonfly> XGROUP CREATE mystream mygroup 0-0
  8. OK
  10. dragonfly> XREADGROUP GROUP mygroup Alice COUNT 1 STREAMS mystream >
  11. 1) 1) "mystream"
  12.    2) 1) 1) "1638125133432-0"
  13.          2) 1) "foo"
  14.             2) "bar"
  16. dragonfly> XINFO STREAM mystream FULL
  17.  1) "length"
  18.  2) (integer) 2
  19.  3) "radix-tree-keys"
  20.  4) (integer) 1
  21.  5) "radix-tree-nodes"
  22.  6) (integer) 2
  23.  7) "last-generated-id"
  24.  8) "1638125141232-0"
  25.  9) "max-deleted-entry-id"
  26. 10) "0-0"
  27. 11) "entries-added"
  28. 12) (integer) 2
  29. 13) "entries"
  30. 14) 1) 1) "1638125133432-0"
  31.        2) 1) "foo"
  32.           2) "bar"
  33.     2) 1) "1638125141232-0"
  34.        2) 1) "foo"
  35.           2) "bar2"
  36. 15) "groups"
  37. 16) 1)  1) "name"
  38.         2) "mygroup"
  39.         3) "last-delivered-id"
  40.         4) "1638125133432-0"
  41.         5) "entries-read"
  42.         6) (integer) 1
  43.         7) "lag"
  44.         8) (integer) 1
  45.         9) "pel-count"
  46.        10) (integer) 1
  47.        11) "pending"
  48.        12) 1) 1) "1638125133432-0"
  49.               2) "Alice"
  50.               3) (integer) 1638125153423
  51.               4) (integer) 1
  52.        13) "consumers"
  53.        14) 1) 1) "name"
  54.               2) "Alice"
  55.               3) "seen-time"
  56.               4) (integer) 1638125133422
  57.               5) "active-time"
  58.               6) (integer) 1638125133432
  59.               7) "pel-count"
  60.               8) (integer) 1
  61.               9) "pending"
  62.               10) 1) 1) "1638125133432-0"
  63.                      2) (integer) 1638125133432
  64.                      3) (integer) 1