Documentation

rename() function

rename() renames columns in a table.

If a column in the group key is renamed, the column name in the group key is updated.

Function type signature
(<-tables: stream[B], ?columns: A, ?fn: (column: string) => string) => stream[C] where A: Record, B: Record, C: Record

For more information, see Function type signatures.

Parameters

columns

Record that maps old column names to new column names.

fn

Function that takes the current column name (column) and returns a new column name.

tables

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

Examples

Explicitly map column names to new column names

import "sampledata"

sampledata.int()
    |> rename(columns: {tag: "uid", _value: "val"})

View example input and output

Rename columns using a function

import "sampledata"

sampledata.int()
    |> rename(fn: (column) => "${column}_new")

View example input and output

Conditionally rename columns using a function

import "sampledata"

sampledata.int()
    |> rename(
        fn: (column) => {
            _newColumnName = if column =~ /^_/ then "${column} (Reserved)" else column

            return _newColumnName
        },
    )

View example input and output


Was this page helpful?

Thank you for your feedback!


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: