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
  • Copy
  • Fill window

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"})
  • Copy
  • Fill window

View example input and output

Rename columns using a function

import "sampledata"

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

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
        },
    )
  • Copy
  • Fill window

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.

Read more

New in InfluxDB 3.2

Key enhancements in InfluxDB 3.2 and the InfluxDB 3 Explorer UI is now generally available.

See the Blog Post

InfluxDB 3.2 is now available for both Core and Enterprise, bringing the general availability of InfluxDB 3 Explorer, a new UI that simplifies how you query, explore, and visualize data. On top of that, InfluxDB 3.2 includes a wide range of performance improvements, feature updates, and bug fixes including automated data retention and more.

For more information, check out: