Skip to content
Search ffkv docs

Search the complete handbook, locally.

    WAIT

    Blocks until the asynchronous replication of all preceding write commands sent by the connection is completed.

    Browse all commands · Upstream source documentation

    Reference fieldValue
    Canonical nameWAIT
    Catalog groupGeneric commands
    Upstream since3.0.0 — upstream Redis/module version, not an ffkv release
    Pinned catalogRedis 8.10.0
    WAIT numreplicas timeout

    TTL deadlines use wall-clock time and remain absolute across restart. Key/database operations can overwrite or remove data; SCAN is incremental rather than an atomic snapshot. New typed structures remain in RAM in hybrid mode.

    Source: README.md:193–195, 375–377, 584–585; tests/bdd/features/generic.feature.

    Native RESP replication is asynchronous and distinct from HTTP snapshot polling. WAIT/WAITAOF barriers belong on the writing connection; acknowledgements do not certify failover safety. Upstream network policy and persistent storage must be configured deliberately (README.md:601–628).

    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)

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

    Command flags: BLOCKING.

    ACL categories: CONNECTION.

    Command tips: REQUEST_POLICY:ALL_SHARDS, RESPONSE_POLICY:AGG_MIN.

    ArgumentTypeConstraints / metadata
    numreplicasintegerRequired
    timeoutintegerRequired
    Additional pinned upstream metadata
    {
    "group": "generic",
    "since": "3.0.0"
    }

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

    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.

    • Replication WAIT is unblocked by exact client identity (Scenario Outline) — tests/bdd/features/client_control_repair.feature:5; command tag and invocation observed.
    • TIMEOUT unblocking preserves acknowledgments already received from a replica (Scenario Outline) — tests/bdd/features/client_control_repair.feature:129; command tag and invocation observed.
    • Waiting for an unavailable replica reports zero without losing the preceding write — tests/bdd/features/generic.feature:1499; command tag and invocation observed.
    • Processed ACK does not pretend the replica has fsynced the write — tests/bdd/features/replication.feature:178; command tag and invocation observed.
    • Wait uses this connection’s watermark rather than another writer’s offset — tests/bdd/features/replication.feature:217; command tag and invocation observed.
    • Disconnected replicas are not counted and replicas reject wait commands — tests/bdd/features/replication.feature:263; 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.

    Waiting for an unavailable replica reports zero without losing the preceding write — tests/bdd/features/generic.feature:1505 (I execute:)

    [
    "WAIT",
    1,
    1
    ]

    Next source assertion: the reply equals:

    0

    Wait uses this connection’s watermark rather than another writer’s offset — tests/bdd/features/replication.feature:236 (client “early” on node “master” executes:)

    [
    "WAIT",
    "1",
    "20"
    ]

    Next source assertion: the reply equals:

    1

    Processed ACK does not pretend the replica has fsynced the write — tests/bdd/features/replication.feature:185 (node “master” executes:)

    [
    "WAIT",
    "1",
    "2000"
    ]

    Next source assertion: the reply equals:

    1