summaryrefslogtreecommitdiffstats
path: root/iredis/data/commands/xlen.md
diff options
context:
space:
mode:
Diffstat (limited to 'iredis/data/commands/xlen.md')
-rw-r--r--iredis/data/commands/xlen.md21
1 files changed, 21 insertions, 0 deletions
diff --git a/iredis/data/commands/xlen.md b/iredis/data/commands/xlen.md
new file mode 100644
index 0000000..5506449
--- /dev/null
+++ b/iredis/data/commands/xlen.md
@@ -0,0 +1,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
+```