Skip to content
Search ffkv docs

Search the complete handbook, locally.

    TS.READ

    Read: return up to max_count samples with timestamp >= timestamp. With BLOCK, waits up to milliseconds ms until at least min_count qualifying samples exist

    Browse all commands · Upstream source documentation

    Reference fieldValue
    Canonical nameTS.READ
    Catalog groupTime series commands
    Upstream since8.10.0 — upstream Redis/module version, not an ffkv release
    Pinned catalogRedis 8.10.0
    TS.READ key timestamp [BLOCK milliseconds min count]
    [MAX COUNT max count]

    Time-series chunks, retention, labels and live compaction rules are implemented in RAM. TS.READ BLOCK uses bounded actor waiters and is rejected in EXEC/Lua; other reads may be used without blocking. Hybrid does not offload time-series chunks.

    Source: README.md:294, 351–353, 375–377; tests/bdd/features/timeseries.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.

    This command is in the canonical catalog but has no matching entry in the pinned src/command_metadata.json. Argument flags, complexity and key specifications are not invented. Use the syntax, upstream source documentation and actual scenario evidence below.

    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.

    • Blocking reads wait for the requested number of samples then return values in order — tests/bdd/features/timeseries.feature:399; 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.

    Blocking reads wait for the requested number of samples then return values in order — tests/bdd/features/timeseries.feature:431 (client “ts3” executes:)

    [
    "TS.READ",
    "sensor",
    20,
    "MAX_COUNT",
    1
    ]

    Next source assertion: the reply equals:

    [[20,{"$approx":4}]]

    Blocking reads wait for the requested number of samples then return values in order — tests/bdd/features/timeseries.feature:406 (client “ts3” sends:)

    [
    "TS.READ",
    "sensor",
    10,
    "BLOCK",
    0,
    2,
    "MAX_COUNT",
    2
    ]