Back to Influxdb

cumulativeSum() function

content/flux/v0/stdlib/universe/cumulativesum.md

latest2.8 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/universe/universe.flux#L224-L227 Contributing to Flux: https://github.com/influxdata/flux#contributing Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md ------------------------------------------------------------------------------->

cumulativeSum() computes a running sum for non-null records in a table.

The output table schema will be the same as the input table.

Function type signature
js
(<-tables: stream[A], ?columns: [string]) => stream[B] where A: Record, B: Record

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

Parameters

columns

List of columns to operate on. Default is ["_value"].

tables

Input data. Default is piped-forward data (<-).

Examples

Return the running total of values in each table

js
import "sampledata"

sampledata.int()
    |> cumulativeSum()

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

Input data

_time_value*tag
2021-01-01T00:00:00Z-2t1
2021-01-01T00:00:10Z10t1
2021-01-01T00:00:20Z7t1
2021-01-01T00:00:30Z17t1
2021-01-01T00:00:40Z15t1
2021-01-01T00:00:50Z4t1
_time_value*tag
2021-01-01T00:00:00Z19t2
2021-01-01T00:00:10Z4t2
2021-01-01T00:00:20Z-3t2
2021-01-01T00:00:30Z19t2
2021-01-01T00:00:40Z13t2
2021-01-01T00:00:50Z1t2

Output data

_time_value*tag
2021-01-01T00:00:00Z-2t1
2021-01-01T00:00:10Z8t1
2021-01-01T00:00:20Z15t1
2021-01-01T00:00:30Z32t1
2021-01-01T00:00:40Z47t1
2021-01-01T00:00:50Z51t1
_time_value*tag
2021-01-01T00:00:00Z19t2
2021-01-01T00:00:10Z23t2
2021-01-01T00:00:20Z20t2
2021-01-01T00:00:30Z39t2
2021-01-01T00:00:40Z52t2
2021-01-01T00:00:50Z53t2

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