From 4a42a4cbc420fc8ae549249593f2a40e389c977a Mon Sep 17 00:00:00 2001 From: Kelly Date: Thu, 25 Jul 2019 18:04:12 -0700 Subject: [PATCH] add note for matching params to rename() function --- .../flux/functions/built-in/transformations/rename.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/content/v2.0/reference/flux/functions/built-in/transformations/rename.md b/content/v2.0/reference/flux/functions/built-in/transformations/rename.md index d932cda35..55c22ee0b 100644 --- a/content/v2.0/reference/flux/functions/built-in/transformations/rename.md +++ b/content/v2.0/reference/flux/functions/built-in/transformations/rename.md @@ -30,13 +30,19 @@ rename(fn: (column) => "{column}_new") ## Parameters +{{% note %}} +Make sure `fn` parameter names match each specified parameter. To learn why, see [Match parameter names](/v2.0/reference/flux/language/data-model/#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`. @@ -45,6 +51,7 @@ _**Data type:** Function_ ## Examples ##### Rename a single column + ```js from(bucket: "example-bucket") |> range(start: -5m) @@ -52,6 +59,7 @@ from(bucket: "example-bucket") ``` ##### Rename all columns using a function + ```js from(bucket: "example-bucket") |> range(start: -5m)