MODULE LOADEX

Loads a module using extended parameters.

Browse all commands · Upstream source documentation

Reference field	Value
Canonical name	MODULE LOADEX
Catalog group	Server commands
Upstream since	7.0.0 — upstream Redis/module version, not an ffkv release
Pinned catalog	Redis 8.10.0

Syntax

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

ffkv behavior and limits

Server introspection describes ffkv, not a Redis process. MEMORY reports owned-allocation estimates, not jemalloc accounting. Administrative changes can affect all clients or persistent data; consult the scenario and operations guide before using destructive forms.

Source: README.md:393–395, 601–642; tests/bdd/features/server.feature; tests/bdd/features/catalog.feature.

Native MODULE libraries are trusted, unsandboxed code. ffkv implements a Redis Modules API v1 subset: string/reply/allocation, synchronous Call, basic keys, metadata and immutable load-time string configuration. Custom datatypes, persistence callbacks, blocking, threads, timers, events and shared APIs are unavailable; requiring one fails load (README.md:629–635).

All requests share the 8 MiB framing/1,024-argument ingress limit; normal RESP replies have 64 MiB wire/logical budgets with bounded nesting/value counts. Management and Lua origins impose smaller budgets. These are not a process RSS cap. Catalog inclusion is not exhaustive option or wire-format parity. See limits and compatibility.

Upstream metadata

The following fields come from the pinned Redis metadata, not measured ffkv performance or an assertion that ffkv enforces every upstream flag. Running COMMAND INFO/COMMAND DOCS describe the current engine.

Upstream Redis complexity: O(1)

Upstream arity: -3 (includes the command name; a negative number is a minimum).

Command flags: NO_ASYNC_LOADING, ADMIN, NOSCRIPT, PROTECTED.

Argument structure

Argument	Type	Constraints / metadata
path	string	Required
configs	block	optional; multiple; multiple token; token: CONFIG
↳ name	string	Required
↳ value	string	Required
args	string	optional; multiple; token: ARGS

Additional pinned upstream metadata

{
  "group": "server",
  "since": "7.0.0"
}

Metadata source · Local snapshot: src/command_metadata.json, key module|loadex.

BDD coverage and source examples

These are source observations, not a test run performed by this documentation build. A tag identifies scenario intent; an extracted vector identifies a command invocation, which may intentionally produce an error. Scenarios may require setup, multiple connections, persistence, cluster nodes or native-module fixtures.

• Native string configuration setters and load argv preserve binary data — tests/bdd/features/server.feature:607; command tag and invocation observed.
• Unknown native configuration names abort loading — tests/bdd/features/server.feature:707; command tag and invocation observed.

Extracted command vectors

The following JSON arrays are the test harness’s argument vectors, not shell commands. Numeric arguments are converted by the harness; objects of the form {"base64":"…"} represent decoded binary bytes, not a literal JSON command argument. Preserve scenario setup and connection ordering. See the CLI guide for shell quoting and binary stdin. No reply is invented or inferred.

Native string configuration setters and load argv preserve binary data — tests/bdd/features/server.feature:609 (the following commands succeed:)

Fixture-dependent: {{…}} tokens are replaced by the BDD runtime (for example, node ports, generated IDs or temporary paths). This is not a standalone executable command.

Binary payload: decode the base64 object to bytes using a client API or binary stdin; do not send the base64 text as the value.

[
  "MODULE",
  "LOADEX",
  "{{module_fixture}}",
  "CONFIG",
  "prefix",
  {
    "base64": "AP8="
  },
  "ARGS",
  "first",
  {
    "base64": "/wA="
  }
]

Unknown native configuration names abort loading — tests/bdd/features/server.feature:709 (I execute:)

Fixture-dependent: {{…}} tokens are replaced by the BDD runtime (for example, node ports, generated IDs or temporary paths). This is not a standalone executable command.

[
  "MODULE",
  "LOADEX",
  "{{module_fixture}}",
  "CONFIG",
  "unknown",
  "value"
]

Next source assertion: the reply is an error with code “ERR”