Package com.influxdb.query.dsl.functions

Class QuantileFlux

java.lang.Object

com.influxdb.query.dsl.Flux

com.influxdb.query.dsl.functions.AbstractParametrizedFlux

com.influxdb.query.dsl.functions.QuantileFlux

All Implemented Interfaces:

Expression, HasImports

public final class QuantileFlux
extends AbstractParametrizedFlux

Quantile is both an aggregate operation and a selector operation depending on selected options. In the aggregate methods, it outputs the value that represents the specified quantile of the non null record as a float. See SPEC.

Options

• column - column to aggregate. Defaults to _value. [string]
• quantile - value between 0 and 1 indicating the desired quantile. [float]
• method - method to aggregate
• compression - Compression indicates how many centroids to use when compressing the dataset. A larger number produces a more accurate result at the cost of increased memory requirements. Defaults to 1000. [float]

Example

 Flux flux = Flux
     .from("telegraf")
     .quantile(0.80F);

 Flux flux = Flux
     .from("telegraf")
     .quantile()
         .withQuantile(0.75F)
         .withMethod(MethodType.EXACT_MEAN)
         .withCompression(2_000F);
 

Author:

Jakub Bednar (10/10/2018 11:34)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	QuantileFlux.MethodType	Methods for computation.

Field Summary

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

functionsParameters, imports

Constructor Summary

Constructors

Constructor	Description
QuantileFlux(Flux source)

Method Summary

Modifier and Type	Method	Description
void	collectImports(Set<String> collectedImports)	Collects all imports of the flux.
protected String	operatorName()
QuantileFlux	withColumn(String column)
QuantileFlux	withCompression(Float compression)
QuantileFlux	withMethod(QuantileFlux.MethodType method)
QuantileFlux	withMethod(String method)
QuantileFlux	withQuantile(Float quantile)

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

QuantileFlux

public QuantileFlux(@Nonnull
 Flux source)

Method Details

operatorName

@Nonnull
protected String operatorName()

Specified by:

operatorName in class AbstractParametrizedFlux

Returns:

name of function

withColumn

@Nonnull
public QuantileFlux withColumn(@Nonnull
 String column)

Parameters:

column - The column to aggregate. Defaults to "_value".

Returns:

this

withQuantile

@Nonnull
public QuantileFlux withQuantile(@Nonnull
 Float quantile)

Parameters:

quantile - value between 0 and 1 indicating the desired quantile

Returns:

this

withCompression

@Nonnull
public QuantileFlux withCompression(@Nonnull
 Float compression)

Parameters:

compression - indicates how many centroids to use when compressing the dataset.

Returns:

this

withMethod

@Nonnull
public QuantileFlux withMethod(@Nonnull
 String method)

Parameters:

method - method to aggregate

Returns:

this

withMethod

@Nonnull
public QuantileFlux withMethod(@Nonnull
 QuantileFlux.MethodType method)

Parameters:

method - method to aggregate

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