Skip to content
Search ffkv docs

Search the complete handbook, locally.

    FUNCTION LIST

    Returns information about all libraries.

    Browse all commands · Upstream source documentation

    Reference fieldValue
    Canonical nameFUNCTION LIST
    Catalog groupScripting commands
    Upstream since7.0.0 — upstream Redis/module version, not an ffkv release
    Pinned catalogRedis 8.10.0
    FUNCTION LIST [LIBRARYNAME library-name-pattern] [WITHCODE]

    Sandboxed Lua 5.1 is bounded to 1 million instructions, 32 MiB Lua memory, 64 nesting levels, 8 MiB scripts/bridge values/replies, 10,000 bridge calls and 16 MiB cumulative bridge arguments. Writes before runtime errors commit. The volatile SHA cache holds 256 scripts/16 MiB with FIFO eviction; durable function libraries cap at 256 and one 16 MiB encoded WAL frame.

    Source: README.md:426–449; tests/bdd/features/scripting.feature.

    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(N) where N is the number of functions

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

    Command flags: NOSCRIPT.

    ACL categories: SCRIPTING.

    Command tips: NONDETERMINISTIC_OUTPUT_ORDER.

    ArgumentTypeConstraints / metadata
    library-name-patternstringoptional; token: LIBRARYNAME
    withcodepure-tokenoptional; token: WITHCODE
    Additional pinned upstream metadata
    {
    "group": "scripting",
    "since": "7.0.0"
    }

    Metadata source · Local snapshot: src/command_metadata.json, key function|list.

    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.

    • Named callbacks share local helpers and expose registration metadata — tests/bdd/features/scripting.feature:123; command tag and invocation observed.
    • Invalid replacement cannot discard the previous library — tests/bdd/features/scripting.feature:177; command tag and invocation observed.
    • Function containers restore with append replace and flush policies — tests/bdd/features/scripting.feature:211; invocation observed.
    • Library source and optional metadata roundtrip through WITHCODE — tests/bdd/features/scripting.feature:684; 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.

    Function containers restore with append replace and flush policies — tests/bdd/features/scripting.feature:292 (I execute:)

    [
    "FUNCTION",
    "LIST"
    ]

    Next source assertion: the reply equals:

    []

    Named callbacks share local helpers and expose registration metadata — tests/bdd/features/scripting.feature:154 (client “metadata” executes:)

    [
    "FUNCTION",
    "LIST",
    "LIBRARYNAME",
    "invent[oa]ry"
    ]

    Next source assertion: the reply equals:

    [{"library_name":"inventory","engine":"LUA","functions":[{"name":"inventory_get","description":"Read an item","flags":["no-writes"]}]}]

    Invalid replacement cannot discard the previous library — tests/bdd/features/scripting.feature:201 (I execute:)

    [
    "FUNCTION",
    "LIST",
    "LIBRARYNAME",
    "empty",
    "WITHCODE"
    ]

    Next source assertion: the reply equals:

    []