GETRANGE - Upstash Documentation

Use GETRANGE to read part of the string stored at a key.

<start> and <end> are zero-based byte offsets, both inclusive, and may be negative to count from the end, so GETRANGE key 0 -1 returns the whole value. Offsets outside the string are clamped rather than treated as errors, and a missing key returns an empty string.

Since the range is applied on the server, this is how you read the head of a large value, or a fixed-width field inside one, without transferring the rest. SUBSTR is accepted as a deprecated alias with the same arguments and reply.

Syntax#

GETRANGE <key> <start> <end>

Arguments#

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

Important points#

SUBSTR is accepted as a deprecated alias with the same arguments and reply. New code should use GETRANGE.

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	Bulk string
RESP3	Bulk string

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

GETRANGE my-key 0 1

@upstash/redis

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

upstash_redis

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

ioredis

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

redis-py

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