Documentation

from() function

from() queries data from an InfluxDB data source.

It returns a stream of tables from the specified bucket. Each unique series is contained within its own table. Each record in the table represents a single point in the series.

Query remote InfluxDB data sources

Use from() to query data from remote InfluxDB OSS 1.7+, InfluxDB Enterprise 1.9+, and InfluxDB Cloud. To query remote InfluxDB sources, include the host, token, and org (or orgID) parameters.

from() does not require a package import

from() is part of the influxdata/influxdb package, but is part of the Flux prelude and does not require an import statement or package namespace.

Function type signature
(
    ?bucket: string,
    ?bucketID: string,
    ?host: string,
    ?org: string,
    ?orgID: string,
    ?token: string,
) => stream[{A with _value: B, _time: time, _measurement: string, _field: string}]

For more information, see Function type signatures.

Parameters

bucket

Name of the bucket to query. bucket and bucketID are mutually exclusive.

InfluxDB 1.x or Enterprise: Provide an empty string ("").

bucketID

String-encoded bucket ID to query. bucket and bucketID are mutually exclusive.

InfluxDB 1.x or Enterprise: Provide an empty string ("").

host

URL of the InfluxDB instance to query.

See InfluxDB Cloud regions or InfluxDB OSS URLs.

org

Organization name. org and orgID are mutually exclusive.

InfluxDB 1.x or Enterprise: Provide an empty string ("").

orgID

String-encoded organization ID to query. org and orgID are mutually exclusive.

InfluxDB 1.x or Enterprise: Provide an empty string ("").

token

InfluxDB API token.

InfluxDB 1.x or Enterprise: If authentication is disabled, provide an empty string (""). If authentication is enabled, provide your InfluxDB username and password using the <username>:<password> syntax.

Examples

Query InfluxDB using the bucket name

from(bucket: "example-bucket")

Query InfluxDB using the bucket ID

from(bucketID: "0261d8287f4d6000")

Query a remote InfluxDB Cloud instance

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!


The future of Flux

Flux is going into maintenance mode. You can continue using it as you currently are without any changes to your code.

Flux is going into maintenance mode and will not be supported in InfluxDB 3.0. This was a decision based on the broad demand for SQL and the continued growth and adoption of InfluxQL. We are continuing to support Flux for users in 1.x and 2.x so you can continue using it with no changes to your code. If you are interested in transitioning to InfluxDB 3.0 and want to future-proof your code, we suggest using InfluxQL.

For information about the future of Flux, see the following: