Package io.lettuce.core.cluster.api.async

Interface NodeSelectionFunctionAsyncCommands<K,​V>

  • Type Parameters:
    K - Key type.
    V - Value type.
    All Known Subinterfaces:
    NodeSelectionAsyncCommands<K,​V>
    public interface NodeSelectionFunctionAsyncCommands<K,​V>
    Asynchronous executed commands on a node selection for Redis Functions. Function code is encoded by using the configured charset.
    Since:
    6.3
    Author:
    Mark Paluch
    Generated class:
    by io.lettuce.apigenerator.CreateAsyncNodeSelectionClusterApi

    • Method Detail

      • fcall

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

        AsyncExecutions<String> functionLoad​(String functionCode)
        Load a library to Redis.
        Parameters:
        functionCode - code of the function.
        Returns:
        name of the library.

      • functionLoad

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

        AsyncExecutions<byte[]> functionDump()
        Return the serialized payload of loaded libraries. You can restore the dump through functionRestore(byte[]).
        Returns:
        the serialized payload.

      • functionRestore

        AsyncExecutions<String> functionRestore​(byte[] dump)
        You can restore the dumped payload of loaded libraries.
        Returns:
        Simple string reply

      • functionFlush

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

        AsyncExecutions<String> functionKill()
        Kill a function that is currently executing.
        Returns:
        String simple-string-reply.

      • functionList

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