LPOP - Upstash Documentation

Use LPOP to remove and return elements from the head of a list.

Without a count a single element is returned, or null when the key does not exist. With a count, up to that many elements are removed and returned in the order they were popped, and the reply is an empty array or null when the list is empty. The key is deleted once the last element is removed.

Paired with RPUSH this gives a first-in, first-out queue; paired with LPUSH it gives a stack. Use BLPOP when a consumer should wait for work rather than poll.

Syntax#

LPOP <key> [<count>]

Arguments#

Argument	Required	Repeatable	Description
`<key>`	Yes	No	Redis key targeted by the command.
`<count>`	No	No	Number of elements to pop.

Response#

The reply reports the result of the operation. Error replies have the same shape in RESP2 and RESP3 and are surfaced as exceptions by the SDKs below.

Protocol	Reply
RESP2	Null bulk string or null array, Bulk string, or array of bulk-string values
RESP3	Null, Bulk string, or array of bulk-string values

Note

Client libraries often decode bulk strings, maps, sets, and numeric strings into language-native values. The table describes the Redis wire reply.

Examples#

TCP examples use the TLS REDIS_URL from the Upstash console. REST examples use UPSTASH_REDIS_REST_URL and UPSTASH_REDIS_REST_TOKEN.

Redis CLI

LPOP my-key

@upstash/redis

import { Redis } from "@upstash/redis";const redis = Redis.fromEnv();await redis.rpush("key", "a", "b", "c");const element = await redis.lpop("key");console.log(element); // "a"

upstash_redis

from upstash_redis import Redisredis = Redis.from_env()result = redis.lpop("my-key")print(result)

ioredis

import Redis from "ioredis";const redis = new Redis(process.env.REDIS_URL!);const result = await redis.lpop("my-key");console.log(result);

node-redis

import { createClient } from "redis";const client = await createClient({ url: process.env.REDIS_URL })  .on("error", console.error)  .connect();const result = await client.lPop("my-key");console.log(result);

redis-py

import osimport redisclient = redis.from_url(os.environ["REDIS_URL"])result = client.lpop("my-key")print(result)

go-redis

package mainimport (    "context"    "fmt"    "os"    "github.com/redis/go-redis/v9")func main() {    opts, err := redis.ParseURL(os.Getenv("REDIS_URL"))    if err != nil {        panic(err)    }    client := redis.NewClient(opts)    result, err := client.LPop(context.Background(), "my-key").Result()    if err != nil {        panic(err)    }    fmt.Println(result)}

jedis

import java.net.URI;import redis.clients.jedis.Jedis;try (Jedis jedis = new Jedis(new URI(System.getenv("REDIS_URL")))) {  Object result = jedis.lpop("my-key");  System.out.println(result);}

redis-rs

use redis::TypedCommands;fn main() -> redis::RedisResult<()> {    let url = std::env::var("REDIS_URL").expect("REDIS_URL is not set");    let client = redis::Client::open(url)?;    let mut connection = client.get_connection()?;    let result: Option<String> = connection.lpop("my-key", None)?;    println!("{result:?}");    Ok(())}