Package com.influxdb.query.dsl.functions

Class CovarianceFlux

java.lang.Object

com.influxdb.query.dsl.Flux

com.influxdb.query.dsl.functions.AbstractParametrizedFlux

com.influxdb.query.dsl.functions.CovarianceFlux

All Implemented Interfaces:

Expression, HasImports

public final class CovarianceFlux
extends AbstractParametrizedFlux

Covariance is an aggregate operation. Covariance computes the covariance between two columns. See SPEC.

Options

• columns - List of columns on which to compute the covariance. Exactly two columns must be provided [array of strings].
• pearsonr - Indicates whether the result should be normalized to be the Pearson R coefficient [boolean].
• valueDst - The column into which the result will be placed. Defaults to _value` [string].

Example

 Flux flux = Flux
     .from("telegraf")
     .covariance(new String[]{"_value", "_valueSquare"});
 

Author:

Jakub Bednar (bednar@github) (17/07/2018 13:13)

Field Summary

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

functionsParameters, imports

Constructor Summary

Constructors

Constructor	Description
CovarianceFlux(Flux source)

Method Summary

Modifier and Type	Method	Description
void	collectImports(Set<String> collectedImports)	Collects all imports of the flux.
protected String	operatorName()
CovarianceFlux	withColumns(String[] columns)
CovarianceFlux	withColumns(Collection<String> columns)
CovarianceFlux	withPearsonr(boolean pearsonr)
CovarianceFlux	withValueDst(String valueDst)

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, elapsed, elapsed, elapsed, elapsed, 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

CovarianceFlux

public CovarianceFlux(@Nonnull
 Flux source)

Method Details

operatorName

@Nonnull
protected String operatorName()

Specified by:

operatorName in class AbstractParametrizedFlux

Returns:

name of function

withColumns

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

Parameters:

columns - list of columns on which to compute the covariance. Exactly two columns must be provided.

Returns:

this

withColumns

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

Parameters:

columns - list of columns on which to compute the covariance. Exactly two columns must be provided.

Returns:

this

withPearsonr

@Nonnull
public CovarianceFlux withPearsonr(boolean pearsonr)

Parameters:

pearsonr - Indicates whether the result should be normalized to be the Pearson R coefficient

Returns:

this

withValueDst

@Nonnull
public CovarianceFlux withValueDst(@Nonnull
 String valueDst)

Parameters:

valueDst - column into which the result will be placed.

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