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

3.0 KiB
Raw Permalink Blame History

title description menu weight flux/v0/tags introduced
range() function `range()` filters rows based on time bounds.
flux_v0_ref
name parent identifier
range universe universe/range
101
transformations
filters
0.7.0

range() filters rows based on time bounds.

Input data must have a _time column of type time. Rows with a null value in the _time are filtered. range() adds a _start column with the value of start and a _stop column with the value of stop. _start and _stop columns are added to the group key. Each input tables group key value is modified to fit within the time bounds. Tables with all rows outside the time bounds are filtered entirely.

Function type signature
(<-tables: stream[{C with _time: time}], start: A, ?stop: B) => stream[{C with _time: time, _stop: time, _start: time}]

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

Parameters

start

({{< req >}}) Earliest time to include in results.

Results include rows with _time values that match the specified start time. Use a relative duration, absolute time, or integer (Unix timestamp in seconds). For example, -1h, 2019-08-28T22:00:00Z, or 1567029600. Durations are relative to now().

stop

Latest time to include in results. Default is now().

Results exclude rows with _time values that match the specified stop time. Use a relative duration, absolute time, or integer (Unix timestamp in seconds). For example, -1h, 2019-08-28T22:00:00Z, or 1567029600. Durations are relative to now().

tables

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

Examples

Query a time range relative to now

from(bucket: "example-bucket")
    |> range(start: -12h)

Query an absolute time range

from(bucket: "example-bucket")
    |> range(start: 2021-05-22T23:30:00Z, stop: 2021-05-23T00:00:00Z)

Query an absolute time range using Unix timestamps

from(bucket: "example-bucket")
    |> range(start: 1621726200, stop: 1621728000)