Documentation

keep() function

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

Columns in the group key that are not specifed 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 ouput

Keep columns matching a predicate

import "sampledata"

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

View example input and ouput


Was this page helpful?

Thank you for your feedback!


Upgrade to InfluxDB Cloud or InfluxDB 2.0!

InfluxDB Cloud and InfluxDB OSS 2.0 ready for production.