Interface ModuleCommands

All Known Implementing Classes:
Jedis

public interface ModuleCommands
  • Method Details

    • moduleLoad

      String moduleLoad(String path)
      Load and initialize the Redis module from the dynamic library specified by the path argument.
      Parameters:
      path - should be the absolute path of the library, including the full filename
      Returns:
      OK
    • moduleLoad

      String moduleLoad(String path, String... args)
      Load and initialize the Redis module from the dynamic library specified by the path argument.
      Parameters:
      path - should be the absolute path of the library, including the full filename
      args - additional arguments are passed unmodified to the module
      Returns:
      OK
    • moduleLoadEx

      String moduleLoadEx(String path, ModuleLoadExParams params)
      Loads a module from a dynamic library at runtime with configuration directives.

      This is an extended version of the MODULE LOAD command.

      It loads and initializes the Redis module from the dynamic library specified by the path argument. The path should be the absolute path of the library, including the full filename.

      You can use the optional CONFIG argument to provide the module with configuration directives. Any additional arguments that follow the ARGS keyword are passed unmodified to the module.

      Parameters:
      path - should be the absolute path of the library, including the full filename
      params - as in description
      Returns:
      OK
    • moduleUnload

      String moduleUnload(String name)
      Unload the module specified by name. Note that the module's name is reported by the MODULE LIST command, and may differ from the dynamic library's filename.
      Parameters:
      name -
      Returns:
      OK
    • moduleList

      List<Module> moduleList()
      Return information about the modules loaded to the server.
      Returns:
      list of Module