LTRIM - Upstash Documentation

Use LTRIM to keep only a range of elements in a list and delete everything outside it.

Both ends are inclusive, zero-based, and may be negative to count from the tail. If <start> is greater than <stop> or lies past the end of the list, every element is removed and the key is deleted. The reply is always OK.

The classic use is a capped list: LPUSH a new item and then LTRIM key 0 99 to keep the hundred most recent ones, which bounds memory without any separate cleanup job.

Syntax#

LTRIM <key> <start> <stop>

Arguments#

Argument	Required	Repeatable	Description
`<key>`	Yes	No	Redis key targeted by the command.
`<start>`	Yes	No	Start index; negative values count from the end.
`<stop>`	Yes	No	Stop index, inclusive; negative values count from the end.

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	Simple string `OK`
RESP3	Simple string `OK`

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

LTRIM my-key 0 0

@upstash/redis

import { Redis } from "@upstash/redis";const redis = Redis.fromEnv();await redis.lpush("key", "a", "b", "c", "d");await redis.ltrim("key", 1, 2);// the list is now ["b", "c"]

upstash_redis

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

ioredis

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

redis-py

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