docs-v2/content/flux/v0.x/stdlib/universe/yield.md

1.5 KiB
Raw Permalink Blame History

title description aliases menu weight flux/v0.x/tags related introduced
yield() function The `yield()` function indicates the input tables received should be delivered as a result of the query.
/influxdb/v2.0/reference/flux/functions/outputs/yield
/influxdb/v2.0/reference/flux/functions/built-in/outputs/yield/
/influxdb/v2.0/reference/flux/stdlib/built-in/outputs/yield/
/influxdb/cloud/reference/flux/stdlib/built-in/outputs/yield/
flux_0_x_ref
name parent
yield universe
102
outputs
/{{< latest "influxdb" "v1" >}}/query_language/explore-data/#the-basic-select-statement, InfluxQL  SELECT AS
0.7.0

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.

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. Default is "_results".

tables

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

Examples

from(bucket: "example-bucket")
    |> range(start: -5m)
    |> yield(name: "result-name")