summaryrefslogtreecommitdiffstats
path: root/iredis/data/commands/lpush.md
blob: 21408577d7f6dc5c3bd34127d9e760f3655e4c0f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
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
```