SUBSTR Deprecated

As of Redis version 2.0.0, this command is regarded as deprecated.

It can be replaced by GETRANGE when migrating or writing new code.

Syntax text Syntax diagram API methods

SUBSTR key start end

Client:

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

substr(
    name: KeyT,
    start: int,
    end: int = -1
) → ResponseT

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

substr(
    key: String,
    start: int,
    end: int
) → String  // The substring @deprecated Use Jedis#getrange(String, long, long) instead. Deprecated in Jedis 8.0.0. Mirrors Redis deprecation since 2.0.0.

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

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

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 1.0.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, determined by the offsets start and end (both are inclusive). Negative offsets can be used in order to provide an offset starting 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	Deprecated as of Redis v2.0.0.

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).