TS.ADD

Append a sample to a time series

Browse all commands · Upstream source documentation

Reference field	Value
Canonical name	`TS.ADD`
Catalog group	Time series commands
Upstream since	1.0.0 — upstream Redis/module version, not an ffkv release
Pinned catalog	Redis 8.10.0

Syntax

TS.ADD key timestamp value [RETENTION retentionPeriod]
  [ENCODING <UNCOMPRESSED | COMPRESSED>] [CHUNK SIZE size]
  [ON DUPLICATE <BLOCK | FIRST | LAST | MIN | MAX | SUM>]
  [LABELS label value [label value ...]]

ffkv behavior and limits

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.

Metadata availability

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.

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.

Explicit retention and duplicate policies govern updates and pruning — tests/bdd/features/timeseries.feature:5; command tag and invocation observed.
Counter deltas and inclusive deletion retain the correct remaining samples — tests/bdd/features/timeseries.feature:116; invocation observed.
NaN samples remain visible while aggregation counts distinguish missing numbers — tests/bdd/features/timeseries.feature:212; invocation observed.
Compaction exposes closed and open buckets and deleting its rule stops future output — tests/bdd/features/timeseries.feature:244; invocation observed.
Blocking reads wait for the requested number of samples then return values in order — tests/bdd/features/timeseries.feature:399; invocation observed.
Deleting the latest source bucket durably reopens the previous compaction bucket — tests/bdd/features/timeseries.feature:457; invocation observed.
Deleting every source sample resets compaction before earlier timestamps are reinserted — tests/bdd/features/timeseries.feature:519; 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.

Compaction exposes closed and open buckets and deleting its rule stops future output — tests/bdd/features/timeseries.feature:300 (client “ts3” executes:)

[
  "TS.ADD",
  "raw",
  250,
  20
]

Next source assertion: the reply equals:

Blocking reads wait for the requested number of samples then return values in order — tests/bdd/features/timeseries.feature:411 (I execute:)

[
  "TS.ADD",
  "sensor",
  10,
  2
]

Next source assertion: the reply equals:

Explicit retention and duplicate policies govern updates and pruning — tests/bdd/features/timeseries.feature:16 (client “ts3” executes:)

[
  "TS.ADD",
  "sensor",
  1000,
  2
]

Next source assertion: the reply equals: