Skip to content
Search ffkv docs

Search the complete handbook, locally.

    CLIENT LIST

    Lists open connections.

    Browse all commands · Upstream source documentation

    Reference fieldValue
    Canonical nameCLIENT LIST
    Catalog groupConnection commands
    Upstream since2.4.0 — upstream Redis/module version, not an ffkv release
    Pinned catalogRedis 8.10.0
    CLIENT LIST [TYPE <NORMAL | MASTER | REPLICA | PUBSUB>]
    [ID client-id [client-id ...]]

    Connection state, selected database, authentication and protocol negotiation belong to the same persistent connection. RESP2 is the default; HELLO 3 selects RESP3. Streamed/unknown-length RESP3 frames are not supported.

    Source: README.md:96–120, 391–395; tests/bdd/features/connections.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 client connections

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

    Command flags: ADMIN, NOSCRIPT, LOADING, STALE, SENTINEL.

    ACL categories: CONNECTION.

    Command tips: NONDETERMINISTIC_OUTPUT.

    ArgumentTypeConstraints / metadata
    client-typeoneofoptional; token: TYPE; since: 5.0.0
    ↳ normalpure-tokentoken: normal
    ↳ masterpure-tokentoken: master
    ↳ replicapure-tokentoken: replica
    ↳ pubsubpure-tokentoken: pubsub
    client-idintegeroptional; multiple; token: ID; since: 6.2.0
    Additional pinned upstream metadata
    {
    "group": "connection",
    "since": "2.4.0",
    "history": [
    [
    "2.8.12",
    "Added unique client `id` field."
    ],
    [
    "5.0.0",
    "Added optional `TYPE` filter."
    ],
    [
    "6.0.0",
    "Added `user` field."
    ],
    [
    "6.2.0",
    "Added `argv-mem`, `tot-mem`, `laddr` and `redir` fields and the optional `ID` filter."
    ],
    [
    "7.0.0",
    "Added `resp`, `multi-mem`, `rbs` and `rbp` fields."
    ],
    [
    "7.0.3",
    "Added `ssub` field."
    ],
    [
    "7.2.0",
    "Added `lib-name` and `lib-ver` fields."
    ],
    [
    "7.4.0",
    "Added `watch` field."
    ],
    [
    "8.0.0",
    "Added `io-thread` field."
    ]
    ]
    }

    Metadata source · Local snapshot: src/command_metadata.json, key client|list.

    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.

    • TIMEOUT unblocking preserves acknowledgments already received from a replica (Scenario Outline) — tests/bdd/features/client_control_repair.feature:129; invocation observed.
    • Client inspection reflects real metadata and the selected database with scoped ID filtering — tests/bdd/features/connections.feature:137; command tag and invocation observed.
    • Killing a selected client closes its actual socket without killing another connection — tests/bdd/features/connections.feature:266; 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.

    Killing a selected client closes its actual socket without killing another connection — tests/bdd/features/connections.feature:294 (I execute:)

    [
    "CLIENT",
    "LIST",
    "ID",
    {
    "saved": "victim-id"
    }
    ]

    Next source assertion: the reply equals:

    ""

    TIMEOUT unblocking preserves acknowledgments already received from a replica — tests/bdd/features/client_control_repair.feature:153 (client “observer” on node “master” executes:)

    Expanded from an actual Examples row: command=["WAIT",2,0], reply=1.

    [
    "CLIENT",
    "LIST",
    "ID",
    {
    "saved": "replicated-wait-id"
    }
    ]

    Next source assertion: the reply text contains “flags=b”

    Client inspection reflects real metadata and the selected database with scoped ID filtering — tests/bdd/features/connections.feature:179 (I execute:)

    [
    "CLIENT",
    "LIST",
    "TYPE",
    "NORMAL",
    "ID",
    {
    "saved": "inspected-id"
    }
    ]

    Next source assertion: the reply text contains “name=inspected”