Back to Redis

TS.DEL

content/commands/ts.del.md

latest3.9 KB
Original Source

Delete all samples between two timestamps for a given time series

Examples

Required arguments

<details open><summary><code>key</code></summary>

is key name for the time series.

</details> <details open><summary><code>fromTimestamp</code></summary>

is start timestamp for the range deletion.

</details> <details open><summary><code>toTimestamp</code></summary>

is end timestamp for the range deletion.

The given timestamp interval is closed (inclusive), meaning that samples whose timestamp eqauls the fromTimestamp or toTimestamp are also deleted.

<note><b>Notes:</b>

  • If fromTimestamp is older than the retention period compared to the maximum existing timestamp, the deletion is discarded and an error is returned.
  • When deleting a sample from a time series for which compaction rules are defined:
    • If all the original samples for an affected compaction bucket are available, the compacted value is recalculated based on the remaining original samples, or removed if all original samples within the compaction bucket were deleted.
    • If original samples for an affected compaction bucket were expired, the deletion is discarded and an error is returned.
  • Explicitly deleting samples from a compacted time series may result in inconsistencies between the raw and the compacted data. The compaction process may override such samples. That being said, it is safe to explicitly delete samples from a compacted time series beyond the retention period of the original time series.
</note>

Examples

<details open><summary><b>Delete range of data points</b></summary>

Create time series for temperature in Tel Aviv and Jerusalem, then add different temperature samples.

{{< highlight bash >}} 127.0.0.1:6379> TS.CREATE temp:TLV LABELS type temp location TLV OK 127.0.0.1:6379> TS.CREATE temp:JLM LABELS type temp location JLM OK 127.0.0.1:6379> TS.MADD temp:TLV 1000 30 temp:TLV 1010 35 temp:TLV 1020 9999 temp:TLV 1030 40

  1. (integer) 1000
  2. (integer) 1010
  3. (integer) 1020
  4. (integer) 1030 127.0.0.1:6379> TS.MADD temp:JLM 1005 30 temp:JLM 1015 35 temp:JLM 1025 9999 temp:JLM 1035 40
  5. (integer) 1005
  6. (integer) 1015
  7. (integer) 1025
  8. (integer) 1035 {{< / highlight >}}

Delete the range of data points for temperature in Tel Aviv.

{{< highlight bash >}} 127.0.0.1:6379> TS.DEL temp:TLV 1000 1030 (integer) 4 {{< / highlight >}}

</details>

Redis Software and Redis Cloud compatibility

| Redis Software | Redis Cloud | <span style="min-width: 9em; display: table-cell">Notes</span> | |:----------------------|:-----------------|:------| | <span title="Supported">✅ Supported</span> | <span title="Supported">✅ Flexible & Annual</span> <span title="Supported">✅ Free & Fixed</nobr></span> | |

Return information

{{< multitabs id="ts-del-return-info" tab1="RESP2" tab2="RESP3" >}}

One of the following:

  • [Integer reply]({{< relref "/develop/reference/protocol-spec#integers" >}}): the number of samples that were deleted.
  • [Simple error reply]({{< relref "/develop/reference/protocol-spec#simple-errors" >}}) in these cases: invalid arguments, wrong key type, timestamp is older than the retention period compared to the maximum existing timestamp, or when an affected compaction bucket cannot be recalculated.

-tab-sep-

One of the following:

  • [Integer reply]({{< relref "/develop/reference/protocol-spec#integers" >}}): the number of samples that were deleted.
  • [Simple error reply]({{< relref "/develop/reference/protocol-spec#simple-errors" >}}) in these cases: invalid arguments, wrong key type, timestamp is older than the retention period compared to the maximum existing timestamp, or when an affected compaction bucket cannot be recalculated.

{{< /multitabs >}}

See also

[TS.ADD]({{< relref "commands/ts.add/" >}})

[RedisTimeSeries]({{< relref "/develop/data-types/timeseries/" >}})