Back to Influxdb

sampledata.numericBool() function

content/flux/v0/stdlib/sampledata/numericbool.md

latest2.0 KB
Original Source
<!------------------------------------------------------------------------------ IMPORTANT: This page was generated from comments in the Flux source code. Any edits made directly to this page will be overwritten the next time the documentation is generated. To make updates to this documentation, update the function comments above the function definition in the Flux source code: https://github.com/influxdata/flux/blob/master/stdlib/sampledata/sampledata.flux#L280-L284 Contributing to Flux: https://github.com/influxdata/flux#contributing Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md ------------------------------------------------------------------------------->

sampledata.numericBool() returns a sample data set with numeric (integer) boolean values.

Function type signature
js
(?includeNull: bool) => stream[{A with _value: B, _value: int}]

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

Parameters

includeNull

Include null values in the returned dataset. Default is false.

Examples

Output basic sample data with numeric boolean values

js
import "sampledata"

sampledata.numericBool()

{{< expand-wrapper >}} {{% expand "View example output" %}}

Output data

_time_value*tag
2021-01-01T00:00:00Z1t1
2021-01-01T00:00:10Z1t1
2021-01-01T00:00:20Z0t1
2021-01-01T00:00:30Z1t1
2021-01-01T00:00:40Z0t1
2021-01-01T00:00:50Z0t1
_time_value*tag
2021-01-01T00:00:00Z0t2
2021-01-01T00:00:10Z1t2
2021-01-01T00:00:20Z0t2
2021-01-01T00:00:30Z1t2
2021-01-01T00:00:40Z1t2
2021-01-01T00:00:50Z0t2

{{% /expand %}} {{< /expand-wrapper >}}