SCAN

Iterates over the key names in the database.

Browse all commands · Upstream source documentation

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

Syntax

SCAN cursor [MATCH pattern] [COUNT count] [TYPE type]

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.

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) for every call. O(N) for a complete iteration, including enough command calls for the cursor to return back to 0. N is the number of elements inside the collection.

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

Command flags: READONLY, TOUCHES_ARBITRARY_KEYS.

ACL categories: KEYSPACE.

Command tips: NONDETERMINISTIC_OUTPUT, REQUEST_POLICY:SPECIAL, RESPONSE_POLICY:SPECIAL.

Argument structure

Argument	Type	Constraints / metadata
cursor	integer	Required
pattern	pattern	optional; token: MATCH
count	integer	optional; token: COUNT
type	string	optional; token: TYPE; since: 6.0.0

Additional pinned upstream metadata

{
  "group": "generic",
  "since": "2.8.0",
  "history": [
    [
      "6.0.0",
      "Added the `TYPE` subcommand."
    ]
  ]
}

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

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.

• A complete singleton scan supports MATCH COUNT TYPE and a terminal empty result — tests/bdd/features/generic.feature:1159; command tag and 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.

A complete singleton scan supports MATCH COUNT TYPE and a terminal empty result — tests/bdd/features/generic.feature:1193 (I execute:)

[
  "SCAN",
  0
]

Next source assertion: the reply equals:

["0",[]]

A complete singleton scan supports MATCH COUNT TYPE and a terminal empty result — tests/bdd/features/generic.feature:1181 (I execute:)

[
  "SCAN",
  0,
  "MATCH",
  "other:*",
  "COUNT",
  10000
]

Next source assertion: the reply equals:

["0",[]]

A complete singleton scan supports MATCH COUNT TYPE and a terminal empty result — tests/bdd/features/generic.feature:1165 (I execute:)

[
  "SCAN",
  0,
  "MATCH",
  "queue:*",
  "COUNT",
  10000,
  "TYPE",
  "list"
]

Next source assertion: the reply equals:

["0",["queue:only"]]