PFDEBUG

Internal commands for debugging HyperLogLog values.

Browse all commands · Upstream source documentation

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

Syntax

PFDEBUG subcommand key

ffkv behavior and limits

Cardinality is approximate. ffkv uses Redis-compatible HYLL registers and unions; this does not establish compatibility for every arbitrary or corrupted upstream dump.

Source: README.md:288; src/engine/hyperloglog.rs; tests/bdd/features/hyperloglog.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: N/A

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

Command flags: WRITE, DENYOOM, ADMIN.

ACL categories: HYPERLOGLOG.

Documentation flags: SYSCMD.

Argument structure

Argument	Type	Constraints / metadata
subcommand	string	Required
key	key	key_spec_index: 0

Key specifications

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

[
  {
    "flags": [
      "RW",
      "ACCESS"
    ],
    "begin_search": {
      "index": {
        "pos": 2
      }
    },
    "find_keys": {
      "range": {
        "lastkey": 0,
        "step": 1,
        "limit": 0
      }
    }
  }
]

Additional pinned upstream metadata

{
  "group": "hyperloglog",
  "since": "2.8.9"
}

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

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.

• Sparse decoding and dense conversion expose real representation — tests/bdd/features/hyperloglog.feature:161; command tag and invocation observed.
• Register diagnostics return decoded registers without changing cardinality — tests/bdd/features/hyperloglog.feature:232; command tag and invocation observed.
• PFDEBUG rejects invalid HYLL without mutating existing values — tests/bdd/features/hyperloglog.feature:381; command tag and invocation observed.
• Malformed sparse runs are rejected before cache or register access — tests/bdd/features/hyperloglog.feature:410; 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.

Sparse decoding and dense conversion expose real representation — tests/bdd/features/hyperloglog.feature:167 (I execute:)

[
  "PFDEBUG",
  "DECODE",
  "h"
]

Next source assertion: the reply equals:

"Z:16384"

Register diagnostics return decoded registers without changing cardinality — tests/bdd/features/hyperloglog.feature:238 (I execute:)

[
  "PFDEBUG",
  "GETREG",
  "h"
]

Next source assertion: the reply has 16384 items

PFDEBUG rejects invalid HYLL without mutating existing values — tests/bdd/features/hyperloglog.feature:387 (I execute:)

[
  "PFDEBUG",
  "GETREG",
  "bad"
]

Next source assertion: the reply is an error with code “WRONGTYPE”