RESTORE

Creates a key from the serialized representation of a value.

Browse all commands · Upstream source documentation

Reference field	Value
Canonical name	RESTORE
Catalog group	Generic commands
Upstream since	2.6.0 — upstream Redis/module version, not an ffkv release
Pinned catalog	Redis 8.10.0

Syntax

RESTORE key ttl serialized-value [REPLACE] [ABSTTL]
  [IDLETIME seconds] [FREQ frequency]

ffkv behavior and limits

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.

Data-changing administration: use an isolated dataset or a verified backup. Lost replies have an unknown outcome; never blindly replay a destructive operation.

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) to create the new key and additional O(NM) to reconstruct the serialized value, 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). However for sorted set values the complexity is O(NMlog(N)) because inserting values into sorted sets is O(log(N)).

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

Command flags: WRITE, DENYOOM.

ACL categories: KEYSPACE, DANGEROUS.

Argument structure

Argument	Type	Constraints / metadata
key	key	key_spec_index: 0
ttl	integer	Required
serialized-value	string	Required
replace	pure-token	optional; token: REPLACE; since: 3.0.0
absttl	pure-token	optional; token: ABSTTL; since: 5.0.0
seconds	integer	optional; token: IDLETIME; since: 5.0.0
frequency	integer	optional; token: FREQ; since: 5.0.0

Key specifications

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

[
  {
    "flags": [
      "OW",
      "UPDATE"
    ],
    "begin_search": {
      "index": {
        "pos": 1
      }
    },
    "find_keys": {
      "range": {
        "lastkey": 0,
        "step": 1,
        "limit": 0
      }
    }
  }
]

Additional pinned upstream metadata

{
  "group": "generic",
  "since": "2.6.0",
  "history": [
    [
      "3.0.0",
      "Added the `REPLACE` modifier."
    ],
    [
      "5.0.0",
      "Added the `ABSTTL` modifier."
    ],
    [
      "5.0.0",
      "Added the `IDLETIME` and `FREQ` options."
    ]
  ]
}

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

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.

• 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.

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.

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

[
  "RESTORE",
  "hash-copy",
  0,
  {
    "saved": "hash-dump"
  }
]

Next source assertion: the reply equals:

"OK"

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

[
  "RESTORE",
  "restored",
  0,
  {
    "saved": "binary-dump"
  }
]

Next source assertion: the reply equals:

"OK"

Actual reads advance restored access frequency metadata — tests/bdd/features/generic.feature:976 (I execute:)

[
  "RESTORE",
  "frequent",
  0,
  {
    "saved": "frequency-dump"
  },
  "FREQ",
  42
]

Next source assertion: the reply equals:

"OK"