XLEN

Syntax text Syntax diagram API methods

XLEN key

Client:

xlen(
    name: KeyT
) → ResponseT

XLEN(
    key: RedisArgument
) → Any

xlen(
    key: byte[]
) → long  // length of stream

xlen(
    key: String
) → long  // length of stream

xlen(
    key: String
) → long  // length of stream

xlen(
    key: K  // the stream key.
) → Long  // simple-reply the lenght of the stream.

xlen(
    key: K  // the stream key.
) → RedisFuture<Long>  // simple-reply the lenght of the stream.

xlen(
    key: K  // the stream key.
) → Mono<Long>  // simple-reply the lenght of the stream.

XLen(
    ctx: context.Context,
    stream: string
) → *IntCmd

StreamLength(
    key: RedisKey,  // The key of the stream.
    flags: CommandFlags  // The flags to use for this operation.
) → long  // The number of entries inside the given stream.

StreamLength(
    key: RedisKey,  // The key of the stream.
    flags: CommandFlags  // The flags to use for this operation.
) → long  // The number of entries inside the given stream.

StreamLength(
    key: RedisKey,  // The key of the stream.
    flags: CommandFlags  // The flags to use for this operation.
) → long  // The number of entries inside the given stream.

StreamLength(
    key: RedisKey,  // The key of the stream.
    flags: CommandFlags  // The flags to use for this operation.
) → long  // The number of entries inside the given stream.

xlen(
    $key: string
) → int

xlen(
    key: K
) → usize

xlen(
    key: K
) → usize

Available since:: Redis Open Source 5.0.0
Time complexity:: O(1)
ACL categories:: @read, @stream, @fast,
Compatibility:: Redis Software and Redis Cloud compatibility

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 Redis 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.

Required arguments

key

The stream key.

Examples

Redis Software and Redis Cloud compatibility

Redis Software	Redis Cloud	Notes
✅ Standard ✅ Active-Active	✅ Standard ✅ Active-Active

Return information

RESP2 RESP3

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