xlen.3valkey - Man Page

Return the number of messages in a stream.

Synopsis

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

valkey-protocol(7) Integer reply: the number of entries of the stream at key.

Complexity

O(1)

Acl Categories

@fast @read @stream

History

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

See Also

xack(3valkey), xadd(3valkey), xautoclaim(3valkey), xclaim(3valkey), xdel(3valkey), xgroup(3valkey), xgroup-create(3valkey), xgroup-createconsumer(3valkey), xgroup-delconsumer(3valkey), xgroup-destroy(3valkey), xgroup-help(3valkey), xgroup-setid(3valkey), xinfo(3valkey), xinfo-consumers(3valkey), xinfo-groups(3valkey), xinfo-help(3valkey), xinfo-stream(3valkey), xpending(3valkey), xrange(3valkey), xread(3valkey), xreadgroup(3valkey), xrevrange(3valkey), xsetid(3valkey), xtrim(3valkey)

Info

2024-09-23 8.0.0 Valkey Command Manual