Back to Influxdb

sampledata.bool() function

content/flux/v0/stdlib/sampledata/bool.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#L258-L262 Contributing to Flux: https://github.com/influxdata/flux#contributing Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md ------------------------------------------------------------------------------->

sampledata.bool() returns a sample data set with boolean values.

Function type signature
js
(?includeNull: bool) => stream[A] where A: Record

{{% 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 boolean values

js
import "sampledata"

sampledata.bool()

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

Output data

_time*tag_value
2021-01-01T00:00:00Zt1true
2021-01-01T00:00:10Zt1true
2021-01-01T00:00:20Zt1false
2021-01-01T00:00:30Zt1true
2021-01-01T00:00:40Zt1false
2021-01-01T00:00:50Zt1false
_time*tag_value
2021-01-01T00:00:00Zt2false
2021-01-01T00:00:10Zt2true
2021-01-01T00:00:20Zt2false
2021-01-01T00:00:30Zt2true
2021-01-01T00:00:40Zt2true
2021-01-01T00:00:50Zt2false

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