Influxdata
/
docs-v2
mirror of https://github.com/influxdata/docs-v2.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Flux 0.143 (#3438) 

* added missing flux release notes

* added 0.143.1 release notes

* Update difference and increase functions (#3432)

* Update difference and increase functions

* added link to release notes

* updated information about changes to increase

* Apply suggestions from code review

Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com>

Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com>

Co-authored-by: kelseiv <47797004+kelseiv@users.noreply.github.com>
pull/3419/head^2
Scott Anderson 2021-11-23 21:34:06 -07:00 committed by GitHub
parent d71ca570cb
commit e14d0255d4
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 195 additions and 65 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

93
content/flux/v0.x/prometheus/metric-types/counter.md
View File

@ -105,12 +105,13 @@ from(bucket: "example-bucket")
#### Example output {id="example-output-2"} #### Example output {id="example-output-2"}
| _time | _measurement | _field | _value | | _time | _measurement | _field | _value |
| :------------------- | :----------- | :----------------------- | -----: | | :------------------- | :----------- | :----------------------- | -----: |
| 2021-01-01T00:00:00Z | prometheus | http_query_request_bytes | 0 |
| 2021-01-01T00:00:10Z | prometheus | http_query_request_bytes | 542 | | 2021-01-01T00:00:10Z | prometheus | http_query_request_bytes | 542 |
| 2021-01-01T00:00:20Z | prometheus | http_query_request_bytes | 789 | | 2021-01-01T00:00:20Z | prometheus | http_query_request_bytes | 789 |
| 2021-01-01T00:00:30Z | prometheus | http_query_request_bytes | 789 | | 2021-01-01T00:00:30Z | prometheus | http_query_request_bytes | 802 |
| 2021-01-01T00:00:40Z | prometheus | http_query_request_bytes | 991 | | 2021-01-01T00:00:40Z | prometheus | http_query_request_bytes | 1004 |
| 2021-01-01T00:00:50Z | prometheus | http_query_request_bytes | 1538 | | 2021-01-01T00:00:50Z | prometheus | http_query_request_bytes | 1551 |
| 2021-01-01T00:01:00Z | prometheus | http_query_request_bytes | 1884 | | 2021-01-01T00:01:00Z | prometheus | http_query_request_bytes | 1897 |
{{% /expand %}} {{% /expand %}}
{{< /expand-wrapper >}} {{< /expand-wrapper >}}
{{% /tab-content %}} {{% /tab-content %}}
@ -163,12 +164,14 @@ from(bucket: "example-bucket")
#### Example output {id="example-output-1"} #### Example output {id="example-output-1"}
| _time | _measurement | _field | _value | | _time | _measurement | _field | _value |
| :------------------- | :----------------------- | :------ | -----: | | :------------------- | :----------------------- | :------ | -----: |
| 2021-01-01T00:00:00Z | http_query_request_bytes | counter | 0 |
| 2021-01-01T00:00:10Z | http_query_request_bytes | counter | 542 | | 2021-01-01T00:00:10Z | http_query_request_bytes | counter | 542 |
| 2021-01-01T00:00:20Z | http_query_request_bytes | counter | 789 | | 2021-01-01T00:00:20Z | http_query_request_bytes | counter | 789 |
| 2021-01-01T00:00:30Z | http_query_request_bytes | counter | 789 | | 2021-01-01T00:00:30Z | http_query_request_bytes | counter | 802 |
| 2021-01-01T00:00:40Z | http_query_request_bytes | counter | 991 | | 2021-01-01T00:00:40Z | http_query_request_bytes | counter | 1004 |
| 2021-01-01T00:00:50Z | http_query_request_bytes | counter | 1538 | | 2021-01-01T00:00:50Z | http_query_request_bytes | counter | 1551 |
| 2021-01-01T00:01:00Z | http_query_request_bytes | counter | 1884 | | 2021-01-01T00:01:00Z | http_query_request_bytes | counter | 1897 |
{{% /expand %}} {{% /expand %}}
{{< /expand-wrapper >}} {{< /expand-wrapper >}}
{{% /tab-content %}} {{% /tab-content %}}
@ -212,18 +215,20 @@ from(bucket: "example-bucket")
#### Example normalized counter data {id="example-normalized-counter-data-2"} #### Example normalized counter data {id="example-normalized-counter-data-2"}
| _time | _measurement | _field | _value | | _time | _measurement | _field | _value |
| :------------------- | :----------- | :----------------------- | -----: | | :------------------- | :----------- | :----------------------- | -----: |
| 2021-01-01T00:00:00Z | prometheus | http_query_request_bytes | 0 |
| 2021-01-01T00:00:10Z | prometheus | http_query_request_bytes | 542 | | 2021-01-01T00:00:10Z | prometheus | http_query_request_bytes | 542 |
| 2021-01-01T00:00:20Z | prometheus | http_query_request_bytes | 789 | | 2021-01-01T00:00:20Z | prometheus | http_query_request_bytes | 789 |
| 2021-01-01T00:00:30Z | prometheus | http_query_request_bytes | 789 | | 2021-01-01T00:00:30Z | prometheus | http_query_request_bytes | 802 |
| 2021-01-01T00:00:40Z | prometheus | http_query_request_bytes | 991 | | 2021-01-01T00:00:40Z | prometheus | http_query_request_bytes | 1004 |
| 2021-01-01T00:00:50Z | prometheus | http_query_request_bytes | 1538 | | 2021-01-01T00:00:50Z | prometheus | http_query_request_bytes | 1551 |
| 2021-01-01T00:01:00Z | prometheus | http_query_request_bytes | 1884 | | 2021-01-01T00:01:00Z | prometheus | http_query_request_bytes | 1897 |
#### Example difference output {id="example-difference-output-2"} #### Example difference output {id="example-difference-output-2"}
| _time | _measurement | _field | _value | | _time | _measurement | _field | _value |
| :------------------- | :----------- | :----------------------- | -----: | | :------------------- | :----------- | :----------------------- | -----: |
| 2021-01-01T00:00:10Z | prometheus | http_query_request_bytes | 542 |
| 2021-01-01T00:00:20Z | prometheus | http_query_request_bytes | 247 | | 2021-01-01T00:00:20Z | prometheus | http_query_request_bytes | 247 |
| 2021-01-01T00:00:30Z | prometheus | http_query_request_bytes | 0 | | 2021-01-01T00:00:30Z | prometheus | http_query_request_bytes | 13 |
| 2021-01-01T00:00:40Z | prometheus | http_query_request_bytes | 202 | | 2021-01-01T00:00:40Z | prometheus | http_query_request_bytes | 202 |
| 2021-01-01T00:00:50Z | prometheus | http_query_request_bytes | 547 | | 2021-01-01T00:00:50Z | prometheus | http_query_request_bytes | 547 |
| 2021-01-01T00:01:00Z | prometheus | http_query_request_bytes | 346 | | 2021-01-01T00:01:00Z | prometheus | http_query_request_bytes | 346 |
@ -259,18 +264,20 @@ from(bucket: "example-bucket")
#### Example normalized counter data {id="example-normalized-counter-data-1"} #### Example normalized counter data {id="example-normalized-counter-data-1"}
| _time | _measurement | _field | _value | | _time | _measurement | _field | _value |
| :------------------- | :----------------------- | :------ | -----: | | :------------------- | :----------------------- | :------ | -----: |
| 2021-01-01T00:00:00Z | http_query_request_bytes | counter | 0 |
| 2021-01-01T00:00:10Z | http_query_request_bytes | counter | 542 | | 2021-01-01T00:00:10Z | http_query_request_bytes | counter | 542 |
| 2021-01-01T00:00:20Z | http_query_request_bytes | counter | 789 | | 2021-01-01T00:00:20Z | http_query_request_bytes | counter | 789 |
| 2021-01-01T00:00:30Z | http_query_request_bytes | counter | 789 | | 2021-01-01T00:00:30Z | http_query_request_bytes | counter | 802 |
| 2021-01-01T00:00:40Z | http_query_request_bytes | counter | 991 | | 2021-01-01T00:00:40Z | http_query_request_bytes | counter | 1004 |
| 2021-01-01T00:00:50Z | http_query_request_bytes | counter | 1538 | | 2021-01-01T00:00:50Z | http_query_request_bytes | counter | 1551 |
| 2021-01-01T00:01:00Z | http_query_request_bytes | counter | 1884 | | 2021-01-01T00:01:00Z | http_query_request_bytes | counter | 1897 |
#### Example difference output {id="example-difference-output-1"} #### Example difference output {id="example-difference-output-1"}
| _time | _measurement | _field | _value | | _time | _measurement | _field | _value |
| :------------------- | :----------------------- | :------ | -----: | | :------------------- | :----------------------- | :------ | -----: |
| 2021-01-01T00:00:10Z | http_query_request_bytes | counter | 542 |
| 2021-01-01T00:00:20Z | http_query_request_bytes | counter | 247 | | 2021-01-01T00:00:20Z | http_query_request_bytes | counter | 247 |
| 2021-01-01T00:00:30Z | http_query_request_bytes | counter | 0 | | 2021-01-01T00:00:30Z | http_query_request_bytes | counter | 13 |
| 2021-01-01T00:00:40Z | http_query_request_bytes | counter | 202 | | 2021-01-01T00:00:40Z | http_query_request_bytes | counter | 202 |
| 2021-01-01T00:00:50Z | http_query_request_bytes | counter | 547 | | 2021-01-01T00:00:50Z | http_query_request_bytes | counter | 547 |
| 2021-01-01T00:01:00Z | http_query_request_bytes | counter | 346 | | 2021-01-01T00:01:00Z | http_query_request_bytes | counter | 346 |
@ -320,18 +327,20 @@ from(bucket: "example-bucket")
#### Example normalized counter data {id="example-normalized-counter-data-2-1"} #### Example normalized counter data {id="example-normalized-counter-data-2-1"}
| _time | _measurement | _field | _value | | _time | _measurement | _field | _value |
| :------------------- | :----------- | :----------------------- | -----: | | :------------------- | :----------- | :----------------------- | -----: |
| 2021-01-01T00:00:00Z | prometheus | http_query_request_bytes | 0 |
| 2021-01-01T00:00:10Z | prometheus | http_query_request_bytes | 542 | | 2021-01-01T00:00:10Z | prometheus | http_query_request_bytes | 542 |
| 2021-01-01T00:00:20Z | prometheus | http_query_request_bytes | 789 | | 2021-01-01T00:00:20Z | prometheus | http_query_request_bytes | 789 |
| 2021-01-01T00:00:30Z | prometheus | http_query_request_bytes | 789 | | 2021-01-01T00:00:30Z | prometheus | http_query_request_bytes | 802 |
| 2021-01-01T00:00:40Z | prometheus | http_query_request_bytes | 991 | | 2021-01-01T00:00:40Z | prometheus | http_query_request_bytes | 1004 |
| 2021-01-01T00:00:50Z | prometheus | http_query_request_bytes | 1538 | | 2021-01-01T00:00:50Z | prometheus | http_query_request_bytes | 1551 |
| 2021-01-01T00:01:00Z | prometheus | http_query_request_bytes | 1884 | | 2021-01-01T00:01:00Z | prometheus | http_query_request_bytes | 1897 |
#### Example derivative output {id="example-derivative-output-2"} #### Example derivative output {id="example-derivative-output-2"}
| _time | _measurement | _field | _value | | _time | _measurement | _field | _value |
| :------------------- | :----------- | :----------------------- | -----: | | :------------------- | :----------- | :----------------------- | -----: |
| 2021-01-01T00:00:10Z | prometheus | http_query_request_bytes | 54.2 |
| 2021-01-01T00:00:20Z | prometheus | http_query_request_bytes | 24.7 | | 2021-01-01T00:00:20Z | prometheus | http_query_request_bytes | 24.7 |
| 2021-01-01T00:00:30Z | prometheus | http_query_request_bytes | 0.0 | | 2021-01-01T00:00:30Z | prometheus | http_query_request_bytes | 1.3 |
| 2021-01-01T00:00:40Z | prometheus | http_query_request_bytes | 20.2 | | 2021-01-01T00:00:40Z | prometheus | http_query_request_bytes | 20.2 |
| 2021-01-01T00:00:50Z | prometheus | http_query_request_bytes | 54.7 | | 2021-01-01T00:00:50Z | prometheus | http_query_request_bytes | 54.7 |
| 2021-01-01T00:01:00Z | prometheus | http_query_request_bytes | 34.6 | | 2021-01-01T00:01:00Z | prometheus | http_query_request_bytes | 34.6 |
@ -367,18 +376,20 @@ from(bucket: "example-bucket")
#### Example normalized counter data {id="example-normalized-counter-data-1-1"} #### Example normalized counter data {id="example-normalized-counter-data-1-1"}
| _time | _measurement | _field | _value | | _time | _measurement | _field | _value |
| :------------------- | :----------------------- | :------ | -----: | | :------------------- | :----------------------- | :------ | -----: |
| 2021-01-01T00:00:00Z | http_query_request_bytes | counter | 0 |
| 2021-01-01T00:00:10Z | http_query_request_bytes | counter | 542 | | 2021-01-01T00:00:10Z | http_query_request_bytes | counter | 542 |
| 2021-01-01T00:00:20Z | http_query_request_bytes | counter | 789 | | 2021-01-01T00:00:20Z | http_query_request_bytes | counter | 789 |
| 2021-01-01T00:00:30Z | http_query_request_bytes | counter | 789 | | 2021-01-01T00:00:30Z | http_query_request_bytes | counter | 802 |
| 2021-01-01T00:00:40Z | http_query_request_bytes | counter | 991 | | 2021-01-01T00:00:40Z | http_query_request_bytes | counter | 1004 |
| 2021-01-01T00:00:50Z | http_query_request_bytes | counter | 1538 | | 2021-01-01T00:00:50Z | http_query_request_bytes | counter | 1551 |
| 2021-01-01T00:01:00Z | http_query_request_bytes | counter | 1884 | | 2021-01-01T00:01:00Z | http_query_request_bytes | counter | 1897 |
#### Example derivative output {id="example-derivative-output-1"} #### Example derivative output {id="example-derivative-output-1"}
| _time | _measurement | _field | _value | | _time | _measurement | _field | _value |
| :------------------- | :----------------------- | :------ | -----: | | :------------------- | :----------------------- | :------ | -----: |
| 2021-01-01T00:00:10Z | http_query_request_bytes | counter | 54.2 |
| 2021-01-01T00:00:20Z | http_query_request_bytes | counter | 24.7 | | 2021-01-01T00:00:20Z | http_query_request_bytes | counter | 24.7 |
| 2021-01-01T00:00:30Z | http_query_request_bytes | counter | 0.0 | | 2021-01-01T00:00:30Z | http_query_request_bytes | counter | 1.3 |
| 2021-01-01T00:00:40Z | http_query_request_bytes | counter | 20.2 | | 2021-01-01T00:00:40Z | http_query_request_bytes | counter | 20.2 |
| 2021-01-01T00:00:50Z | http_query_request_bytes | counter | 54.7 | | 2021-01-01T00:00:50Z | http_query_request_bytes | counter | 54.7 |
| 2021-01-01T00:01:00Z | http_query_request_bytes | counter | 34.6 | | 2021-01-01T00:01:00Z | http_query_request_bytes | counter | 34.6 |
@ -444,19 +455,20 @@ from(bucket: "example-bucket")
#### Example normalized counter data {id="example-normalized-counter-data-2-2"} #### Example normalized counter data {id="example-normalized-counter-data-2-2"}
| _time | _measurement | _field | _value | | _time | _measurement | _field | _value |
| :------------------- | :----------- | :----------------------- | -----: | | :------------------- | :----------- | :----------------------- | -----: |
| 2021-01-01T00:00:00Z | prometheus | http_query_request_bytes | 0 |
| 2021-01-01T00:00:10Z | prometheus | http_query_request_bytes | 542 | | 2021-01-01T00:00:10Z | prometheus | http_query_request_bytes | 542 |
| 2021-01-01T00:00:20Z | prometheus | http_query_request_bytes | 789 | | 2021-01-01T00:00:20Z | prometheus | http_query_request_bytes | 789 |
| 2021-01-01T00:00:30Z | prometheus | http_query_request_bytes | 789 | | 2021-01-01T00:00:30Z | prometheus | http_query_request_bytes | 802 |
| 2021-01-01T00:00:40Z | prometheus | http_query_request_bytes | 991 | | 2021-01-01T00:00:40Z | prometheus | http_query_request_bytes | 1004 |
| 2021-01-01T00:00:50Z | prometheus | http_query_request_bytes | 1538 | | 2021-01-01T00:00:50Z | prometheus | http_query_request_bytes | 1551 |
| 2021-01-01T00:01:00Z | prometheus | http_query_request_bytes | 1884 | | 2021-01-01T00:01:00Z | prometheus | http_query_request_bytes | 1897 |
#### Example aggregate.rate output {id="example-aggregaterate-output-2"} #### Example aggregate.rate output {id="example-aggregaterate-output-2"}
| _time | _value | | _time | _value |
| :------------------- | -----: | | :------------------- | -----: |
| 2021-01-01T00:00:15Z | | | 2021-01-01T00:00:15Z | 54.2 |
| 2021-01-01T00:01:30Z | 24.7 | | 2021-01-01T00:01:30Z | 24.7 |
| 2021-01-01T00:01:45Z | 10.1 | | 2021-01-01T00:01:45Z | 10.75 |
| 2021-01-01T00:01:00Z | 54.7 | | 2021-01-01T00:01:00Z | 54.7 |
{{% /expand %}} {{% /expand %}}
@ -495,19 +507,20 @@ from(bucket: "example-bucket")
#### Example normalized counter data {id="example-normalized-counter-data-1-2"} #### Example normalized counter data {id="example-normalized-counter-data-1-2"}
| _time | _measurement | _field | _value | | _time | _measurement | _field | _value |
| :------------------- | :----------------------- | :------ | -----: | | :------------------- | :----------------------- | :------ | -----: |
| 2021-01-01T00:00:00Z | http_query_request_bytes | counter | 0 |
| 2021-01-01T00:00:10Z | http_query_request_bytes | counter | 542 | | 2021-01-01T00:00:10Z | http_query_request_bytes | counter | 542 |
| 2021-01-01T00:00:20Z | http_query_request_bytes | counter | 789 | | 2021-01-01T00:00:20Z | http_query_request_bytes | counter | 789 |
| 2021-01-01T00:00:30Z | http_query_request_bytes | counter | 789 | | 2021-01-01T00:00:30Z | http_query_request_bytes | counter | 802 |
| 2021-01-01T00:00:40Z | http_query_request_bytes | counter | 991 | | 2021-01-01T00:00:40Z | http_query_request_bytes | counter | 1004 |
| 2021-01-01T00:00:50Z | http_query_request_bytes | counter | 1538 | | 2021-01-01T00:00:50Z | http_query_request_bytes | counter | 1551 |
| 2021-01-01T00:01:00Z | http_query_request_bytes | counter | 1884 | | 2021-01-01T00:01:00Z | http_query_request_bytes | counter | 1897 |
#### Example aggregate.rate output {id="example-aggregaterate-output-1"} #### Example aggregate.rate output {id="example-aggregaterate-output-1"}
| _time | _value | | _time | _value |
| :------------------- | -----: | | :------------------- | -----: |
| 2021-01-01T00:00:15Z | | | 2021-01-01T00:00:15Z | 54.2 |
| 2021-01-01T00:01:30Z | 24.7 | | 2021-01-01T00:01:30Z | 24.7 |
| 2021-01-01T00:01:45Z | 10.1 | | 2021-01-01T00:01:45Z | 10.75 |
| 2021-01-01T00:01:00Z | 54.7 | | 2021-01-01T00:01:00Z | 54.7 |
{{% /expand %}} {{% /expand %}}

2
content/flux/v0.x/prometheus/metric-types/gauge.md
View File

@ -70,7 +70,6 @@ from(bucket: "example-bucket")
r._measurement == "prometheus" and r._measurement == "prometheus" and
r._field == "go_goroutines" r._field == "go_goroutines"
) )
|> increase()
|> derivative(nonNegative: true) |> derivative(nonNegative: true)
``` ```
@ -128,7 +127,6 @@ from(bucket: "example-bucket")
r._measurement == "go_goroutines" and r._measurement == "go_goroutines" and
r._field == "gauge" r._field == "gauge"
) )
|> increase()
|> derivative(nonNegative: true) |> derivative(nonNegative: true)
``` ```

109
content/flux/v0.x/release-notes.md
View File

@ -10,6 +10,113 @@ aliases:
- /influxdb/cloud/reference/release-notes/flux/ - /influxdb/cloud/reference/release-notes/flux/
--- ---
## v0.143.1 [2021-11-22]
### Bug fixes
- Add targets to `rust-toolchain`.
---
## v0.143.0 [2021-11-22]
### Breaking changes
- Add new parameters to [`difference()`](/flux/v0.x/stdlib/universe/difference/)
to ensure [`increase()`](/flux/v0.x/stdlib/universe/increase/) returns more accurate results on counter reset.
### Features
- Don't introduce constraints for default arguments.
- Make error messages more consistent.
- Use new versions of `sort()` and `derivative()` by default.
- Add inline documentation to the following packages:
- contrib/anaisdg/anomalydetection
- contrib/anaisdg/statsmodels
- contrib/bonitoo-io/victorops
- contrib/bonitoo-io/zenoss
- contrib/jsternberg/influxdb
- contrib/rhajek/bigpanda
- contrib/sranka/telegram
- experimental
### Bug fixes
- Validate examples in inline documentation as part of CI linting process.
- Correctly handle trailing dollar signs in string expression.
- Improve `fluxdoc` error messages.
- Fix panic when `length()` is given a stream of tables.
- Fix panic when `json.encode()` is given a stream of tables.
---
## v0.142.0 [2021-11-22]
### Features
- Default to erroring dependencies
### Bug fixes
- Fix Queryd panic when using the `experimental/geo` package.
---
## v0.141.0 [2021-11-22]
### Features
- Add `is_type` to query the runtime type.
- Add ability to read options from the `Context`.
- Ignore documentation for values prefixed with an underscore (`_`).
- Add inline documentation to the following packages:
- contrib/RohanSreerama5/naiveBayesClassifier
- contrib/bonitoo-io/alerta
- contrib/bonitoo-io/hex
- contrib/bonitoo-io/servicenow
- contrib/bonitoo-io/tickscript
- contrib/chobbs/discord
- contrib/jsternberg/rows/
- contrib/sranka/opsgenie
- contrib/sranka/sensu/
- contrib/sranka/teams
- contrib/sranka/webexteams
- contrib/tomhollingworth/events
- generate
- http
- influxdata/influxdb
- influxdata/influxdb/monitor
- influxdata/influxdb/sample
- influxdata/influxdb/schema
- influxdata/influxdb/secrets
- influxdata/influxdb/tasks
- influxdata/influxdb/v1
### Bug fixes
- Propagate the element type through array constructors.
- Catch unsupported input types in aggregate transformations.
- Support pipe parameters (`<-`) in `fluxdoc`.
- Fix documentation errors when running `cargo doc`.
- Reduce the amount of extra parse errors.
---
## v0.140.0 [2021-11-22]
### Features
- Support reporting unlimited diagnostics.
- Support type inference running on invalid ASTs.
- Add erroring versions for each dependency.
- Report multiple errors from type inference.
- Add `fluxdoc` formatting documentation.
- Add inline documentation to the following packages:
- array
- csv
- dict
### Bug fixes
- Handle errors when executing inline examples.
- Convert fixed array to slice.
- Compare sorted join keys.
- Make multiline-formatting consistent.
- Fix invalid syntax formatting.
- Improve error checking for null and invalid types.
---
## v0.139.0 [2021-11-01] ## v0.139.0 [2021-11-01]
### Features ### Features
@ -1882,7 +1989,7 @@ In Flux 0.39.0, `holtWinters()` can cause the query engine to panic.
## v0.37.2 [2019-07-24] ## v0.37.2 [2019-07-24]
- _General cleanup of internal code._ - _General cleanup of internal code._
--- ---

31
content/flux/v0.x/stdlib/universe/difference.md
View File

@ -24,9 +24,10 @@ _**Output data type:** Float_
```js ```js
difference( difference(
nonNegative: false, nonNegative: false,
columns: ["_value"], columns: ["_value"],
keepFirst: false keepFirst: false,
initialZero: false,
) )
``` ```
@ -34,7 +35,8 @@ difference(
### nonNegative {data-type="bool"} ### nonNegative {data-type="bool"}
Indicates if the difference is allowed to be negative. Indicates if the difference is allowed to be negative.
When set to `true`, if a value is less than the previous value, it is assumed the previous value should have been a zero. When set to `true`, if a value is less than the previous value, the function
assumes the previous value should have been a zero.
Default is `false`. Default is `false`.
### columns {data-type="array of strings"} ### columns {data-type="array of strings"}
@ -46,6 +48,12 @@ Indicates the first row should be kept.
If `true`, the difference will be `null`. If `true`, the difference will be `null`.
Default is `false`. Default is `false`.
### initialZero {data-type="bool"}
Use zero (`0`) as the initial value in the difference calculation when the
subsequent value is less than the previous value and [`nonNegative`](#nonnegative)
is `true`.
Default is `false`.
### tables {data-type="stream of tables"} ### tables {data-type="stream of tables"}
Input data. Input data.
Default is piped-forward data ([`<-`](/flux/v0.x/spec/expressions/#pipe-expressions)). Default is piped-forward data ([`<-`](/flux/v0.x/spec/expressions/#pipe-expressions)).
@ -56,6 +64,9 @@ Default is piped-forward data ([`<-`](/flux/v0.x/spec/expressions/#pipe-expressi
- `null` minus some value is always `null`; - `null` minus some value is always `null`;
- Some value `v` minus `null` is `v` minus the last non-null value seen before `v`; - Some value `v` minus `null` is `v` minus the last non-null value seen before `v`;
or `null` if `v` is the first non-null value seen. or `null` if `v` is the first non-null value seen.
- If `nonNegative` and `initialZero` are set to true, `difference()` returns the
difference between 0 and the subsequent value. If the subsequent value is
less than zero, `difference()` returns _null_.
## Output tables ## Output tables
For each input table with `n` rows, `difference()` outputs a table with `n - 1` rows. For each input table with `n` rows, `difference()` outputs a table with `n - 1` rows.
@ -71,12 +82,12 @@ For each input table with `n` rows, `difference()` outputs a table with `n - 1`
#### Calculate the difference between subsequent values #### Calculate the difference between subsequent values
```js ```js
import "sample" import "sampledata"
data = sample.int() data = sampledata.int()
data data
|> difference() |> difference()
``` ```
{{< expand-wrapper >}} {{< expand-wrapper >}}
@ -119,7 +130,7 @@ import "sampledata"
data = sampledata.int() data = sampledata.int()
data data
|> difference(nonNegative: true): |> difference(nonNegative: true):
``` ```
{{< expand-wrapper >}} {{< expand-wrapper >}}
@ -163,7 +174,7 @@ import "sampledata"
data = sampledata.int(includeNull: true) data = sampledata.int(includeNull: true)
data data
|> difference() |> difference()
``` ```
{{< expand-wrapper >}} {{< expand-wrapper >}}
@ -204,7 +215,7 @@ data
import "sampledata" import "sampledata"
sampledata.int() sampledata.int()
|> difference(keepFirst: true) |> difference(keepFirst: true)
``` ```
{{% expand "View input and output" %}} {{% expand "View input and output" %}}

25
content/flux/v0.x/stdlib/universe/increase.md
View File

@ -72,19 +72,21 @@ sampledata.int()
| _time | tag | _value | | _time | tag | _value |
| :------------------- | :-- | -----: | | :------------------- | :-- | -----: |
| 2021-01-01T00:00:00Z | t1 | 0 |
| 2021-01-01T00:00:10Z | t1 | 12 | | 2021-01-01T00:00:10Z | t1 | 12 |
| 2021-01-01T00:00:20Z | t1 | 12 | | 2021-01-01T00:00:20Z | t1 | 19 |
| 2021-01-01T00:00:30Z | t1 | 22 | | 2021-01-01T00:00:30Z | t1 | 29 |
| 2021-01-01T00:00:40Z | t1 | 22 | | 2021-01-01T00:00:40Z | t1 | 44 |
| 2021-01-01T00:00:50Z | t1 | 22 | | 2021-01-01T00:00:50Z | t1 | 48 |
| _time | tag | _value | | _time | tag | _value |
| :------------------- | :-- | -----: | | :------------------- | :-- | -----: |
| 2021-01-01T00:00:10Z | t2 | 0 | | 2021-01-01T00:00:00Z | t2 | 0 |
| 2021-01-01T00:00:20Z | t2 | 0 | | 2021-01-01T00:00:10Z | t2 | 4 |
| 2021-01-01T00:00:30Z | t2 | 22 | | 2021-01-01T00:00:20Z | t2 | 4 |
| 2021-01-01T00:00:40Z | t2 | 22 | | 2021-01-01T00:00:30Z | t2 | 26 |
| 2021-01-01T00:00:50Z | t2 | 22 | | 2021-01-01T00:00:40Z | t2 | 39 |
| 2021-01-01T00:00:50Z | t2 | 40 |
{{% /flex-content %}} {{% /flex-content %}}
{{< /flex >}} {{< /flex >}}
@ -93,8 +95,7 @@ sampledata.int()
## Function definition ## Function definition
```js ```js
increase = (tables=<-, column="_value") => increase = (tables=<-, columns=["_value"]) => tables
tables |> difference(nonNegative: true, columns: column, keepFirst: true, initialZero: true)
|> difference(nonNegative: true, column:column)
|> cumulativeSum() |> cumulativeSum()
``` ```