docs-v2/content/v2.0/reference/flux/functions/built-in/transformations/rename.md

1.4 KiB

title description aliases menu weight
rename() function The `rename()` function renames specified columns in a table.
/v2.0/reference/flux/functions/transformations/rename
v2_0_ref
name parent
rename built-in-transformations
401

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

{{% note %}} Make sure fn parameter names match each specified parameter. To learn why, see Match parameter names. {{% /note %}}

columns

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

Data type: Object

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")