Documentation

rename() function

The rename() function renames specified columns in a table. If a column is renamed and is part of the group key, the column name in the group key will be updated.

There are two variants:

  • one which maps old column names to new column names
  • one which takes a mapping function.

Function type: Transformation

rename(columns: {host: "server", facility: "datacenter"})

// OR

rename(fn: (column) => "{column}_new")

Parameters

Make sure fn parameter names match each specified parameter. To learn why, see Match parameter names.

columns

A map of columns to rename and their corresponding new names. Cannot be used with fn.

Data type: Record

fn

A function mapping between old and new column names. Cannot be used with columns.

Data type: Function

Examples

Rename a single column
from(bucket: "example-bucket")
    |> range(start: -5m)
    |> rename(columns: {host: "server"})
Rename all columns using a function
from(bucket: "example-bucket")
    |> range(start: -5m)
    |> rename(fn: (column) => column + "_new")

New! Cloud or OSS?

InfluxDB OSS 2.0 now generally available!

InfluxDB OSS 2.0 is now generally available and ready for production use. See the InfluxDB OSS 2.0 release notes.

For information about upgrading to InfluxDB OSS 2.0, see: