FCALL_RO
FCALL_RO function numkeys [key [key ...]] [arg [arg ...]]
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 resultPossible errors
- BUSY:
ResponseError - CLUSTERDOWN:
ClusterDownError - ERR wrong number of arguments:
ResponseError - MASTERDOWN:
MasterDownError - MISCONF:
ResponseError - NOPERM:
NoPermissionError - NOREPLICAS:
ResponseError - OOM:
OutOfMemoryError - READONLY:
ReadOnlyError
See Redis error messages for what each error means. Other errors, such as connection errors, aren't listed.
fCallRo(
functionName: RedisArgument, // Name of the function to call
options: EvalOptions // Function execution options including keys and arguments
) → Promise<ReplyUnion> // Function execution resultPossible errors
- BUSY:
SimpleError(test witherr.message.startsWith('BUSY')) - CLUSTERDOWN:
SimpleError(test witherr.message.startsWith('CLUSTERDOWN')) - ERR wrong number of arguments:
SimpleError - MASTERDOWN:
SimpleError(test witherr.message.startsWith('MASTERDOWN')) - MISCONF:
SimpleError(test witherr.message.startsWith('MISCONF')) - NOPERM:
SimpleError(test witherr.message.startsWith('NOPERM')) - NOREPLICAS:
SimpleError(test witherr.message.startsWith('NOREPLICAS')) - OOM:
SimpleError(test witherr.message.startsWith('OOM')) - READONLY:
SimpleError(test witherr.message.startsWith('READONLY'))
See Redis error messages for what each error means. Other errors, such as connection errors, aren't listed.
fcallReadonly(
name: String, // Function name to invoke
keys: List<String>, // Keys for the function
args: List<String> // Arguments for the function
) → Object // Function execution resultPossible errors
- BUSY:
JedisBusyException - CLUSTERDOWN:
JedisClusterException - ERR wrong number of arguments:
JedisDataException - MASTERDOWN:
JedisDataException - MISCONF:
JedisDataException - NOPERM:
JedisAccessControlException - NOREPLICAS:
JedisDataException - OOM:
JedisDataException - READONLY:
JedisDataException
See Redis error messages for what each error means. Other errors, such as connection errors, aren't listed.
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 resultPossible errors
- BUSY:
RedisBusyException - CLUSTERDOWN:
RedisCommandExecutionException - ERR wrong number of arguments:
RedisCommandExecutionException - MASTERDOWN:
RedisCommandExecutionException - MISCONF:
RedisCommandExecutionException - NOPERM:
RedisCommandExecutionException - NOREPLICAS:
RedisCommandExecutionException - OOM:
RedisCommandExecutionException - READONLY:
RedisReadOnlyException
See Redis error messages for what each error means. Other errors, such as connection errors, aren't listed.
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 resultPossible errors
- BUSY:
RedisBusyException - CLUSTERDOWN:
RedisCommandExecutionException - ERR wrong number of arguments:
RedisCommandExecutionException - MASTERDOWN:
RedisCommandExecutionException - MISCONF:
RedisCommandExecutionException - NOPERM:
RedisCommandExecutionException - NOREPLICAS:
RedisCommandExecutionException - OOM:
RedisCommandExecutionException - READONLY:
RedisReadOnlyException
See Redis error messages for what each error means. Other errors, such as connection errors, aren't listed.
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 resultPossible errors
- BUSY:
RedisBusyException - CLUSTERDOWN:
RedisCommandExecutionException - ERR wrong number of arguments:
RedisCommandExecutionException - MASTERDOWN:
RedisCommandExecutionException - MISCONF:
RedisCommandExecutionException - NOPERM:
RedisCommandExecutionException - NOREPLICAS:
RedisCommandExecutionException - OOM:
RedisCommandExecutionException - READONLY:
RedisReadOnlyException
See Redis error messages for what each error means. Other errors, such as connection errors, aren't listed.
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 resultPossible errors
- BUSY:
redis.Error(test withredis.HasErrorPrefix(err, "BUSY")) - CLUSTERDOWN:
redis.Error(test withredis.IsClusterDownError(err)) - ERR wrong number of arguments:
redis.Error - MASTERDOWN:
redis.Error(test withredis.IsMasterDownError(err)) - MISCONF:
redis.Error(test withredis.HasErrorPrefix(err, "MISCONF")) - NOPERM:
redis.Error(test withredis.IsPermissionError(err)) - NOREPLICAS:
redis.Error(test withredis.IsNoReplicasError(err)) - OOM:
redis.Error(test withredis.IsOOMError(err)) - READONLY:
redis.Error(test withredis.IsReadOnlyError(err))
See Redis error messages for what each error means. Other errors, such as connection errors, aren't listed.
No method signature available for this client.
No method signature available for this client.
fcall_ro(
$function: string, // Function name to invoke
$keys: array, // Keys for the function
$args: ... // Arguments for the function
) → mixed // Function execution resultPossible errors
- BUSY:
Predis\Response\ServerException(test with$e->getErrorType() === 'BUSY') - CLUSTERDOWN:
Predis\Response\ServerException(test with$e->getErrorType() === 'CLUSTERDOWN') - ERR wrong number of arguments:
Predis\Response\ServerException - MASTERDOWN:
Predis\Response\ServerException(test with$e->getErrorType() === 'MASTERDOWN') - MISCONF:
Predis\Response\ServerException(test with$e->getErrorType() === 'MISCONF') - NOPERM:
Predis\Response\ServerException(test with$e->getErrorType() === 'NOPERM') - NOREPLICAS:
Predis\Response\ServerException(test with$e->getErrorType() === 'NOREPLICAS') - OOM:
Predis\Response\ServerException(test with$e->getErrorType() === 'OOM') - READONLY:
Predis\Response\ServerException(test with$e->getErrorType() === 'READONLY')
See Redis error messages for what each error means. Other errors, such as connection errors, aren't listed.
No method signature available for this client.
No method signature available for this client.
- 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 |
✅ Standard |