Package com.influxdb.query.dsl.functions

Class GroupFlux

java.lang.Object

com.influxdb.query.dsl.Flux

com.influxdb.query.dsl.functions.AbstractParametrizedFlux

com.influxdb.query.dsl.functions.GroupFlux

All Implemented Interfaces:

Expression, HasImports

public final class GroupFlux
extends AbstractParametrizedFlux

Groups results by a user-specified set of tags. See SPEC.

Options

• columns - List of columns used to calculate the new group key. Default [] [array of strings]
• mode - The grouping mode, can be one of by or except. The default is by [string].

Example

 Flux.from("telegraf")
     .range(-30L, ChronoUnit.MINUTES)
     .groupBy(new String[]{"tag_a", "tag_b"});

 Flux.from("telegraf")
     .range(-30L, ChronoUnit.MINUTES)
     .groupBy("tag_a"});

 Flux.from("telegraf")
     .range(-30L, ChronoUnit.MINUTES)
     .groupExcept(new String[]{"tag_c"});
 

Author:

Jakub Bednar (bednar@github) (25/06/2018 14:56)

Field Summary

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

functionsParameters, imports

Constructor Summary

Constructors

Constructor	Description
GroupFlux(Flux source)

Method Summary

Modifier and Type	Method	Description
void	collectImports(Set<String> collectedImports)	Collects all imports of the flux.
protected String	operatorName()
GroupFlux	withBy(String groupBy)
GroupFlux	withBy(String[] groupBy)
GroupFlux	withBy(Collection<String> groupBy)
GroupFlux	withExcept(String except)
GroupFlux	withExcept(String[] except)
GroupFlux	withExcept(Collection<String> except)

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

GroupFlux

public GroupFlux(@Nonnull
 Flux source)

Method Details

operatorName

@Nonnull
protected String operatorName()

Specified by:

operatorName in class AbstractParametrizedFlux

Returns:

name of function

withBy

@Nonnull
public GroupFlux withBy(@Nonnull
 String groupBy)

Parameters:

groupBy - Group by these specific tag name.

Returns:

this

withBy

@Nonnull
public GroupFlux withBy(@Nonnull
 String[] groupBy)

Parameters:

groupBy - Group by these specific tag names.

Returns:

this

withBy

@Nonnull
public GroupFlux withBy(@Nonnull
 Collection<String> groupBy)

Parameters:

groupBy - Group by these specific tag names.

Returns:

this

withExcept

@Nonnull
public GroupFlux withExcept(@Nonnull
 String except)

Parameters:

except - Group by all but these tag key Cannot be used.

Returns:

this

withExcept

@Nonnull
public GroupFlux withExcept(@Nonnull
 String[] except)

Parameters:

except - Group by all but these tag keys Cannot be used.

Returns:

this

withExcept

@Nonnull
public GroupFlux withExcept(@Nonnull
 Collection<String> except)

Parameters:

except - Group by all but these tag keys Cannot be used.

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