ZREMRANGEBYLEX - Upstash Documentation

Use ZREMRANGEBYLEX to remove the members of a sorted set that fall in a lexicographic range.

Bounds are written [member for inclusive and (member for exclusive, with - and + for the extremes. As with every lexicographic operation, the result is only meaningful when all members share the same score. The reply is the number of members removed, and the key is deleted when it becomes empty.

It is the bulk delete that matches ZRANGEBYLEX, useful for dropping a whole prefix from a sorted string index.

Syntax#

ZREMRANGEBYLEX <key> <min> <max>

Arguments#

Argument	Required	Repeatable	Description
`<key>`	Yes	No	Redis key targeted by the command.
`<min>`	Yes	No	Lexicographic minimum: `-`, `+`, `[member` (inclusive), or `(member` (exclusive).
`<max>`	Yes	No	Lexicographic maximum: `-`, `+`, `[member` (inclusive), or `(member` (exclusive).

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

ZREMRANGEBYLEX my-key - +

@upstash/redis

import { Redis } from "@upstash/redis";const redis = Redis.fromEnv();await redis.zremrangebylex("key", "alpha", "omega")

upstash_redis

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

ioredis

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

redis-py

import osimport redisclient = redis.from_url(os.environ["REDIS_URL"])result = client.zremrangebylex("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.ZRemRangeByLex(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.zremrangeByLex("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 = connection.zrembylex("my-key", "-", "+")?;    println!("{result:?}");    Ok(())}