GETRANGE

Syntax text Syntax diagram API methods

GETRANGE key start end

Client:

getrange(
    key: KeyT,
    start: int,
    end: int
) → ResponseT

GETRANGE(
    key: RedisArgument,
    start: number,
    end: number
) → Any

getrange(
    key: String,
    startOffset: long,
    endOffset: long
) → String

getrange(
    key: K,  // the key.
    start: long,  // the start type: long.
    end: long  // the end type: long.
) → V  // V bulk-string-reply.

getrange(
    key: K,  // the key.
    start: long,  // the start type: long.
    end: long  // the end type: long.
) → RedisFuture<V>  // V bulk-string-reply.

getrange(
    key: K,  // the key.
    start: long,  // the start type: long.
    end: long  // the end type: long.
) → Mono<V>  // V bulk-string-reply.

GetRange(
    ctx: context.Context,
    key: string,
    start: Any,
    end: int64
) → *StringCmd

StringGetRange(
    key: RedisKey,  // The key of the string.
    start: long,  // The start index of the substring to get.
    end: long,  // The end index of the substring to get.
    flags: CommandFlags  // The flags to use for this operation.
) → RedisValue  // The substring of the string value stored at key.

StringGetRange(
    key: RedisKey,  // The key of the string.
    start: long,  // The start index of the substring to get.
    end: long,  // The end index of the substring to get.
    flags: CommandFlags  // The flags to use for this operation.
) → RedisValue  // The substring of the string value stored at key.

GetRange(
    value: double,
    exclude: Exclude,
    isStart: bool
) → RedisValue

StringGetRange(
    key: RedisKey,  // The key of the string.
    start: long,  // The start index of the substring to get.
    end: long,  // The end index of the substring to get.
    flags: CommandFlags  // The flags to use for this operation.
) → RedisValue  // The substring of the string value stored at key.

StringGetRange(
    key: RedisKey,  // The key of the string.
    start: long,  // The start index of the substring to get.
    end: long,  // The end index of the substring to get.
    flags: CommandFlags  // The flags to use for this operation.
) → RedisValue  // The substring of the string value stored at key.

GetRange(
    value: double,
    exclude: Exclude,
    isStart: bool
) → RedisValue

getrange(
    $key: string,
    $start: Any,
    $end: Any
) → string

getrange(
    key: K,
    from: isize,
    to: isize
) → (String)

getrange(
    key: K,
    from: isize,
    to: isize
) → (String)

Available since:: Redis Open Source 2.4.0
Time complexity:: O(N) where N is the length of the returned string. The complexity is ultimately determined by the returned length, but because creating a substring from an existing string is very cheap, it can be considered O(1) for small strings.
ACL categories:: @read, @string, @slow,
Compatibility:: Redis Software and Redis Cloud compatibility

Returns the substring of the string value stored at key, as determined by the start and end offsets. Both offsets are inclusive.

You can use negative offsets to count backward from the end of the string. For example, -1 is the last character, -2 is the penultimate character, and so on.

The function handles out of range requests by limiting the resulting range to the actual length of the string.

Required arguments

key

The name of the key.

start

The start offset, zero-based. A negative value counts from the end of the string.

end

The end offset, zero-based and inclusive. A negative value counts from the end of the string.

Examples

Redis Software and Redis Cloud compatibility

Redis Software	Redis Cloud	Notes
✅ Standard ✅ Active-Active	✅ Standard ✅ Active-Active

Return information

RESP2 RESP3

Bulk string reply: The substring of the string value stored at key, determined by the offsets start and end (both are inclusive).