Back to Influxdb

timeShift() function

content/flux/v0/stdlib/universe/timeshift.md

latest4.7 KB
Original Source
<!------------------------------------------------------------------------------ IMPORTANT: This page was generated from comments in the Flux source code. Any edits made directly to this page will be overwritten the next time the documentation is generated. To make updates to this documentation, update the function comments above the function definition in the Flux source code: https://github.com/influxdata/flux/blob/master/stdlib/universe/universe.flux#L2421-L2421 Contributing to Flux: https://github.com/influxdata/flux#contributing Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md ------------------------------------------------------------------------------->

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
js
(<-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

js
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-2t1
2021-01-01T00:00:10Z10t1
2021-01-01T00:00:20Z7t1
2021-01-01T00:00:30Z17t1
2021-01-01T00:00:40Z15t1
2021-01-01T00:00:50Z4t1
_time_value*tag
2021-01-01T00:00:00Z19t2
2021-01-01T00:00:10Z4t2
2021-01-01T00:00:20Z-3t2
2021-01-01T00:00:30Z19t2
2021-01-01T00:00:40Z13t2
2021-01-01T00:00:50Z1t2

Output data

_time_value*tag
2021-01-01T12:00:00Z-2t1
2021-01-01T12:00:10Z10t1
2021-01-01T12:00:20Z7t1
2021-01-01T12:00:30Z17t1
2021-01-01T12:00:40Z15t1
2021-01-01T12:00:50Z4t1
_time_value*tag
2021-01-01T12:00:00Z19t2
2021-01-01T12:00:10Z4t2
2021-01-01T12:00:20Z-3t2
2021-01-01T12:00:30Z19t2
2021-01-01T12:00:40Z13t2
2021-01-01T12:00:50Z1t2

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

Shift timestamps backward in time

js
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-2t1
2021-01-01T00:00:10Z10t1
2021-01-01T00:00:20Z7t1
2021-01-01T00:00:30Z17t1
2021-01-01T00:00:40Z15t1
2021-01-01T00:00:50Z4t1
_time_value*tag
2021-01-01T00:00:00Z19t2
2021-01-01T00:00:10Z4t2
2021-01-01T00:00:20Z-3t2
2021-01-01T00:00:30Z19t2
2021-01-01T00:00:40Z13t2
2021-01-01T00:00:50Z1t2

Output data

_time_value*tag
2020-12-31T12:00:00Z-2t1
2020-12-31T12:00:10Z10t1
2020-12-31T12:00:20Z7t1
2020-12-31T12:00:30Z17t1
2020-12-31T12:00:40Z15t1
2020-12-31T12:00:50Z4t1
_time_value*tag
2020-12-31T12:00:00Z19t2
2020-12-31T12:00:10Z4t2
2020-12-31T12:00:20Z-3t2
2020-12-31T12:00:30Z19t2
2020-12-31T12:00:40Z13t2
2020-12-31T12:00:50Z1t2

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