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

1.8 KiB

title description menu weight flux/v0/tags introduced
yield() function `yield()` delivers input data as a result of the query.
flux_v0_ref
name parent identifier
yield universe universe/yield
101
outputs
0.7.0

yield() delivers input data as a result of the query.

A query may have multiple yields, each identified by unique name specified in the name parameter.

Note: yield() is implicit for queries that output a single stream of tables and is only necessary when yielding multiple results from a query.

Function type signature
(<-tables: stream[A], ?name: string) => stream[A] where A: Record

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

Parameters

name

Unique name for the yielded results. Default is _results.

tables

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

Examples

Yield multiple results from a query

import "sampledata"

sampledata.int()
    |> yield(name: "unmodified")
    |> map(fn: (r) => ({r with _value: r._value * r._value}))
    |> yield(name: "squared")