AI agent builder

MODULE LOAD

Syntax text Syntax diagram API methods

MODULE LOAD path [arg [arg ...]]

Client:

module_load(
    path: str,
    *args: str,
    **kwargs: Any
) → str

moduleLoad(
    path: String
) → String

ModuleLoad(
    ctx: context.Context,  // Context
    path: string,
    args: ...string
) → *StringCmd

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

Available since:: Redis Open Source 4.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.

This command 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. Any additional arguments are passed unmodified to the module.

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

Note:

As of Redis 8 in Redis Open Source, loading a module using the Redis CLI with configuration parameters is deprecated.

Required arguments

path

The absolute path to the module library file.

Optional arguments

arg [arg ...]

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.