Skip to content
Search ffkv docs

Search the complete handbook, locally.

    MODULE LOAD

    Loads a module.

    Browse all commands · Upstream source documentation

    Reference fieldValue
    Canonical nameMODULE LOAD
    Catalog groupServer commands
    Upstream since4.0.0 — upstream Redis/module version, not an ffkv release
    Pinned catalogRedis 8.10.0
    MODULE LOAD path [arg [arg ...]]

    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.

    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.

    ArgumentTypeConstraints / metadata
    pathstringRequired
    argstringoptional; multiple
    Additional pinned upstream metadata
    {
    "group": "server",
    "since": "4.0.0"
    }

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

    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.

    • A disconnected debugger queued behind a native command cannot strand the actor (Scenario Outline) — tests/bdd/features/client_control_repair.feature:300; command tag and invocation observed.
    • Native module callbacks cannot hide command denials from ACL LOG — tests/bdd/features/client_control_repair.feature:448; command tag and invocation observed.
    • Full polling image replacement retains local command registry ownership — tests/bdd/features/replication.feature:460; command tag and invocation observed.
    • Latency history and diagnostics reflect a recorded execution delay — tests/bdd/features/server.feature:370; invocation observed.
    • Only actually loaded native libraries appear in the module list — tests/bdd/features/server.feature:529; invocation observed.
    • Real native callbacks register commands and unload releases module globals — tests/bdd/features/server.feature:554; command tag and invocation observed.
    • Duplicate native loads do not reinitialize existing module globals — tests/bdd/features/server.feature:631; command tag and invocation observed.
    • Failed native initialization never publishes partial registrations (Scenario Outline) — tests/bdd/features/server.feature:652; command tag and invocation observed.
    • Missing native libraries fail without fake built-in module registrations — tests/bdd/features/server.feature:690; command tag and invocation observed.
    • A real OnUnload refusal preserves the library and command registration — tests/bdd/features/server.feature:721; invocation observed.
    • An active native callback pins its library until it returns — tests/bdd/features/server.feature:752; invocation observed.
    • Native registered command flags participate in ACL authorization — tests/bdd/features/server.feature:782; command tag and invocation observed.
    • Native command arity and error replies do not unload the library — tests/bdd/features/server.feature:815; command tag and invocation observed.
    • Native Call and key handles mutate the actual durable engine — tests/bdd/features/server.feature:841; command tag and invocation observed.
    • Native key metadata enforces ACL key patterns and nested Call permissions — tests/bdd/features/server.feature:874; command tag and invocation observed.
    • Native commands run inside transactions and scripts unless their registered flags forbid it — tests/bdd/features/server.feature:917; command tag and invocation observed.
    • Native command metadata exposes actual arity flags and key positions — tests/bdd/features/server.feature:946; command tag and invocation observed.

    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.

    Full polling image replacement retains local command registry ownership — tests/bdd/features/replication.feature:470 (node “polling-follower” executes:)

    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",
    "LOAD",
    "{{module_fixture}}"
    ]

    Next source assertion: the reply equals:

    "OK"

    Only actually loaded native libraries appear in the module list — tests/bdd/features/server.feature:539 (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.

    [
    "MODULE",
    "LOAD",
    "{{module_fixture}}",
    "first"
    ]

    A real OnUnload refusal preserves the library and command registration — tests/bdd/features/server.feature:723 (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.

    [
    "MODULE",
    "LOAD",
    "{{module_fixture}}",
    "--unload-marker",
    "{{directory}}/module-unloaded"
    ]