Package com.influxdb.query.dsl.functions

Class JoinFlux

java.lang.Object

com.influxdb.query.dsl.Flux

com.influxdb.query.dsl.functions.AbstractParametrizedFlux

com.influxdb.query.dsl.functions.JoinFlux

All Implemented Interfaces:

Expression, HasImports

public final class JoinFlux
extends AbstractParametrizedFlux

Join two time series together on time and the list of on keys. See SPEC.

Options

• tables - Map of tables to join. Currently only two tables are allowed. [map of tables]
• on - List of tag keys that when equal produces a result set. [array of strings]
• method - An optional parameter that specifies the type of join to be performed.

Example

 Flux cpu = Flux.from("telegraf")
     .filter(Restrictions.and(Restrictions.measurement().equal("cpu"), Restrictions.field().equal("usage_user")))
     .range(-30L, ChronoUnit.MINUTES);

 Flux mem = Flux.from("telegraf")
     .filter(Restrictions.and(Restrictions.measurement().equal("mem"), Restrictions.field().equal("used_percent")))
     .range(-30L, ChronoUnit.MINUTES);

 Flux flux = Flux.join()
     .withTable("cpu", cpu)
     .withTable("mem", mem)
     .withOn("host")
     .withMethod("outer");
 

Author:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	JoinFlux.MethodType

Field Summary

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

functionsParameters, imports

Constructor Summary

Constructors

Constructor	Description
JoinFlux()

Method Summary

Modifier and Type	Method	Description
protected void	beforeAppendOperatorName(StringBuilder operator, Map<String,Object> parameters)	Possibility to customize function.
void	collectImports(Set<String> collectedImports)	Collects all imports of the flux.
protected String	operatorName()
JoinFlux	withMethod(JoinFlux.MethodType method)
JoinFlux	withMethod(String method)
JoinFlux	withOn(String tag)
JoinFlux	withOn(String[] tags)
JoinFlux	withOn(Collection<String> tags)
JoinFlux	withTable(String name, Flux table)	Map of table to join.

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

appendActual

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

JoinFlux

public JoinFlux()

Method Details

operatorName

@Nonnull
protected String operatorName()

Specified by:

operatorName in class AbstractParametrizedFlux

Returns:

name of function

beforeAppendOperatorName

protected void beforeAppendOperatorName(@Nonnull
 StringBuilder operator,
 @Nonnull
 Map<String,Object> parameters)

Description copied from class: AbstractParametrizedFlux

Possibility to customize function.

Overrides:

beforeAppendOperatorName in class AbstractParametrizedFlux

Parameters:

operator - current Flux function

parameters - parameters

See Also:

• JoinFlux

withTable

@Nonnull
public JoinFlux withTable(@Nonnull
 String name,
 @Nonnull
 Flux table)

Map of table to join. Currently, only two tables are allowed.

Parameters:

name - table name

table - Flux script to map table

Returns:

this

withOn

@Nonnull
public JoinFlux withOn(@Nonnull
 String tag)

Parameters:

tag - Tag key that when equal produces a result set.

Returns:

this

withOn

@Nonnull
public JoinFlux withOn(@Nonnull
 String[] tags)

Parameters:

tags - List of tag keys that when equal produces a result set.

Returns:

this

withOn

@Nonnull
public JoinFlux withOn(@Nonnull
 Collection<String> tags)

Parameters:

tags - List of tag keys that when equal produces a result set.

Returns:

this

withMethod

@Nonnull
public JoinFlux withMethod(@Nonnull
 String method)

Parameters:

method - the type of join to be performed

Returns:

this

withMethod

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

Parameters:

method - the type of join to be performed

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