Package com.influxdb.query.dsl.functions

Class DerivativeFlux

java.lang.Object

com.influxdb.query.dsl.Flux

com.influxdb.query.dsl.functions.AbstractParametrizedFlux

com.influxdb.query.dsl.functions.DerivativeFlux

All Implemented Interfaces:

Expression, HasImports

public final class DerivativeFlux
extends AbstractParametrizedFlux

Computes the time based difference between subsequent non null records. See SPEC.

Options

• unit - The time duration to use for the result [duration]
• nonNegative - Indicates if the derivative is allowed to be negative [boolean].
• columns - List of columns on which to compute the derivative [array of strings].
• timeColumn - The source column for the time values. Defaults to `_time` [string].

Example

 Flux flux = Flux
     .from("telegraf")
     .derivative(1L, ChronoUnit.MINUTES);

 Flux flux = Flux
     .from("telegraf")
     .derivative()
         .withUnit(10L, ChronoUnit.DAYS)
         .withNonNegative(true)
         .withColumns(new String[]{"columnCompare_1", "columnCompare_2"})
         .withTimeColumn("_timeColumn");
 

Author:

Jakub Bednar (bednar@github) (03/07/2018 14:28)

Field Summary

Fields inherited from class com.influxdb.query.dsl.Flux

functionsParameters, imports

Constructor Summary

Constructors

Constructor	Description
DerivativeFlux(Flux source)

Method Summary

Modifier and Type	Method	Description
void	collectImports(Set<String> collectedImports)	Collects all imports of the flux.
protected String	operatorName()
DerivativeFlux	withColumns(String[] columns)
DerivativeFlux	withColumns(Collection<String> columns)
DerivativeFlux	withNonNegative(boolean useStartTime)
DerivativeFlux	withTimeColumn(String timeColumn)
DerivativeFlux	withUnit(Long duration, ChronoUnit unit)
DerivativeFlux	withUnit(String unit)

Methods inherited from class com.influxdb.query.dsl.functions.AbstractParametrizedFlux

appendActual, beforeAppendOperatorName

Methods inherited from class com.influxdb.query.dsl.Flux

addImport, aggregateWindow, aggregateWindow, arrayFrom, arrayFrom, asVariable, columns, columns, count, count, covariance, covariance, covariance, covariance, covariance, covariance, covariance, covariance, covariance, cumulativeSum, cumulativeSum, cumulativeSum, derivative, derivative, difference, difference, difference, difference, difference, difference, distinct, distinct, drop, drop, drop, drop, duplicate, duplicate, expression, fill, fill, filter, filter, first, from, from, from, function, getImports, group, groupBy, groupBy, groupBy, groupExcept, groupExcept, groupExcept, integral, integral, interpolateLinear, interpolateLinear, join, join, keep, keep, keep, keep, last, last, limit, limit, limit, map, map, max, max, mean, mean, min, min, pivot, pivot, pivot, quantile, quantile, quantile, quantile, quantile, range, range, range, range, range, range, range, reduce, reduce, rename, rename, rename, sample, sample, sample, set, set, skew, skew, sort, sort, sort, sort, sort, sort, spread, spread, stddev, stddev, sum, sum, tail, tail, tail, timeShift, timeShift, timeShift, timeShift, to, to, to, to, to, to, to, to, toBool, toDuration, toFloat, toInt, toString, toString, toString, toStringConvert, toTime, toUInt, truncateTimeColumn, union, window, window, window, window, window, window, window, withFunction, withFunctionNamed, withPipedFunction, withPropertyNamed, withPropertyNamed, withPropertyValue, withPropertyValue, withPropertyValueEscaped, yield, yield

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

DerivativeFlux

public DerivativeFlux(@Nonnull
 Flux source)

Method Details

operatorName

@Nonnull
protected String operatorName()

Specified by:

operatorName in class AbstractParametrizedFlux

Returns:

name of function

withUnit

@Nonnull
public DerivativeFlux withUnit(@Nonnull
 Long duration,
 @Nonnull
 ChronoUnit unit)

Parameters:

duration - the time duration to use for the result

unit - a ChronoUnit determining how to interpret the duration parameter

Returns:

this

withUnit

@Nonnull
public DerivativeFlux withUnit(@Nonnull
 String unit)

Parameters:

unit - the time duration to use for the result

Returns:

this

withNonNegative

@Nonnull
public DerivativeFlux withNonNegative(boolean useStartTime)

Parameters:

useStartTime - Indicates if the derivative is allowed to be negative

Returns:

this

withColumns

@Nonnull
public DerivativeFlux withColumns(@Nonnull
 String[] columns)

Parameters:

columns - List of columns on which to compute the derivative.

Returns:

this

withColumns

@Nonnull
public DerivativeFlux withColumns(@Nonnull
 Collection<String> columns)

Parameters:

columns - List of columns on which to compute the derivative.

Returns:

this

withTimeColumn

@Nonnull
public DerivativeFlux withTimeColumn(@Nonnull
 String timeColumn)

Parameters:

timeColumn - The source column for the time values

Returns:

this

collectImports

public void collectImports(@Nonnull
 Set<String> collectedImports)

Description copied from class: Flux

Collects all imports of the flux.

Overrides:

collectImports in class Flux

Parameters:

collectedImports - a set to be filled by the used imports