redis.clients.jedis.commands

Interface FunctionBinaryCommands

All Known Subinterfaces:

JedisBinaryCommands

All Known Implementing Classes:

Jedis, JedisCluster, JedisPooled, JedisSentineled, MultiDbClient, UnifiedJedis

public interface FunctionBinaryCommands

Method Summary

Modifier and Type	Method and Description
java.lang.Object	fcall(byte[] name, java.util.List<byte[]> keys, java.util.List<byte[]> args) Invoke a function.
java.lang.Object	fcallReadonly(byte[] name, java.util.List<byte[]> keys, java.util.List<byte[]> args)
java.lang.String	functionDelete(byte[] libraryName) This command deletes the library called library-name and all functions in it.
byte[]	functionDump() Return the serialized payload of loaded libraries.
java.lang.String	functionFlush() Deletes all the libraries, unless called with the optional mode argument, the 'lazyfree-lazy-user-flush' configuration directive sets the effective behavior.
java.lang.String	functionFlush(FlushMode mode) Deletes all the libraries, unless called with the optional mode argument, the 'lazyfree-lazy-user-flush' configuration directive sets the effective behavior.
java.lang.String	functionKill() Kill a function that is currently executing.
java.util.List<java.lang.Object>	functionList(byte[] libraryNamePattern) Return information about the functions and libraries.
java.util.List<java.lang.Object>	functionListBinary() Return information about the functions and libraries.
java.util.List<java.lang.Object>	functionListWithCode(byte[] libraryNamePattern) Similar to FUNCTION LIST but include the libraries source implementation in the reply.
java.util.List<java.lang.Object>	functionListWithCodeBinary() Similar to FUNCTION LIST but include the libraries source implementation in the reply.
java.lang.String	functionLoad(byte[] functionCode) Load a library to Redis.
java.lang.String	functionLoadReplace(byte[] functionCode) Load a library to Redis.
java.lang.String	functionRestore(byte[] serializedValue) Restore libraries from the serialized payload.
java.lang.String	functionRestore(byte[] serializedValue, FunctionRestorePolicy policy) Restore libraries from the serialized payload.
java.lang.Object	functionStatsBinary() Return information about the function that's currently running and information about the available execution engines.

Method Detail

fcall

java.lang.Object fcall(byte[] name,
                       java.util.List<byte[]> keys,
                       java.util.List<byte[]> args)

Invoke a function.

Parameters:

name -

keys -

args -

Returns:

value depends on the function that was executed

fcallReadonly

java.lang.Object fcallReadonly(byte[] name,
                               java.util.List<byte[]> keys,
                               java.util.List<byte[]> args)

functionDelete

java.lang.String functionDelete(byte[] libraryName)

This command deletes the library called library-name and all functions in it. If the library doesn't exist, the server returns an error.

Parameters:

libraryName -

Returns:

OK

functionDump

byte[] functionDump()

Return the serialized payload of loaded libraries. You can restore the serialized payload later with the FUNCTION RESTORE command.

Returns:

the serialized payload

functionFlush

java.lang.String functionFlush()

Deletes all the libraries, unless called with the optional mode argument, the 'lazyfree-lazy-user-flush' configuration directive sets the effective behavior.

Returns:

OK

functionFlush

java.lang.String functionFlush(FlushMode mode)

Deletes all the libraries, unless called with the optional mode argument, the 'lazyfree-lazy-user-flush' configuration directive sets the effective behavior.

Parameters:

mode - ASYNC: Asynchronously flush the libraries, SYNC: Synchronously flush the libraries.

Returns:

OK

functionKill

java.lang.String functionKill()

Kill a function that is currently executing. The command can be used only on functions that did not modify the dataset during their execution.

Returns:

OK

functionListBinary

java.util.List<java.lang.Object> functionListBinary()

Return information about the functions and libraries.

Returns:

LibraryInfo

functionList

java.util.List<java.lang.Object> functionList(byte[] libraryNamePattern)

Return information about the functions and libraries.

Parameters:

libraryNamePattern - a pattern for matching library names

Returns:

LibraryInfo

functionListWithCodeBinary

java.util.List<java.lang.Object> functionListWithCodeBinary()

Similar to FUNCTION LIST but include the libraries source implementation in the reply.

Returns:

LibraryInfo

See Also:

FunctionCommands.functionList()

functionListWithCode

java.util.List<java.lang.Object> functionListWithCode(byte[] libraryNamePattern)

Similar to FUNCTION LIST but include the libraries source implementation in the reply.

Parameters:

libraryNamePattern - a pattern for matching library names

Returns:

LibraryInfo

See Also:

functionList(byte[])

functionLoad

java.lang.String functionLoad(byte[] functionCode)

Load a library to Redis.

The library payload must start with Shebang statement that provides a metadata about the library (like the engine to use and the library name). Shebang format: #!<engine name> name=<library name>. Currently engine name must be lua.

Parameters:

functionCode - the source code.

Returns:

The library name that was loaded

functionLoadReplace

java.lang.String functionLoadReplace(byte[] functionCode)

Load a library to Redis. Will replace the current library if it already exists.

Parameters:

functionCode - the source code

Returns:

The library name that was loaded

functionRestore

java.lang.String functionRestore(byte[] serializedValue)

Restore libraries from the serialized payload. Default policy is APPEND.

Parameters:

serializedValue - the serialized payload

Returns:

OK

functionRestore

java.lang.String functionRestore(byte[] serializedValue,
                                 FunctionRestorePolicy policy)

Restore libraries from the serialized payload.

Parameters:

serializedValue - the serialized payload

policy - can be FLUSH, APPEND or REPLACE

Returns:

OK

functionStatsBinary

java.lang.Object functionStatsBinary()

Return information about the function that's currently running and information about the available execution engines.

Returns:

FunctionStats