LREM - Upstash Documentation

Use LREM to remove elements equal to a given value from a list.

The count decides how many occurrences are removed and in which direction: a positive count removes that many starting from the head, a negative count removes that many starting from the tail, and 0 removes every occurrence. The reply is the number of elements actually removed, and the key is deleted when the list becomes empty.

Removing by value means scanning the list, so on long lists prefer a set or a sorted set when you frequently need to delete arbitrary items.

Syntax#

LREM <key> <count> <element>

Arguments#

Argument	Required	Repeatable	Description
`<key>`	Yes	No	Redis key targeted by the command.
`<count>`	Yes	No	How many matches to remove: positive scans head to tail, negative tail to head, `0` removes every match.
`<element>`	Yes	No	Element value to remove.

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

LREM my-key 1 element

@upstash/redis

import { Redis } from "@upstash/redis";const redis = Redis.fromEnv();await redis.lpush("key", "a", "a", "b", "b", "c");const removed = await redis.lrem("key", 4, "b");console.log(removed) // 2

upstash_redis

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

ioredis

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

redis-py

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