XLEN · Valkey

XLEN

Return the number of messages in a stream.

Usage

XLEN key

Description

Returns the number of entries inside a stream. If the specified key does not exist the command returns zero, as if the stream was empty. However note that unlike other Valkey types, zero-length streams are possible, so you should call TYPE or EXISTS in order to check if a key exists or not.

Streams are not auto-deleted once they have no entries inside (for instance after an XDEL call), because the stream may have consumer groups associated with it.

Reply

Integer reply: the number of entries of the stream at key.

Complexity

O(1)

ACL Categories

@fast @read @stream

Examples

127.0.0.1:6379> XADD mystream * item 1
"1714701492011-0"
127.0.0.1:6379> XADD mystream * item 2
"1714701492021-0"
127.0.0.1:6379> XADD mystream * item 3
"1714701492031-0"
127.0.0.1:6379> XLEN mystream
(integer) 3

History

See also

XACK, XADD, XAUTOCLAIM, XCLAIM, XDEL, XGROUP, XGROUP CREATE, XGROUP CREATECONSUMER, XGROUP DELCONSUMER, XGROUP DESTROY, XGROUP HELP, XGROUP SETID, XINFO, XINFO CONSUMERS, XINFO GROUPS, XINFO HELP, XINFO STREAM, XPENDING, XRANGE, XREAD, XREADGROUP, XREVRANGE, XSETID, XTRIM.