from() function
from()
is a user-contributed function maintained by
the package author.
from()
retrieves data from an InfluxDB bucket between the start
and stop
times.
This version of from
is equivalent to from() |> range()
in a single call.
Function type signature
(
bucket: string,
start: A,
?host: string,
?org: string,
?stop: B,
?token: string,
) => stream[{
C with
_value: D,
_time: time,
_stop: time,
_start: time,
_measurement: string,
_field: string,
}]
Parameters
bucket
(Required) Name of the bucket to query.
InfluxDB 1.x or Enterprise: Provide an empty string (""
).
start
(Required) Earliest time to include in results.
Results include points 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 points 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()
.
host
URL of the InfluxDB instance to query.
See InfluxDB OSS URLs or InfluxDB Cloud regions.
org
Organization name.
token
InfluxDB API token.
Examples
Query using the bucket name
import "contrib/jsternberg/influxdb"
influxdb.from(bucket: "example-bucket")
Query using the bucket ID
import "contrib/jsternberg/influxdb"
influxdb.from(bucketID: "0261d8287f4d6000")
Query a remote InfluxDB Cloud instance
import "contrib/jsternberg/influxdb"
import "influxdata/influxdb/secrets"
token = secrets.get(key: "INFLUXDB_CLOUD_TOKEN")
from(
bucket: "example-bucket",
host: "https://us-west-2-1.aws.cloud2.influxdata.com",
org: "example-org",
token: token,
)
Was this page helpful?
Thank you for your feedback!
Support and feedback
Thank you for being part of our community! We welcome and encourage your feedback and bug reports for Flux and this documentation. To find support, use the following resources:
Customers with an annual or support contract can contact InfluxData Support.