EVALSHA_RO

Syntax text Syntax diagram API methods

EVALSHA_RO sha1 numkeys [key [key ...]] [arg [arg ...]]

Client:

evalsha_ro(
    sha: str,  // SHA1 digest of the script
    numkeys: int,  // Number of keys in the script
    *keys_and_args: Union[KeyT, EncodableT]  // Keys and arguments for the script
) → Union[Awaitable[str], str]  // Script execution result

evalShaRo(
    sha1: RedisArgument,  // SHA1 digest of the script
    options: EvalOptions  // Script execution options including keys and arguments
) → Promise<ReplyUnion>  // Script execution result

evalshaReadonly(
    sha1: String,  // SHA1 digest of the script
    keys: List<String>,  // Keys for the script
    args: List<String>  // Arguments for the script
) → Object  // Script execution result

evalshaReadOnly(
    digest: String,  // SHA1 of the script
    type: ScriptOutputType,  // Output type
    keys: K[],  // The keys
    values: V...  // The values
) → <T> T  // Script result

evalshaReadOnly(
    digest: String,  // SHA1 of the script
    type: ScriptOutputType,  // The type
    keys: K[],  // The keys
    values: V...  // The values
) → <T> RedisFuture<T>  // Script result

evalshaReadOnly(
    digest: String,  // SHA1 of the script
    type: ScriptOutputType,  // The type
    keys: K[],  // The keys
    values: V...  // The values
) → <T> Flux<T>  // Script result

EvalShaRO(
    ctx: context.Context,  // Context for the operation
    sha1: string,  // SHA1 digest of the script
    keys: []string,  // Keys for the script
    args: ...interface{}  // Arguments for the script
) → *Cmd  // Script execution result

ScriptEvaluateReadOnly(
    hash: byte[],  // SHA1 hash of the script
    keys: RedisKey[]?,  // Keys for the script
    values: RedisValue[]?,  // Arguments for the script
    flags: CommandFlags  // Command flags
) → RedisResult  // Script execution result

ScriptEvaluateReadOnlyAsync(
    hash: byte[],  // SHA1 hash of the script
    keys: RedisKey[]?,  // Keys for the script
    values: RedisValue[]?,  // Arguments for the script
    flags: CommandFlags  // Command flags
) → Task<RedisResult>  // Script execution result

evalsha_ro(
    $sha1: string,  // SHA1 digest of the script
    $keys: array,  // Keys for the script
    $argument: ...  // Arguments for the script
) → mixed  // Script execution result

Available since:: Redis Open Source 7.0.0
Time complexity:: Depends on the script that is executed.
ACL categories:: @slow, @scripting,
Compatibility:: Redis Software and Redis Cloud compatibility

This is a read-only variant of the EVALSHA command that cannot execute commands that modify data.

For more information about when to use this command vs EVALSHA, please refer to Read-only scripts.

For more information about EVALSHA scripts please refer to Introduction to Eval Scripts.

Required arguments

sha1

The SHA1 digest of a read-only script previously cached with SCRIPT LOAD or EVAL_RO.

numkeys

The number of key names that follow. Arguments after the keys are passed as regular arguments.

Optional arguments

key [key ...]

The key names the script accesses, provided to it via the Lua KEYS global variable. There must be exactly numkeys of them.

arg [arg ...]

Additional arguments provided to the script via the Lua ARGV variable.

Redis Software and Redis Cloud compatibility

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

Return information

RESP2 RESP3

The return value depends on the script that was executed.