keep() function

Warning! This page documents an earlier version of Flux, which is no longer actively developed. Flux v0.50 is the most recent stable version of Flux.

The keep() function returns a table containing only the specified columns, ignoring all others. Only columns in the group key that are also specified in the keep() function will be kept in the resulting group key. It is the inverse of drop.

Function type: Transformation
Output data type: Object

keep(columns: ["col1", "col2"])

// OR

keep(fn: (column) => column =~ /inodes*/)

Parameters

columns

Columns that should be included in the resulting table. Cannot be used with fn.

Data type: Array of strings

fn

A function which takes a column name as a parameter (column) and returns a boolean indicating whether or not the column should be included in the resulting table. Cannot be used with columns.

Data type: Function

Examples

Keep a list of columns
from(bucket: "telegraf/autogen")
    |> range(start: -5m)
    |> keep(columns: ["_time", "_value"])
Keep all columns matching a predicate
from(bucket: "telegraf/autogen")
    |> range(start: -5m)
    |> keep(fn: (column) => column =~ /inodes*/)