yield() function

Warning! This page documents an earlier version of Flux, which is no longer actively developed. Flux v0.36 is the most recent stable version of Flux.

The yield() function indicates the input tables received should be delivered as a result of the query. Yield outputs the input stream unmodified. A query may have multiple results, each identified by the name provided to the yield() function.

Function type: Output
Output data type: Object

yield(name: "custom-name")

yield() is implicit for queries that do only one thing and are only needed when using multiple sources in a query. With multiple sources, yield() is required to specify what is returned, and what name to give it.



A unique name for the yielded results. Defaults to "_results".

Data type: String


from(bucket: "telegraf/autogen")
  |> range(start: -5m)
  |> yield(name: "1")