Skip to content
Search ffkv docs

Search the complete handbook, locally.

    DUMP

    Returns a serialized representation of the value stored at a key.

    Browse all commands · Upstream source documentation

    Reference fieldValue
    Canonical nameDUMP
    Catalog groupGeneric commands
    Upstream since2.6.0 — upstream Redis/module version, not an ffkv release
    Pinned catalogRedis 8.10.0
    DUMP key

    TTL deadlines use wall-clock time and remain absolute across restart. Key/database operations can overwrite or remove data; SCAN is incremental rather than an atomic snapshot. New typed structures remain in RAM in hybrid mode.

    Source: README.md:193–195, 375–377, 584–585; tests/bdd/features/generic.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(1) to access the key and additional O(NM) to serialize it, where N is the number of Redis objects composing the value and M their average size. For small string values the time complexity is thus O(1)+O(1M) where M is small, so simply O(1).

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

    Command flags: READONLY.

    ACL categories: KEYSPACE.

    Command tips: NONDETERMINISTIC_OUTPUT.

    ArgumentTypeConstraints / metadata
    keykeykey_spec_index: 0

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

    [
    {
    "flags": [
    "RO",
    "ACCESS"
    ],
    "begin_search": {
    "index": {
    "pos": 1
    }
    },
    "find_keys": {
    "range": {
    "lastkey": 0,
    "step": 1,
    "limit": 0
    }
    }
    }
    ]
    Additional pinned upstream metadata
    {
    "group": "generic",
    "since": "2.6.0"
    }

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

    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.

    • Restore-asking uses the same verified value payload and collision rules — tests/bdd/features/catalog.feature:212; invocation observed.
    • Dump and restore round trip binary values without copying the source key deadline — tests/bdd/features/generic.feature:182; command tag and invocation observed.
    • Invalid serialized data cannot replace a live value or its deadline — tests/bdd/features/generic.feature:256; command tag and invocation observed.
    • Hash serialization preserves binary fields and absolute field expiration independently — tests/bdd/features/generic.feature:316; command tag and invocation observed.
    • Touch refreshes actual restored idle metadata without changing values or deadlines — tests/bdd/features/generic.feature:905; invocation observed.
    • Actual reads advance restored access frequency metadata — tests/bdd/features/generic.feature:965; 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.

    Dump and restore round trip binary values without copying the source key deadline — tests/bdd/features/generic.feature:249 (I execute:)

    [
    "DUMP",
    "missing"
    ]

    Next source assertion: the reply is null

    Hash serialization preserves binary fields and absolute field expiration independently — tests/bdd/features/generic.feature:322 (I execute:)

    [
    "DUMP",
    "hash"
    ]

    Touch refreshes actual restored idle metadata without changing values or deadlines — tests/bdd/features/generic.feature:911 (I execute:)

    [
    "DUMP",
    "seed"
    ]