docs-v2/content/flux/v0.x/stdlib/universe/spread.md

77 lines
1.9 KiB
Markdown
Raw Permalink Blame History

This file contains ambiguous Unicode characters!

This file contains ambiguous Unicode characters that may be confused with others in your current locale. If your use case is intentional and legitimate, you can safely ignore this warning. Use the Escape button to highlight these characters.

---
title: spread() function
description: The `spread()` function outputs the difference between the minimum and maximum values in a specified column.
aliases:
- /influxdb/v2.0/reference/flux/functions/transformations/aggregates/spread
- /influxdb/v2.0/reference/flux/functions/built-in/transformations/aggregates/spread/
- /influxdb/v2.0/reference/flux/stdlib/built-in/transformations/aggregates/spread/
- /influxdb/cloud/reference/flux/stdlib/built-in/transformations/aggregates/spread/
menu:
flux_0_x_ref:
name: spread
parent: universe
weight: 102
flux/v0.x/tags: [aggregates, transformations]
related:
- /{{< latest "influxdb" "v1" >}}/query_language/functions/#spread, InfluxQL SPREAD()
- /flux/v0.x/stdlib/experimental/spread
introduced: 0.7.0
---
The `spread()` function outputs the difference between the minimum and maximum values in a specified column.
_`spread()` is an [aggregate function](/flux/v0.x/function-types/#aggregates)._
Only `uint`, `int`, and `float` column types can be used.
The type of the output column depends on the type of input column:
- For columns with type `uint` or `int`, the output is an `int`
- For columns with type `float`, the output is a float.
```js
spread(column: "_value")
```
## Parameters
### column {data-type="string"}
The column on which to operate.
Default is `"_value"`.
### tables {data-type="stream of tables"}
Input data.
Default is piped-forward data ([`<-`](/flux/v0.x/spec/expressions/#pipe-expressions)).
## Examples
{{% flux/sample-example-intro %}}
```js
import "sampledata"
sampledata.int()
|> spread()
```
{{< expand-wrapper >}}
{{% expand "View input and output" %}}
{{< flex >}}
{{% flex-content %}}
##### Input data
{{% flux/sample "int" %}}
{{% /flex-content %}}
{{% flex-content %}}
##### Output data
| tag | _value |
| :-- | -----: |
| t1 | 19 |
| tag | _value |
| :-- | -----: |
| t2 | 22 |
{{% /flex-content %}}
{{< /flex >}}
{{% /expand %}}
{{< /expand-wrapper >}}