Documentation

keep() function

keep() returns a stream of tables containing only the specified columns.

Columns in the group key that are not specified in the columns parameter or identified by the fn parameter are removed from the group key and dropped from output tables. keep() is the inverse of drop().

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

Parameters

columns

Columns to keep in output tables. Cannot be used with fn.

fn

Predicate function that takes a column name as a parameter (column) and returns a boolean indicating whether or not the column should be kept in output tables. Cannot be used with columns.

tables

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

Examples

Keep a list of columns

import "sampledata"

sampledata.int()
    |> keep(columns: ["_time", "_value"])

View example input and output

Keep columns matching a predicate

import "sampledata"

sampledata.int()
    |> keep(fn: (column) => column =~ /^_?t/)

View example input and output


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: