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

2.6 KiB

title description menu weight flux/v0/tags introduced
hourSelection() function `hourSelection()` filters rows by time values in a specified hour range.
flux_v0_ref
name parent identifier
hourSelection universe universe/hourSelection
101
transformations
date/time
filters
0.39.0

hourSelection() filters rows by time values in a specified hour range.

Function type signature
(
    <-tables: stream[A],
    start: int,
    stop: int,
    ?location: {zone: string, offset: duration},
    ?timeColumn: string,
) => stream[A] where A: Record

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

Parameters

start

({{< req >}}) First hour of the hour range (inclusive). Hours range from [0-23].

stop

({{< req >}}) Last hour of the hour range (inclusive). Hours range from [0-23].

location

Location used to determine timezone. Default is the location option.

timeColumn

Column that contains the time value. Default is _time.

tables

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

Examples

Filter by business hours

data
    |> hourSelection(start: 9, stop: 17)

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

Input data

_time tag _value
2022-01-01T05:00:00Z t1 -2
2022-01-01T09:00:10Z t1 10
2022-01-01T11:00:20Z t1 7
2022-01-01T16:00:30Z t1 17
2022-01-01T19:00:40Z t1 15
2022-01-01T20:00:50Z t1 4

Output data

_time tag _value
2022-01-01T09:00:10Z t1 10
2022-01-01T11:00:20Z t1 7
2022-01-01T16:00:30Z t1 17

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