docs-v2/content/flux/v0/stdlib/generate/from.md

1.9 KiB

title description menu weight flux/v0/tags
generate.from() function `generate.from()` generates data using the provided parameter values.
flux_v0_ref
name parent identifier
generate.from generate generate/from
101
inputs

generate.from() generates data using the provided parameter values.

Function type signature
(count: int, fn: (n: int) => int, start: A, stop: A) => stream[{_value: int, _time: time, _stop: time, _start: time}] where A: Timeable

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

Parameters

count

({{< req >}}) Number of rows to generate.

fn

({{< req >}}) Function used to generate values.

The function takes an n parameter that represents the row index, operates on n, and then returns an integer value. Rows use zero-based indexing.

start

({{< req >}}) Beginning of the time range to generate values in.

stop

({{< req >}}) End of the time range to generate values in.

Examples

Generate sample data

import "generate"

generate.from(
    count: 6,
    fn: (n) => (n + 1) * (n + 2),
    start: 2021-01-01T00:00:00Z,
    stop: 2021-01-02T00:00:00Z,
)