summaryrefslogtreecommitdiffstats
path: root/iredis/data/commands/xlen.md
blob: 5506449ca771721a4c793ac6c39d8d6d60294083 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
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.

@return

@integer-reply: the number of entries of the stream at `key`.

@examples

```cli
XADD mystream * item 1
XADD mystream * item 2
XADD mystream * item 3
XLEN mystream
```