docs-v2/content/flux/v0/stdlib/experimental/iox/from.md

1.8 KiB

title description menu weight flux/v0/tags
iox.from() function `iox.from()` reads from the selected bucket and measurement in an IOx storage node.
flux_v0_ref
name parent identifier
iox.from experimental/iox experimental/iox/from
201
inputs

iox.from() reads from the selected bucket and measurement in an IOx storage node.

This function creates a source that reads data from IOx. Output data is "pivoted" on the time column and includes columns for each returned tag and field per time value.

Function type signature
(bucket: string, measurement: string) => stream[{A with _time: time}] where A: Record

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

Parameters

bucket

({{< req >}}) IOx bucket to read data from.

measurement

({{< req >}}) Measurement to read data from.

Examples

Use Flux to query data from IOx

import "experimental/iox"

iox.from(bucket: "example-bucket", measurement: "example-measurement")
    |> range(start: -1d)
    |> filter(fn: (r) => r._field == "example-field")