Back to Redis

XLEN

content/commands/xlen.md

latest1.5 KB
Original Source

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]({{< relref "/commands/type" >}}) or [EXISTS]({{< relref "/commands/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]({{< relref "/commands/xdel" >}}) call), because the stream may have consumer groups associated with it.

Examples

{{% redis-cli %}} XADD mystream * item 1 XADD mystream * item 2 XADD mystream * item 3 XLEN mystream {{% /redis-cli %}}

Redis Software and Redis Cloud compatibility

| Redis Software | Redis Cloud | <span style="min-width: 9em; display: table-cell">Notes</span> | |:----------------------|:-----------------|:------| | <span title="Supported">✅ Standard</span> <span title="Supported"><nobr>✅ Active-Active</nobr></span> | <span title="Supported">✅ Standard</span> <span title="Supported"><nobr>✅ Active-Active</nobr></span> | |

Return information

{{< multitabs id="xlen-return-info" tab1="RESP2" tab2="RESP3" >}}

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

-tab-sep-

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

{{< /multitabs >}}