summaryrefslogtreecommitdiffstats
path: root/iredis/data/commands/lpush.md
diff options
context:
space:
mode:
Diffstat (limited to 'iredis/data/commands/lpush.md')
-rw-r--r--iredis/data/commands/lpush.md27
1 files changed, 27 insertions, 0 deletions
diff --git a/iredis/data/commands/lpush.md b/iredis/data/commands/lpush.md
new file mode 100644
index 0000000..2140857
--- /dev/null
+++ b/iredis/data/commands/lpush.md
@@ -0,0 +1,27 @@
+Insert all the specified values at the head of the list stored at `key`. If
+`key` does not exist, it is created as empty list before performing the push
+operations. When `key` holds a value that is not a list, an error is returned.
+
+It is possible to push multiple elements using a single command call just
+specifying multiple arguments at the end of the command. Elements are inserted
+one after the other to the head of the list, from the leftmost element to the
+rightmost element. So for instance the command `LPUSH mylist a b c` will result
+into a list containing `c` as first element, `b` as second element and `a` as
+third element.
+
+@return
+
+@integer-reply: the length of the list after the push operations.
+
+@history
+
+- `>= 2.4`: Accepts multiple `element` arguments. In Redis versions older than
+ 2.4 it was possible to push a single value per command.
+
+@examples
+
+```cli
+LPUSH mylist "world"
+LPUSH mylist "hello"
+LRANGE mylist 0 -1
+```