Documentation

derivative() function

derivative() computes the rate of change per unit of time between subsequent non-null records.

The function assumes rows are ordered by the _time.

Output tables

The output table schema will be the same as the input table. For each input table with n rows, derivative() outputs a table with n - 1 rows.

Function type signature
(
    <-tables: stream[A],
    ?columns: [string],
    ?initialZero: bool,
    ?nonNegative: bool,
    ?timeColumn: string,
    ?unit: duration,
) => stream[B] where A: Record, B: Record
For more information, see Function type signatures.

Parameters

unit

Time duration used to calculate the derivative. Default is 1s.

nonNegative

Disallow negative derivative values. Default is false.

When true, if a value is less than the previous value, the function assumes the previous value should have been a zero.

columns

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

timeColumn

Column containing time values to use in the calculation. Default is _time.

initialZero

Use zero (0) as the initial value in the derivative calculation when the subsequent value is less than the previous value and nonNegative is true. Default is false.

tables

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

Examples

Calculate the non-negative rate of change per second

import "sampledata"

sampledata.int()
    |> derivative(nonNegative: true)

View example input and output

Calculate the rate of change per second with null values

import "sampledata"

sampledata.int(includeNull: true)
    |> derivative()

View example input and output


Was this page helpful?

Thank you for your feedback!


Introducing InfluxDB Clustered

A highly available InfluxDB 3.0 cluster on your own infrastructure.

InfluxDB Clustered is a highly available InfluxDB 3.0 cluster built for high write and query workloads on your own infrastructure.

InfluxDB Clustered is currently in limited availability and is only available to a limited group of InfluxData customers. If interested in being part of the limited access group, please contact the InfluxData Sales team.

Learn more
Contact InfluxData Sales

The future of Flux

Flux is going into maintenance mode. You can continue using it as you currently are without any changes to your code.

Flux is going into maintenance mode and will not be supported in InfluxDB 3.0. This was a decision based on the broad demand for SQL and the continued growth and adoption of InfluxQL. We are continuing to support Flux for users in 1.x and 2.x so you can continue using it with no changes to your code. If you are interested in transitioning to InfluxDB 3.0 and want to future-proof your code, we suggest using InfluxQL.

For information about the future of Flux, see the following: