89 lines
2.3 KiB
Markdown
89 lines
2.3 KiB
Markdown
---
|
|
title: sampledata.string() function
|
|
description: >
|
|
`sampledata.string()` returns a sample data set with string values.
|
|
menu:
|
|
flux_v0_ref:
|
|
name: sampledata.string
|
|
parent: sampledata
|
|
identifier: sampledata/string
|
|
weight: 101
|
|
---
|
|
|
|
<!------------------------------------------------------------------------------
|
|
|
|
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#L236-L240
|
|
|
|
Contributing to Flux: https://github.com/influxdata/flux#contributing
|
|
Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md
|
|
|
|
------------------------------------------------------------------------------->
|
|
|
|
`sampledata.string()` returns a sample data set with string values.
|
|
|
|
|
|
|
|
##### Function type signature
|
|
|
|
```js
|
|
(?includeNull: bool) => stream[A] where A: Record
|
|
```
|
|
|
|
{{% caption %}}
|
|
For more information, see [Function type signatures](/flux/v0/function-type-signatures/).
|
|
{{% /caption %}}
|
|
|
|
## Parameters
|
|
|
|
### includeNull
|
|
|
|
Include null values in the returned dataset.
|
|
Default is `false`.
|
|
|
|
|
|
|
|
|
|
## Examples
|
|
|
|
### Output basic sample data with string values
|
|
|
|
```js
|
|
import "sampledata"
|
|
|
|
sampledata.string()
|
|
|
|
```
|
|
|
|
{{< expand-wrapper >}}
|
|
{{% expand "View example output" %}}
|
|
|
|
#### Output data
|
|
|
|
| _time | *tag | _value |
|
|
| -------------------- | ---- | ----------- |
|
|
| 2021-01-01T00:00:00Z | t1 | smpl_g9qczs |
|
|
| 2021-01-01T00:00:10Z | t1 | smpl_0mgv9n |
|
|
| 2021-01-01T00:00:20Z | t1 | smpl_phw664 |
|
|
| 2021-01-01T00:00:30Z | t1 | smpl_guvzy4 |
|
|
| 2021-01-01T00:00:40Z | t1 | smpl_5v3cce |
|
|
| 2021-01-01T00:00:50Z | t1 | smpl_s9fmgy |
|
|
|
|
| _time | *tag | _value |
|
|
| -------------------- | ---- | ----------- |
|
|
| 2021-01-01T00:00:00Z | t2 | smpl_b5eida |
|
|
| 2021-01-01T00:00:10Z | t2 | smpl_eu4oxp |
|
|
| 2021-01-01T00:00:20Z | t2 | smpl_5g7tz4 |
|
|
| 2021-01-01T00:00:30Z | t2 | smpl_sox1ut |
|
|
| 2021-01-01T00:00:40Z | t2 | smpl_wfm757 |
|
|
| 2021-01-01T00:00:50Z | t2 | smpl_dtn2bv |
|
|
|
|
{{% /expand %}}
|
|
{{< /expand-wrapper >}}
|