Skip to content
Search ffkv docs

Search the complete handbook, locally.

    EVALSHA

    Executes a server-side Lua script by SHA1 digest.

    Browse all commands · Upstream source documentation

    Reference fieldValue
    Canonical nameEVALSHA
    Catalog groupScripting commands
    Upstream since2.6.0 — upstream Redis/module version, not an ffkv release
    Pinned catalogRedis 8.10.0
    EVALSHA sha1 numkeys [key [key ...]] [arg [arg ...]]

    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: Depends on the script that is executed.

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

    Command flags: NOSCRIPT, SKIP_MONITOR, MAY_REPLICATE, NO_MANDATORY_KEYS, SCRIPT_RUNNER, STALE.

    ACL categories: SCRIPTING.

    ArgumentTypeConstraints / metadata
    sha1stringRequired
    numkeysintegerRequired
    keykeyoptional; multiple; key_spec_index: 0
    argstringoptional; multiple

    Upstream key discovery descriptors (indexes are relative to the full command vector):

    [
    {
    "flags": [
    "RW",
    "ACCESS",
    "UPDATE"
    ],
    "begin_search": {
    "index": {
    "pos": 2
    }
    },
    "find_keys": {
    "keynum": {
    "keynumidx": 0,
    "firstkey": 1,
    "step": 1
    }
    }
    }
    ]
    Additional pinned upstream metadata
    {
    "group": "scripting",
    "since": "2.6.0"
    }

    Metadata source · Local snapshot: src/command_metadata.json, key evalsha.

    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.

    • Compiled script cache lookup is separate from durable data — tests/bdd/features/scripting.feature:30; command tag and invocation observed.
    • A valid write-capable shebang script rejects readonly entry points — tests/bdd/features/scripting.feature:770; command tag and invocation observed.
    • Invalid counted script keys fail during EXEC without discarding adjacent writes (Scenario Outline) — tests/bdd/features/transactions.feature:289; 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.

    Invalid counted script keys fail during EXEC without discarding adjacent writes — tests/bdd/features/transactions.feature:295 (I execute:)

    Expanded from an actual Examples row: command=EVALSHA, count=-1, error=ERR Number of keys can't be negative.

    [
    "EVALSHA",
    "return 1",
    "-1"
    ]

    Next source assertion: the reply equals:

    "QUEUED"

    Compiled script cache lookup is separate from durable data — tests/bdd/features/scripting.feature:45 (I execute:)

    [
    "EVALSHA",
    {
    "saved": "digest"
    },
    "1",
    "counter"
    ]

    Next source assertion: the reply equals:

    1

    A valid write-capable shebang script rejects readonly entry points — tests/bdd/features/scripting.feature:790 (I execute:)

    [
    "EVALSHA",
    {
    "saved": "write-capable-digest"
    },
    0
    ]

    Next source assertion: the reply equals:

    42