Skip to content
Search ffkv docs

Search the complete handbook, locally.

    PFADD

    Adds elements to a HyperLogLog key. Creates the key if it doesn’t exist.

    Browse all commands · Upstream source documentation

    Reference fieldValue
    Canonical namePFADD
    Catalog groupHyperLogLog commands
    Upstream since2.8.9 — upstream Redis/module version, not an ffkv release
    Pinned catalogRedis 8.10.0
    PFADD key [element [element ...]]

    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.

    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 add every element.

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

    Command flags: WRITE, DENYOOM, FAST.

    ACL categories: HYPERLOGLOG.

    ArgumentTypeConstraints / metadata
    keykeykey_spec_index: 0
    elementstringoptional; multiple

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

    [
    {
    "flags": [
    "RW",
    "INSERT"
    ],
    "begin_search": {
    "index": {
    "pos": 1
    }
    },
    "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 pfadd.

    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.

    • Duplicate elements do not update cardinality and cache invalidates — tests/bdd/features/hyperloglog.feature:5; command tag and invocation observed.
    • Union deduplicates overlapping input and supports destination aliases — tests/bdd/features/hyperloglog.feature:89; invocation observed.
    • Register diagnostics return decoded registers without changing cardinality — tests/bdd/features/hyperloglog.feature:232; invocation observed.
    • Seeded register and estimator diagnostics preserve database keys — tests/bdd/features/hyperloglog.feature:257; invocation observed.
    • PFADD rejects invalid HYLL without mutating existing values — tests/bdd/features/hyperloglog.feature:294; command tag and invocation observed.
    • PFCOUNT rejects invalid HYLL without mutating existing values — tests/bdd/features/hyperloglog.feature:323; invocation observed.
    • PFMERGE rejects invalid HYLL without mutating existing values — tests/bdd/features/hyperloglog.feature:352; invocation observed.
    • PFDEBUG rejects invalid HYLL without mutating existing values — tests/bdd/features/hyperloglog.feature:381; invocation observed.
    • Sketch merges and cache refresh retain expiry and survive recovery — tests/bdd/features/hyperloglog.feature:436; 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.

    Duplicate elements do not update cardinality and cache invalidates — tests/bdd/features/hyperloglog.feature:7 (I execute:)

    [
    "PFADD",
    "h"
    ]

    Next source assertion: the reply equals:

    1

    Seeded register and estimator diagnostics preserve database keys — tests/bdd/features/hyperloglog.feature:259 (the following commands succeed:)

    [
    "PFADD",
    "h",
    "a",
    "b"
    ]

    Sketch merges and cache refresh retain expiry and survive recovery — tests/bdd/features/hyperloglog.feature:438 (the following commands succeed:)

    [
    "PFADD",
    "a",
    "a",
    "b"
    ]