LPOP

Returns and removes one or more elements from the beginning of a list. Deletes the list if the last element was popped.

Usage: LPOP key [count]
Complexity: O(N) where N is the number of elements returned
Since: 1.0.0
ACL Categories: @fast, @list, @write
Command flags: WRITE, FAST

By default, the command pops a single element from the beginning of the list. When provided with the optional count argument, the reply will consist of up to count elements, depending on the list's length. Deletes the list if the last element was popped.

Examples

127.0.0.1:6379> RPUSH mylist "one" "two" "three" "four" "five"
(integer) 5
127.0.0.1:6379> LPOP mylist
"one"
127.0.0.1:6379> LPOP mylist 2
1) "two"
2) "three"
127.0.0.1:6379> LRANGE mylist 0 -1
1) "four"
2) "five"

Replies

RESP2

One of the following:

Nil reply: if the key does not exist.
Bulk string reply: when called without the count argument, the value of the first element.
Array reply: when called with the count argument, a list of popped elements.

RESP3