docs-v2/content/flux/v0/stdlib/universe/timeshift.md

4.9 KiB

title description menu weight flux/v0/tags introduced
timeShift() function `timeShift()` adds a fixed duration to time columns.
flux_v0_ref
name parent identifier
timeShift universe universe/timeShift
101
transformations
date/time
0.7.0

timeShift() adds a fixed duration to time columns.

The output table schema is the same as the input table schema. null time values remain null.

Function type signature
(<-tables: stream[A], duration: duration, ?columns: [string]) => stream[A]

{{% caption %}} For more information, see Function type signatures. {{% /caption %}}

Parameters

duration

({{< req >}}) Amount of time to add to each time value. May be a negative duration.

columns

List of time columns to operate on. Default is ["_start", "_stop", "_time"].

tables

Input data. Default is piped-forward data (<-).

Examples

Shift timestamps forward in time

import "sampledata"

sampledata.int()
    |> timeShift(duration: 12h)

{{< expand-wrapper >}} {{% expand "View example input and output" %}}

Input data

_time _value *tag
2021-01-01T00:00:00Z -2 t1
2021-01-01T00:00:10Z 10 t1
2021-01-01T00:00:20Z 7 t1
2021-01-01T00:00:30Z 17 t1
2021-01-01T00:00:40Z 15 t1
2021-01-01T00:00:50Z 4 t1
_time _value *tag
2021-01-01T00:00:00Z 19 t2
2021-01-01T00:00:10Z 4 t2
2021-01-01T00:00:20Z -3 t2
2021-01-01T00:00:30Z 19 t2
2021-01-01T00:00:40Z 13 t2
2021-01-01T00:00:50Z 1 t2

Output data

_time _value *tag
2021-01-01T12:00:00Z -2 t1
2021-01-01T12:00:10Z 10 t1
2021-01-01T12:00:20Z 7 t1
2021-01-01T12:00:30Z 17 t1
2021-01-01T12:00:40Z 15 t1
2021-01-01T12:00:50Z 4 t1
_time _value *tag
2021-01-01T12:00:00Z 19 t2
2021-01-01T12:00:10Z 4 t2
2021-01-01T12:00:20Z -3 t2
2021-01-01T12:00:30Z 19 t2
2021-01-01T12:00:40Z 13 t2
2021-01-01T12:00:50Z 1 t2

{{% /expand %}} {{< /expand-wrapper >}}

Shift timestamps backward in time

import "sampledata"

sampledata.int()
    |> timeShift(duration: -12h)

{{< expand-wrapper >}} {{% expand "View example input and output" %}}

Input data

_time _value *tag
2021-01-01T00:00:00Z -2 t1
2021-01-01T00:00:10Z 10 t1
2021-01-01T00:00:20Z 7 t1
2021-01-01T00:00:30Z 17 t1
2021-01-01T00:00:40Z 15 t1
2021-01-01T00:00:50Z 4 t1
_time _value *tag
2021-01-01T00:00:00Z 19 t2
2021-01-01T00:00:10Z 4 t2
2021-01-01T00:00:20Z -3 t2
2021-01-01T00:00:30Z 19 t2
2021-01-01T00:00:40Z 13 t2
2021-01-01T00:00:50Z 1 t2

Output data

_time _value *tag
2020-12-31T12:00:00Z -2 t1
2020-12-31T12:00:10Z 10 t1
2020-12-31T12:00:20Z 7 t1
2020-12-31T12:00:30Z 17 t1
2020-12-31T12:00:40Z 15 t1
2020-12-31T12:00:50Z 4 t1
_time _value *tag
2020-12-31T12:00:00Z 19 t2
2020-12-31T12:00:10Z 4 t2
2020-12-31T12:00:20Z -3 t2
2020-12-31T12:00:30Z 19 t2
2020-12-31T12:00:40Z 13 t2
2020-12-31T12:00:50Z 1 t2

{{% /expand %}} {{< /expand-wrapper >}}