docs-v2/content/v2.0/reference/flux/functions/outputs/yield.md

1.2 KiB

title description menu weight
yield() function The yield() function indicates the input tables received should be delivered as a result of the query.
v2_0_ref
name parent
yield Outputs
1

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

{{% note %}} 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. {{% /note %}}

Parameters

name

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

Data type: String

Examples

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

SELECT AS