Documentation

keys() function

keys() returns the columns that are in the group key of each input table.

Each output table contains a row for each group key column label. A single group key column label is stored in the specified column for each row. All columns not in the group key are dropped.

Function type signature
(<-tables: stream[A], ?column: string) => stream[B] where A: Record, B: Record
For more information, see Function type signatures.

Parameters

column

Column to store group key labels in. Default is _value.

tables

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

Examples

Return group key columns for each input table

data
    |> keys()

View example input and output

Return all distinct group key columns in a single table

data
    |> keys()
    |> keep(columns: ["_value"])
    |> distinct()

View example input and output

Return group key columns as an array

  1. Use keys() to replace the _value column with the group key labels.
  2. Use findColumn() to return the _value column as an array.
import "sampledata"

sampledata.int()
    |> keys()
    |> findColumn(fn: (key) => true, column: "_value")// Returns [tag]

Was this page helpful?

Thank you for your feedback!


Introducing InfluxDB Clustered

A highly available InfluxDB 3.0 cluster on your own infrastructure.

InfluxDB Clustered is a highly available InfluxDB 3.0 cluster built for high write and query workloads on your own infrastructure.

InfluxDB Clustered is currently in limited availability and is only available to a limited group of InfluxData customers. If interested in being part of the limited access group, please contact the InfluxData Sales team.

Learn more
Contact InfluxData Sales

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: