Back to Redis

MODULE LOAD

content/commands/module-load.md

latest1.4 KB
Original Source

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. {{< /note >}}

Redis Software and Redis Cloud compatibility

| Redis Software | Redis Cloud | <span style="min-width: 9em; display: table-cell">Notes</span> | |:----------------------|:-----------------|:------| | <span title="Not supported">❌ Standard</span> <span title="Not supported"><nobr>❌ Active-Active</nobr></span> | <span title="Not supported">❌ Standard</span> <span title="Not supported"><nobr>❌ Active-Active</nobr></span> | |

Return information

{{< multitabs id="module-load-return-info" tab1="RESP2" tab2="RESP3" >}}

Simple string reply: OK if the module was loaded.

-tab-sep-

Simple string reply: OK if the module was loaded.

{{< /multitabs >}}