Package io.lettuce.core.api.reactive

Interface RedisFunctionReactiveCommands<K,V>

Type Parameters:

K - Key type.

V - Value type.

All Known Subinterfaces:

RedisAdvancedClusterReactiveCommands<K,V>, RedisClusterPubSubReactiveCommands<K,V>, RedisClusterReactiveCommands<K,V>, RedisPubSubReactiveCommands<K,V>, RedisReactiveCommands<K,V>

All Known Implementing Classes:

AbstractRedisReactiveCommands, RedisAdvancedClusterReactiveCommandsImpl, RedisClusterPubSubReactiveCommandsImpl, RedisPubSubReactiveCommandsImpl, RedisReactiveCommandsImpl, RedisSentinelReactiveCommandsImpl

public interface RedisFunctionReactiveCommands<K,V>

Reactive 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.CreateReactiveApi

Method Summary

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

Method Detail

fcall

<T> Flux<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> Flux<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> Flux<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> Flux<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

Mono<String> functionLoad(String functionCode)

Load a library to Redis.

Parameters:

functionCode - code of the function.

Returns:

name of the library.

functionLoad

Mono<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

Mono<byte[]> functionDump()

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

Returns:

the serialized payload.

functionRestore

Mono<String> functionRestore(byte[] dump)

You can restore the dumped payload of loaded libraries.

Returns:

Simple string reply

functionRestore

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

You can restore the dumped payload of loaded libraries.

Returns:

Simple string reply

functionFlush

Mono<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

Mono<String> functionKill()

Kill a function that is currently executing.

Returns:

String simple-string-reply.

functionList

Flux<Map<String,Object>> functionList()

Return information about the functions and libraries.

Returns:

Array reply.

functionList

Flux<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.