Influxdata
/
docs-v2
mirror of https://github.com/influxdata/docs-v2.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

add note for matching params to rename() function

pull/358/head
Kelly 2019-07-25 18:04:12 -07:00
parent 5a94e0a668
commit 4a42a4cbc4
1 changed files with 8 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
content/v2.0/reference/flux/functions/built-in/transformations/rename.md
View File

@ -30,13 +30,19 @@ rename(fn: (column) => "{column}_new")
## Parameters ## 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 ### columns
A map of columns to rename and their corresponding new names. A map of columns to rename and their corresponding new names.
Cannot be used with `fn`. Cannot be used with `fn`.
_**Data type:** Object_ _**Data type:** Object_
### fn ### fn
A function mapping between old and new column names. A function mapping between old and new column names.
Cannot be used with `columns`. Cannot be used with `columns`.
@ -45,6 +51,7 @@ _**Data type:** Function_
## Examples ## Examples
##### Rename a single column ##### Rename a single column
```js ```js
from(bucket: "example-bucket") from(bucket: "example-bucket")
|> range(start: -5m) |> range(start: -5m)
@ -52,6 +59,7 @@ from(bucket: "example-bucket")
``` ```
##### Rename all columns using a function ##### Rename all columns using a function
```js ```js
from(bucket: "example-bucket") from(bucket: "example-bucket")
|> range(start: -5m) |> range(start: -5m)