ZREMRANGEBYRANK - Upstash Documentation

Use ZREMRANGEBYRANK to remove the members of a sorted set that occupy a range of positions.

Ranks are zero-based from the lowest score and may be negative to count from the top, so ZREMRANGEBYRANK key 0 -101 keeps only the hundred highest scoring members. The reply is the number of members removed, and the key is deleted when it becomes empty.

This is the standard way to cap a leaderboard or any ranking to a fixed size after inserting into it, in the same spirit as LTRIM for lists.

Syntax#

ZREMRANGEBYRANK <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	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

ZREMRANGEBYRANK my-key 0 0

@upstash/redis

import { Redis } from "@upstash/redis";const redis = Redis.fromEnv();await redis.zremrangebyrank("key", 4, 20)

upstash_redis

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

ioredis

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

redis-py

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