LPUSH - Upstash Documentation

Use LPUSH to add one or more elements to the head of a list, creating the list when the key does not exist.

Elements are inserted one after another, so they end up in reverse order relative to the argument list: LPUSH key a b c leaves the list as c, b, a. The reply is the length of the list after the push. If the key holds a value of another type the command returns an error.

Pushing to the head and popping from the tail with RPOP gives a first-in, first-out queue, while popping from the head with LPOP gives a stack. Combine with LTRIM to keep a capped list of recent items.

Syntax#

LPUSH <key> <element> [<element> ...]

Arguments#

Argument	Required	Repeatable	Description
`<key>`	Yes	No	Redis key targeted by the command.
`<element>`	Yes	Yes	Element to push.

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	Integer
RESP3	Integer

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

LPUSH my-key element

@upstash/redis

import { Redis } from "@upstash/redis";const redis = Redis.fromEnv();const length1 = await redis.lpush("key", "a", "b", "c");console.log(length1); // 3const length2 = await redis.lpush("key", "d");console.log(length2); // 4

upstash_redis

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

ioredis

import Redis from "ioredis";const redis = new Redis(process.env.REDIS_URL!);const result = await redis.lpush("my-key", "element");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.lPush("my-key", "element");console.log(result);

redis-py

import osimport redisclient = redis.from_url(os.environ["REDIS_URL"])result = client.lpush("my-key", "element")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.LPush(context.Background(), "my-key", "element").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.lpush("my-key", "element");  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 = connection.lpush("my-key", "element")?;    println!("{result:?}");    Ok(())}