EVALSHA

Syntax text Syntax diagram API methods

EVALSHA sha1 numkeys [key [key ...]] [arg [arg ...]]

Client:

evalsha(
    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

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

evalsha(
    sha1: String,  // SHA1 digest of the script
    keyCount: int,  // Number of keys in the script
    params: String...  // Keys and arguments for the script
) → Object  // Script execution result

evalsha(
    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

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

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

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

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

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

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

EvalSha(
    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

ScriptEvaluate(
    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

ScriptEvaluateAsync(
    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(
    $script: string,  // SHA1 digest of the script
    $numkeys: int,  // Number of keys in the script
    $keyOrArg: string...  // Keys and arguments for the script
) → mixed  // Script execution result

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

Note:

This command's behavior varies in clustered Redis environments. See the multi-key operations page for more information.

Evaluate a script from the server's cache by its SHA1 digest.

The server caches scripts by using the SCRIPT LOAD command. The command is otherwise identical to EVAL.

Please refer to the Redis Programmability and Introduction to Eval Scripts for more information about Lua scripts.

Required arguments

sha1

The SHA1 digest of a script previously cached with SCRIPT LOAD or EVAL.

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.