Documentation

query.inBucket() function

query.inBucket() is experimental and subject to change at any time.

query.inBucket() queries data from a specified InfluxDB bucket within given time bounds, filters data by measurement, field, and optional predicate expressions.

Function type signature
(
    bucket: string,
    measurement: A,
    start: B,
    ?fields: [string],
    ?predicate: (
        r: {
            C with
            _value: D,
            _time: time,
            _stop: time,
            _start: time,
            _measurement: string,
            _field: string,
        },
    ) => bool,
    ?stop: E,
) => stream[{
    C with
    _value: D,
    _time: time,
    _stop: time,
    _start: time,
    _measurement: string,
    _field: string,
}] where A: Equatable

For more information, see Function type signatures.

Parameters

bucket

(Required) InfluxDB bucket name.

measurement

(Required) InfluxDB measurement name to filter by.

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().

fields

Fields to filter by. Default is [].

predicate

Predicate function that evaluates column values and returns true or false. Default is (r) => true.

Records (r) are passed to the function. Those that evaluate to true are included in the output tables. Records that evaluate to null or false are not included in the output tables.

Examples

Query specific fields in a measurement from InfluxDB

import "experimental/query"

query.inBucket(
    bucket: "example-buckt",
    start: -1h,
    measurement: "mem",
    fields: ["field1", "field2"],
    predicate: (r) => r.host == "host1",
)

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.

Read more

InfluxDB v3 enhancements and InfluxDB Clustered is now generally available

New capabilities, including faster query performance and management tooling advance the InfluxDB v3 product line. InfluxDB Clustered is now generally available.

InfluxDB v3 performance and features

The InfluxDB v3 product line has seen significant enhancements in query performance and has made new management tooling available. These enhancements include an operational dashboard to monitor the health of your InfluxDB cluster, single sign-on (SSO) support in InfluxDB Cloud Dedicated, and new management APIs for tokens and databases.

Learn about the new v3 enhancements


InfluxDB Clustered general availability

InfluxDB Clustered is now generally available and gives you the power of InfluxDB v3 in your self-managed stack.

Talk to us about InfluxDB Clustered