EVAL_RO

Syntax text Syntax diagram API methods

EVAL_RO script numkeys [key [key ...]] [arg [arg ...]]

Client:

eval_ro(
    script: str,  // Lua script to execute
    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

evalRo(
    script: RedisArgument,  // Lua script to execute
    options: EvalOptions  // Script execution options including keys and arguments
) → Promise<ReplyUnion>  // Script execution result

evalReadonly(
    script: String,  // Lua script to execute
    keys: List<String>,  // Keys for the script
    args: List<String>  // Arguments for the script
) → Object  // Script execution result

evalReadOnly(
    script: String,  // Lua 5.1 script
    type: ScriptOutputType,  // Output type
    keys: K[],  // The keys
    values: V...  // The values
) → <T> T  // Script result

evalReadOnly(
    script: byte[],  // Lua 5.1 script
    type: ScriptOutputType,  // Output type
    keys: K[],  // The keys
    values: V...  // The values
) → <T> T  // Script result

evalReadOnly(
    script: String,  // Lua 5.1 script
    type: ScriptOutputType,  // The type
    keys: K[],  // The keys
    values: V...  // The values
) → <T> RedisFuture<T>  // Script result

evalReadOnly(
    script: byte[],  // Lua 5.1 script
    type: ScriptOutputType,  // The type
    keys: K[],  // The keys
    values: V...  // The values
) → <T> RedisFuture<T>  // Script result

evalReadOnly(
    script: String,  // Lua 5.1 script
    type: ScriptOutputType,  // The type
    keys: K[],  // The keys
    values: V...  // The values
) → <T> Flux<T>  // Script result

evalReadOnly(
    script: byte[],  // Lua 5.1 script
    type: ScriptOutputType,  // The type
    keys: K[],  // The keys
    values: V...  // The values
) → <T> Flux<T>  // Script result

EvalRO(
    ctx: context.Context,  // Context for the operation
    script: string,  // Lua script to execute
    keys: []string,  // Keys for the script
    args: ...interface{}  // Arguments for the script
) → *Cmd  // Script execution result

ScriptEvaluateReadOnly(
    script: string,  // Lua script to execute
    keys: RedisKey[]?,  // Keys for the script
    values: RedisValue[]?,  // Arguments for the script
    flags: CommandFlags  // Command flags
) → RedisResult  // Script execution result

ScriptEvaluateReadOnlyAsync(
    script: string,  // Lua script to execute
    keys: RedisKey[]?,  // Keys for the script
    values: RedisValue[]?,  // Arguments for the script
    flags: CommandFlags  // Command flags
) → Task<RedisResult>  // Script execution result

eval_ro(
    $script: string,  // Lua script to execute
    $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

Runs a read-only Lua script. Unlike EVAL, this command can’t run commands that modify data.

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

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

Required arguments

script

The Lua script to evaluate. It must not modify data.

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.

Examples

> SET mykey "Hello"
OK
> EVAL_RO "return redis.call('GET', KEYS[1])" 1 mykey
"Hello"
> EVAL_RO "return redis.call('DEL', KEYS[1])" 1 mykey
(error) ERR Error running script (call to b0d697da25b13e49157b2c214a4033546aba2104): @user_script:1: @user_script: 1: Write commands are not allowed from read-only scripts.

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.