Package io.lettuce.core.api.async

Interface RedisFunctionAsyncCommands<K,V>

Type Parameters:

K - Key type.

V - Value type.

All Known Subinterfaces:

RedisAdvancedClusterAsyncCommands<K,V>, RedisAsyncCommands<K,V>, RedisClusterAsyncCommands<K,V>, RedisClusterPubSubAsyncCommands<K,V>, RedisPubSubAsyncCommands<K,V>

All Known Implementing Classes:

AbstractRedisAsyncCommands, RedisAdvancedClusterAsyncCommandsImpl, RedisAsyncCommandsImpl, RedisClusterPubSubAsyncCommandsImpl, RedisPubSubAsyncCommandsImpl

public interface RedisFunctionAsyncCommands<K,V>

Asynchronous executed commands for Redis Functions. Function code is encoded by using the configured charset.

Since:

6.3

Author:

Mark Paluch

Generated class:

by io.lettuce.apigenerator.CreateAsyncApi

Method Summary

Modifier and Type	Method	Description
<T> RedisFuture<T>	fcall(String function, ScriptOutputType type, K... keys)	Invoke a function.
<T> RedisFuture<T>	fcall(String function, ScriptOutputType type, K[] keys, V... values)	Invoke a function.
<T> RedisFuture<T>	fcallReadOnly(String function, ScriptOutputType type, K... keys)	Invoke a function in read-only mode.
<T> RedisFuture<T>	fcallReadOnly(String function, ScriptOutputType type, K[] keys, V... values)	Invoke a function in read-only mode.
RedisFuture<byte[]>	functionDump()	Return the serialized payload of loaded libraries.
RedisFuture<String>	functionFlush(FlushMode flushMode)	Deletes all the libraries using the specified FlushMode.
RedisFuture<String>	functionKill()	Kill a function that is currently executing.
RedisFuture<List<Map<String,Object>>>	functionList()	Return information about the functions and libraries.
RedisFuture<List<Map<String,Object>>>	functionList(String libraryName)	Return information about the functions and libraries.
RedisFuture<String>	functionLoad(String functionCode)	Load a library to Redis.
RedisFuture<String>	functionLoad(String functionCode, boolean replace)	Load a library to Redis.
RedisFuture<String>	functionRestore(byte[] dump)	You can restore the dumped payload of loaded libraries.
RedisFuture<String>	functionRestore(byte[] dump, FunctionRestoreMode mode)	You can restore the dumped payload of loaded libraries.

Method Detail

fcall

<T> RedisFuture<T> fcall(String function,
                         ScriptOutputType type,
                         K... keys)

Invoke a function.

Type Parameters:

T - expected return type.

Parameters:

function - the function name.

type - output type.

keys - key names.

Returns:

function result.

fcall

<T> RedisFuture<T> fcall(String function,
                         ScriptOutputType type,
                         K[] keys,
                         V... values)

Invoke a function.

Type Parameters:

T - expected return type.

Parameters:

function - the function name.

type - output type.

keys - the keys.

values - the values (arguments).

Returns:

function result.

fcallReadOnly

<T> RedisFuture<T> fcallReadOnly(String function,
                                 ScriptOutputType type,
                                 K... keys)

Invoke a function in read-only mode.

Type Parameters:

T - expected return type.

Parameters:

function - the function name.

type - output type.

keys - key names.

Returns:

function result.

fcallReadOnly

<T> RedisFuture<T> fcallReadOnly(String function,
                                 ScriptOutputType type,
                                 K[] keys,
                                 V... values)

Invoke a function in read-only mode.

Type Parameters:

T - expected return type.

Parameters:

function - the function name.

type - output type.

keys - the keys.

values - the values (arguments).

Returns:

function result.

functionLoad

RedisFuture<String> functionLoad(String functionCode)

Load a library to Redis.

Parameters:

functionCode - code of the function.

Returns:

name of the library.

functionLoad

RedisFuture<String> functionLoad(String functionCode,
                                 boolean replace)

Load a library to Redis.

Parameters:

functionCode - code of the function.

replace - whether to replace an existing function.

Returns:

name of the library.

functionDump

RedisFuture<byte[]> functionDump()

Return the serialized payload of loaded libraries. You can restore the dump through functionRestore(byte[]).

Returns:

the serialized payload.

functionRestore

RedisFuture<String> functionRestore(byte[] dump)

You can restore the dumped payload of loaded libraries.

Returns:

Simple string reply

functionRestore

RedisFuture<String> functionRestore(byte[] dump,
                                    FunctionRestoreMode mode)

You can restore the dumped payload of loaded libraries.

Returns:

Simple string reply

functionFlush

RedisFuture<String> functionFlush(FlushMode flushMode)

Deletes all the libraries using the specified FlushMode.

Parameters:

flushMode - the flush mode (sync/async).

Returns:

String simple-string-reply.

functionKill

RedisFuture<String> functionKill()

Kill a function that is currently executing.

Returns:

String simple-string-reply.

functionList

RedisFuture<List<Map<String,Object>>> functionList()

Return information about the functions and libraries.

Returns:

Array reply.

functionList

RedisFuture<List<Map<String,Object>>> functionList(String libraryName)

Return information about the functions and libraries.

Parameters:

libraryName - specify a pattern for matching library names.

Returns:

Array reply.