keep() function
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: Record
keep(columns: ["col1", "col2"])
// OR
keep(fn: (column) => column =~ /inodes*/)
Parameters
Make sure fn
parameter names match each specified parameter. To learn why, see Match parameter names.
columns
Columns that should be included in the resulting table.
Cannot be used with fn
.
Data type: Array of strings
fn
A predicate 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: "example-bucket")
|> range(start: -5m)
|> keep(columns: ["_time", "_value"])
Keep all columns matching a predicate
from(bucket: "example-bucket")
|> range(start: -5m)
|> keep(fn: (column) => column =~ /inodes*/)
Support and feedback
Thank you for being part of our community! We welcome and encourage your feedback and bug reports for InfluxDB and this documentation. To find support, the following resources are available:
InfluxDB Cloud and InfluxDB Enterprise customers can contact InfluxData Support.