FCALL_RO

Syntax text Syntax diagram API methods

FCALL_RO function numkeys [key [key ...]] [arg [arg ...]]

Client:

fcall_ro(
    function: str,  // Function name to invoke
    numkeys: int,  // Number of keys
    *keys_and_args: Any  // Keys and arguments for the function
) → Union[Awaitable[str], str]  // Function execution result

fCallRo(
    functionName: RedisArgument,  // Name of the function to call
    options: EvalOptions  // Function execution options including keys and arguments
) → Promise<ReplyUnion>  // Function execution result

fcallReadonly(
    name: String,  // Function name to invoke
    keys: List<String>,  // Keys for the function
    args: List<String>  // Arguments for the function
) → Object  // Function execution result

fcallReadOnly(
    function: String,  // Function name to invoke
    type: ScriptOutputType,  // Expected output type
    keys: K...  // Keys for the function
) → T  // Function execution result

fcallReadOnly(
    function: String,  // Function name to invoke
    type: ScriptOutputType,  // Expected output type
    keys: K[],  // Keys for the function
    values: V...  // Arguments for the function
) → T  // Function execution result

fcallReadOnly(
    function: String,  // Function name to invoke
    type: ScriptOutputType,  // Expected output type
    keys: K...  // Keys for the function
) → RedisFuture<T>  // Function execution result

fcallReadOnly(
    function: String,  // Function name to invoke
    type: ScriptOutputType,  // Expected output type
    keys: K[],  // Keys for the function
    values: V...  // Arguments for the function
) → RedisFuture<T>  // Function execution result

fcallReadOnly(
    function: String,  // Function name to invoke
    type: ScriptOutputType,  // Expected output type
    keys: K...  // Keys for the function
) → Mono<T>  // Function execution result

fcallReadOnly(
    function: String,  // Function name to invoke
    type: ScriptOutputType,  // Expected output type
    keys: K[],  // Keys for the function
    values: V...  // Arguments for the function
) → Mono<T>  // Function execution result

FCallRO(
    ctx: context.Context,  // Context for the operation
    function: string,  // Function name to invoke
    keys: []string,  // Keys for the function
    args: ...interface{}  // Arguments for the function
) → *Cmd  // Function execution result

fcall_ro(
    $function: string,  // Function name to invoke
    $keys: array,  // Keys for the function
    $args: ...  // Arguments for the function
) → mixed  // Function execution result

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

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

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

For more information please refer to Introduction to Redis Functions.

Required arguments

function

The name of the function to call. It must be a read-only function.

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 function accesses, provided to it via the Lua KEYS global variable. There must be exactly numkeys of them.

arg [arg ...]

Additional arguments provided to the function 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 function that was executed.