ContextQMD
Back to Influxdb

set() function

content/flux/v0/stdlib/universe/set.md

latest3.1 KB
Original Source
<!------------------------------------------------------------------------------ IMPORTANT: This page was generated from comments in the Flux source code. Any edits made directly to this page will be overwritten the next time the documentation is generated. To make updates to this documentation, update the function comments above the function definition in the Flux source code: https://github.com/influxdata/flux/blob/master/stdlib/universe/universe.flux#L2350-L2350 Contributing to Flux: https://github.com/influxdata/flux#contributing Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md ------------------------------------------------------------------------------->

set() assigns a static column value to each row in the input tables.

set() may modify an existing column or add a new column. If the modified column is part of the group key, output tables are regrouped as needed. set() can only set string values.

Function type signature
js
(<-tables: stream[A], key: string, value: string) => stream[A] where A: Record

{{% caption %}} For more information, see Function type signatures. {{% /caption %}}

Parameters

key

({{< req >}}) Label of the column to modify or set.

value

({{< req >}}) String value to set.

tables

Input data. Default is piped-forward data (<-).

Examples

Set a column to a specific string value

js
import "sampledata"

sampledata.int()
    |> set(key: "host", value: "prod1")

{{< expand-wrapper >}} {{% expand "View example input and output" %}}

Input data

_time_value*tag
2021-01-01T00:00:00Z-2t1
2021-01-01T00:00:10Z10t1
2021-01-01T00:00:20Z7t1
2021-01-01T00:00:30Z17t1
2021-01-01T00:00:40Z15t1
2021-01-01T00:00:50Z4t1
_time_value*tag
2021-01-01T00:00:00Z19t2
2021-01-01T00:00:10Z4t2
2021-01-01T00:00:20Z-3t2
2021-01-01T00:00:30Z19t2
2021-01-01T00:00:40Z13t2
2021-01-01T00:00:50Z1t2

Output data

_time_value*taghost
2021-01-01T00:00:00Z-2t1prod1
2021-01-01T00:00:10Z10t1prod1
2021-01-01T00:00:20Z7t1prod1
2021-01-01T00:00:30Z17t1prod1
2021-01-01T00:00:40Z15t1prod1
2021-01-01T00:00:50Z4t1prod1
_time_value*taghost
2021-01-01T00:00:00Z19t2prod1
2021-01-01T00:00:10Z4t2prod1
2021-01-01T00:00:20Z-3t2prod1
2021-01-01T00:00:30Z19t2prod1
2021-01-01T00:00:40Z13t2prod1
2021-01-01T00:00:50Z1t2prod1

{{% /expand %}} {{< /expand-wrapper >}}