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

InfluxDB 3 Core and Enterprise are now in Beta

InfluxDB 3 Core and Enterprise are now available for beta testing, available under MIT or Apache 2 license.

InfluxDB 3 Core is a high-speed, recent-data engine that collects and processes data in real-time, while persisting it to local disk or object storage. InfluxDB 3 Enterprise is a commercial product that builds on Core’s foundation, adding high availability, read replicas, enhanced security, and data compaction for faster queries. A free tier of InfluxDB 3 Enterprise will also be available for at-home, non-commercial use for hobbyists to get the full historical time series database set of capabilities.

For more information, check out: