Skip to content
Search ffkv docs

Search the complete handbook, locally.

    XDEL

    Returns the number of messages after removing them from a stream.

    Browse all commands · Upstream source documentation

    Reference fieldValue
    Canonical nameXDEL
    Catalog groupStream commands
    Upstream since5.0.0 — upstream Redis/module version, not an ffkv release
    Pinned catalogRedis 8.10.0
    XDEL key id [id ...]

    Stream waits are bounded to 65,536 clients and 64 MiB of retained logical requests (also limited by the connection cap). Approximate MAXLEN trimming uses 100-entry granularity. EXEC/Lua reads never block. Physical index statistics describe ffkv, not Redis allocator internals.

    Source: README.md:351–374; tests/bdd/features/streams.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) for each single item to delete in the stream, regardless of the stream size.

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

    Command flags: WRITE, FAST.

    ACL categories: STREAM.

    ArgumentTypeConstraints / metadata
    keykeykey_spec_index: 0
    IDstringmultiple

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

    [
    {
    "flags": [
    "RW",
    "DELETE"
    ],
    "begin_search": {
    "index": {
    "pos": 1
    }
    },
    "find_keys": {
    "range": {
    "lastkey": 0,
    "step": 1,
    "limit": 0
    }
    }
    }
    ]
    Additional pinned upstream metadata
    {
    "group": "stream",
    "since": "5.0.0"
    }

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

    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.

    • Explicit IDs preserve duplicate field ordering and range direction — tests/bdd/features/streams.feature:5; command tag and invocation observed.
    • Idempotency replay retains original payload and configuration reset permits a fresh append — tests/bdd/features/streams.feature:497; 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.

    Explicit IDs preserve duplicate field ordering and range direction — tests/bdd/features/streams.feature:60 (I execute:)

    [
    "XDEL",
    "events",
    "1001-0",
    "999-0"
    ]

    Next source assertion: the reply equals:

    1

    Idempotency replay retains original payload and configuration reset permits a fresh append — tests/bdd/features/streams.feature:594 (I execute:)

    [
    "XDEL",
    "events",
    {
    "saved": "new-id"
    }
    ]

    Next source assertion: the reply equals:

    1