CLIENT PAUSE

Suspends commands processing.

Browse all commands · Upstream source documentation

Reference field	Value
Canonical name	CLIENT PAUSE
Catalog group	Connection commands
Upstream since	3.0.0 — upstream Redis/module version, not an ffkv release
Pinned catalog	Redis 8.10.0

Syntax

CLIENT PAUSE timeout [WRITE | ALL]

ffkv behavior and limits

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.

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: O(1)

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

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

ACL categories: CONNECTION.

Argument structure

Argument	Type	Constraints / metadata
timeout	integer	Required
mode	oneof	optional; since: 6.2.0
↳ write	pure-token	token: WRITE
↳ all	pure-token	token: ALL

Additional pinned upstream metadata

{
  "group": "connection",
  "since": "3.0.0",
  "history": [
    [
      "6.2.0",
      "`CLIENT PAUSE WRITE` mode added along with the `mode` option."
    ]
  ]
}

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

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.

• WRITE pauses hold may-replicate operations without holding reads (Scenario Outline) — tests/bdd/features/client_control_repair.feature:98; command tag and invocation observed.
• WRITE pause prevents delivery until the publisher is admitted (Scenario Outline) — tests/bdd/features/client_control_repair.feature:176; command tag and invocation observed.
• EXEC aggregates may-replicate pause classification from queued commands — tests/bdd/features/client_control_repair.feature:214; command tag and invocation observed.
• WRITE pause delays a real mutation but permits reads and an explicit unpause — tests/bdd/features/connections.feature:304; 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.

WRITE pause delays a real mutation but permits reads and an explicit unpause — tests/bdd/features/connections.feature:310 (I execute:)

[
  "CLIENT",
  "PAUSE",
  "10000",
  "WRITE"
]

Next source assertion: the reply equals:

"OK"

WRITE pauses hold may-replicate operations without holding reads — tests/bdd/features/client_control_repair.feature:100 (I execute:)

Expanded from an actual Examples row: command=["PUBLISH","news","message"].

[
  "CLIENT",
  "PAUSE",
  10000,
  "WRITE"
]