MODULE LOADEX

Syntax text Syntax diagram API methods

MODULE LOADEX path [CONFIG name value [CONFIG name value ...]]
  [ARGS args [args ...]]

Client:

module_loadex(
    path: str,
    options: list | None,
    args: list | None,
    **kwargs: Any
) → str

moduleLoadex(
    path: String,
    params: ModuleLoadExParams
) → String

module(
    $subcommand: string,
    $args: mixed
) → string

Available since:: Redis Open Source 7.0.0
Time complexity:: O(1)
ACL categories:: @admin, @slow, @dangerous,
Compatibility:: Redis Software and Redis Cloud compatibility

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.

Note: modules can also be loaded at server startup with loadmodule configuration directive in redis.conf.

Required arguments

path

The absolute path to the module library file.

Optional arguments

CONFIG name value [CONFIG name value ...]

One or more module configuration name-value pairs to set at load time.

ARGS args [args ...]

Additional arguments passed to the module's initialization function.

Redis Software and Redis Cloud compatibility

Redis Software	Redis Cloud	Notes
❌ Standard ❌ Active-Active	❌ Standard ❌ Active-Active

Return information

RESP2 RESP3

Simple string reply: OK if the module was loaded.