Skip to content
Search ffkv docs

Search the complete handbook, locally.

    SUNSUBSCRIBE

    Stops listening to messages posted to shard channels.

    Browse all commands · Upstream source documentation

    Reference fieldValue
    Canonical nameSUNSUBSCRIBE
    Catalog groupPub/Sub commands
    Upstream since7.0.0 — upstream Redis/module version, not an ffkv release
    Pinned catalogRedis 8.10.0
    SUNSUBSCRIBE [shardchannel [shardchannel ...]]

    Pub/Sub is transient delivery, not durable leased jobs. Per client: 1,024 registrations, 8 MiB of names, 1,024-byte patterns, and 256 events/16 MiB of output. Overflow disconnects a slow subscriber; publications can fail the shared pattern-work budget.

    Source: README.md:487–524; tests/bdd/features/pubsub.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(N) where N is the number of shard channels to unsubscribe.

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

    Command flags: PUBSUB, NOSCRIPT, LOADING, STALE.

    ArgumentTypeConstraints / metadata
    shardchannelstringoptional; multiple

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

    [
    {
    "flags": [
    "NOT_KEY"
    ],
    "begin_search": {
    "index": {
    "pos": 1
    }
    },
    "find_keys": {
    "range": {
    "lastkey": -1,
    "step": 1,
    "limit": 0
    }
    }
    }
    ]
    Additional pinned upstream metadata
    {
    "group": "pubsub",
    "since": "7.0.0"
    }

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

    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.

    • Shard channels are disjoint from regular channels even when their names match — tests/bdd/features/pubsub.feature:152; command tag and invocation observed.
    • RESP3 subscription pushes do not prevent ordinary commands on the same connection — tests/bdd/features/pubsub.feature:230; command tag and 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.

    Shard channels are disjoint from regular channels even when their names match — tests/bdd/features/pubsub.feature:212 (client “shard” sends:)

    [
    "SUNSUBSCRIBE"
    ]

    Next source assertion: client “shard” receives:

    ["sunsubscribe","{orders}:events",0]

    RESP3 subscription pushes do not prevent ordinary commands on the same connection — tests/bdd/features/pubsub.feature:269 (client “listener” sends:)

    [
    "SUNSUBSCRIBE",
    "news"
    ]

    Next source assertion: client “listener” receives:

    {"type":"push","values":["sunsubscribe","news",0]}