Package com.influxdb.query.dsl

Class Flux

java.lang.Object

com.influxdb.query.dsl.Flux

All Implemented Interfaces:

Expression, HasImports

Direct Known Subclasses:

AbstractParametrizedFlux, ExpressionFlux, VariableAssignment

public abstract class Flux
extends Object
implements HasImports, Expression

Flux - Data Scripting Language.
Flux Specification

The functions:

• AggregateWindow
• FromFlux
• CountFlux
• CovarianceFlux
• CumulativeSumFlux
• DerivativeFlux
• DifferenceFlux
• DistinctFlux
• DropFlux
• DuplicateFlux
• FilterFlux
• FirstFlux
• GroupFlux
• IntegralFlux
• JoinFlux
• KeepFlux
• LastFlux
• LimitFlux
• MapFlux
• MaxFlux
• MeanFlux
• MinFlux
• QuantileFlux
• PivotFlux
• RangeFlux
• RenameFlux
• SampleFlux
• SetFlux
• TimeShiftFlux
• SkewFlux
• SortFlux
• SpreadFlux
• StddevFlux
• SumFlux
• ToFlux
• ToBoolFlux
• ToIntFlux
• ToFloatFlux
• ToDurationFlux
• ToStringFlux
• ToTimeFlux
• ToUIntFlux
• WindowFlux
• YieldFlux
• ExpressionFlux

Author:

Jakub Bednar (bednar@github) (22/06/2018 10:16)

Field Summary

Fields

Modifier and Type	Field	Description
protected FunctionsParameters	functionsParameters
protected Set<String>	imports

Constructor Summary

Constructors

Constructor	Description
Flux()

Method Summary

Modifier and Type	Method	Description
protected Flux	addImport(String pImport)	Adds a new import to this flux.
final AggregateWindow	aggregateWindow()	Applies an aggregate or selector function to fixed windows of time.
final AggregateWindow	aggregateWindow(Long every, ChronoUnit everyUnit, String namedFunction)	Applies an aggregate or selector function to fixed windows of time.
abstract void	appendActual(Map<String,Object> parameters, StringBuilder builder)	Append actual Flux function to Flux query.
static ArrayFromFlux	arrayFrom()	Constructs a table from an array of records.
static ArrayFromFlux	arrayFrom(Map<String,Object>... rows)	Constructs a table from an array of records.
VariableAssignment	asVariable(String name)	Converts this flux to a variable assignment so multiple fluxes can be used in conjunction with Expressions.
void	collectImports(Set<String> collectedImports)	Collects all imports of the flux.
final ColumnsFlux	columns()	Lists the column labels of input tables.
final ColumnsFlux	columns(String column)	Lists the column labels of input tables.
final CountFlux	count()	Counts the number of results.
final CountFlux	count(String column)	Counts the number of results.
final CovarianceFlux	covariance()	Covariance computes the covariance between two columns.
final CovarianceFlux	covariance(String[] columns)	Covariance computes the covariance between two columns.
final CovarianceFlux	covariance(String[] columns, boolean pearsonr)	Covariance computes the covariance between two columns.
final CovarianceFlux	covariance(String[] columns, boolean pearsonr, String valueDst)	Covariance computes the covariance between two columns.
final CovarianceFlux	covariance(String[] columns, String valueDst)	Covariance computes the covariance between two columns.
final CovarianceFlux	covariance(Collection<String> columns)	Covariance computes the covariance between two columns.
final CovarianceFlux	covariance(Collection<String> columns, boolean pearsonr)	Covariance computes the covariance between two columns.
final CovarianceFlux	covariance(Collection<String> columns, boolean pearsonr, String valueDst)	Covariance computes the covariance between two columns.
final CovarianceFlux	covariance(Collection<String> columns, String valueDst)	Covariance computes the covariance between two columns.
final CumulativeSumFlux	cumulativeSum()	Computes a running sum for non null records in the table.
final CumulativeSumFlux	cumulativeSum(String[] columns)	Computes a running sum for non null records in the table.
final CumulativeSumFlux	cumulativeSum(Collection<String> columns)	Computes a running sum for non null records in the table.
final DerivativeFlux	derivative()	Computes the time based difference between subsequent non null records.
final DerivativeFlux	derivative(Long duration, ChronoUnit unit)	Computes the time based difference between subsequent non null records.
final DifferenceFlux	difference()	Difference computes the difference between subsequent non null records.
final DifferenceFlux	difference(boolean nonNegative)	Difference computes the difference between subsequent non null records.
final DifferenceFlux	difference(String[] columns)	Difference computes the difference between subsequent non null records.
final DifferenceFlux	difference(String[] columns, boolean nonNegative)	Difference computes the difference between subsequent non null records.
final DifferenceFlux	difference(Collection<String> columns)	Difference computes the difference between subsequent non null records.
final DifferenceFlux	difference(Collection<String> columns, boolean nonNegative)	Difference computes the difference between subsequent non null records.
final DistinctFlux	distinct()	Distinct produces the unique values for a given column.
final DistinctFlux	distinct(String column)	Distinct produces the unique values for a given column.
final DropFlux	drop()	Drop will exclude specified columns from a table.
final DropFlux	drop(String function)	Drop will exclude specified columns from a table.
final DropFlux	drop(String[] columns)	Drop will exclude specified columns from a table.
final DropFlux	drop(Collection<String> columns)	Drop will exclude specified columns from a table.
final DuplicateFlux	duplicate()	Duplicate will duplicate a specified column in a table.
final DuplicateFlux	duplicate(String column, String as)	Duplicate will duplicate a specified column in a table.
final ExpressionFlux	expression(String expression)	Write the custom Flux expression.
final FillFlux	fill()	Replaces all null values in input tables with a non-null value.
final FillFlux	fill(Object value)	Replaces all null values in input tables with a non-null value.
final FilterFlux	filter()	Returns the first result of the query.
final FilterFlux	filter(Restrictions restrictions)	Returns the first result of the query.
final FirstFlux	first()	Returns the first result of the query.
static FromFlux	from(String bucket)	Get data from the specified database.
static FromFlux	from(String bucket, String[] hosts)	Get data from the specified database.
static FromFlux	from(String bucket, Collection<String> hosts)	Get data from the specified database.
final <F extends AbstractParametrizedFlux> F	function(Class<F> type)	Create new function with type type.
Set<String>	getImports()
final GroupFlux	group()	Groups results by a user-specified set of tags.
final GroupFlux	groupBy(String groupBy)	Groups results by a user-specified set of tags.
final GroupFlux	groupBy(String[] groupBy)	Groups results by a user-specified set of tags.
final GroupFlux	groupBy(Collection<String> groupBy)	Groups results by a user-specified set of tags.
final GroupFlux	groupExcept(String except)	Groups results by a user-specified set of tags.
final GroupFlux	groupExcept(String[] except)	Groups results by a user-specified set of tags.
final GroupFlux	groupExcept(Collection<String> except)	Groups results by a user-specified set of tags.
final IntegralFlux	integral()	For each aggregate column, it outputs the area under the curve of non null records.
final IntegralFlux	integral(Long duration, ChronoUnit unit)	For each aggregate column, it outputs the area under the curve of non null records.
final InterpolateLinearFlux	interpolateLinear()	The `interpolate.linear` function inserts rows at regular intervals using linear interpolation to determine values for inserted rows.
final InterpolateLinearFlux	interpolateLinear(Long duration, ChronoUnit unit)	The `interpolate.linear` function inserts rows at regular intervals using linear interpolation to determine values for inserted rows.
static JoinFlux	join()	Join two time series together on time and the list of tags.
static JoinFlux	join(String name1, Flux table1, String name2, Flux table2, String tag, String method)	Join two time series together on time and the list of tags.
final KeepFlux	keep()	It will return a table containing only columns that are specified.
final KeepFlux	keep(String function)	It will return a table containing only columns that are specified.
final KeepFlux	keep(String[] columns)	It will return a table containing only columns that are specified.
final KeepFlux	keep(Collection<String> columns)	It will return a table containing only columns that are specified.
final LastFlux	last()	Returns the last result of the query.
final LastFlux	last(String column)	Returns the last result of the query.
final LimitFlux	limit()	Restricts the number of rows returned in the results.
final LimitFlux	limit(int numberOfResults)	Restricts the number of rows returned in the results.
final LimitFlux	limit(int numberOfResults, int offset)	Restricts the number of rows returned in the results.
final MapFlux	map()	Applies a function to each row of the table.
final MapFlux	map(String function)	Applies a function to each row of the table.
final MaxFlux	max()	Returns the max value within the results.
final MaxFlux	max(String column)	Returns the max value within the results.
final MeanFlux	mean()	Returns the mean of the values within the results.
final MeanFlux	mean(String column)	Returns the mean of the values within the results.
final MinFlux	min()	Returns the min value within the results.
final MinFlux	min(String column)	Returns the min value within the results.
final PivotFlux	pivot()	Pivot collects values stored vertically (column-wise) in a table and aligns them horizontally (row-wise) into logical sets.
final PivotFlux	pivot(String[] rowKey, String[] columnKey, String valueColumn)	Pivot collects values stored vertically (column-wise) in a table and aligns them horizontally (row-wise) into logical sets.
final PivotFlux	pivot(Collection<String> rowKey, Collection<String> columnKey, String valueColumn)	Pivot collects values stored vertically (column-wise) in a table and aligns them horizontally (row-wise) into logical sets.
final QuantileFlux	quantile()	Quantile is both an aggregate operation and a selector operation depending on selected options.
final QuantileFlux	quantile(Float quantile)	Quantile is both an aggregate operation and a selector operation depending on selected options.
final QuantileFlux	quantile(Float quantile, QuantileFlux.MethodType method)	Quantile is both an aggregate operation and a selector operation depending on selected options.
final QuantileFlux	quantile(Float quantile, QuantileFlux.MethodType method, Float compression)	Quantile is both an aggregate operation and a selector operation depending on selected options.
final QuantileFlux	quantile(String column, Float quantile, QuantileFlux.MethodType method, Float compression)	Quantile is both an aggregate operation and a selector operation depending on selected options.
final RangeFlux	range()	Filters the results by time boundaries.
final RangeFlux	range(Long start)	Filters the results by time boundaries.
final RangeFlux	range(Long start, Long stop)	Filters the results by time boundaries.
final RangeFlux	range(Long start, Long stop, ChronoUnit unit)	Filters the results by time boundaries.
final RangeFlux	range(Long start, ChronoUnit unit)	Filters the results by time boundaries.
final RangeFlux	range(Instant start)	Filters the results by time boundaries.
final RangeFlux	range(Instant start, Instant stop)	Filters the results by time boundaries.
final ReduceFlux	reduce()	Reduce aggregates records in each table according to the reducer.
final ReduceFlux	reduce(String function, String identity)	Reduce aggregates records in each table according to the reducer.
final RenameFlux	rename()	Rename will rename specified columns in a table.
final RenameFlux	rename(String function)	Rename will rename specified columns in a table.
final RenameFlux	rename(Map<String,String> columns)	Rename will rename specified columns in a table.
final SampleFlux	sample()	Sample values from a table.
final SampleFlux	sample(int n)	Sample values from a table.
final SampleFlux	sample(int n, int pos)	Sample values from a table.
final SetFlux	set()	Assigns a static value to each record.
final SetFlux	set(String key, String value)	Assigns a static value to each record.
final SkewFlux	skew()	Skew of the results.
final SkewFlux	skew(String column)	Skew of the results.
final SortFlux	sort()	Sorts the results by the specified columns Default sort is ascending.
final SortFlux	sort(boolean desc)	Sorts the results by the specified columns Default sort is ascending.
final SortFlux	sort(String[] columns)	Sorts the results by the specified columns Default sort is ascending.
final SortFlux	sort(String[] columns, boolean desc)	Sorts the results by the specified columns Default sort is ascending.
final SortFlux	sort(Collection<String> columns)	Sorts the results by the specified columns Default sort is ascending.
final SortFlux	sort(Collection<String> columns, boolean desc)	Sorts the results by the specified columns Default sort is ascending.
final SpreadFlux	spread()	Difference between min and max values.
final SpreadFlux	spread(String column)	Difference between min and max values.
final StddevFlux	stddev()	Standard Deviation of the results.
final StddevFlux	stddev(String column)	Standard Deviation of the results.
final SumFlux	sum()	Sum of the results.
final SumFlux	sum(String column)	Sum of the results.
final TailFlux	tail()	Caps the number of records in output tables.
final TailFlux	tail(int numberOfResults)	Caps the number of records in output tables.
final TailFlux	tail(int numberOfResults, int offset)	Caps the number of records in output tables.
final TimeShiftFlux	timeShift()	Shift add a fixed duration to time columns.
final TimeShiftFlux	timeShift(Long amount, ChronoUnit unit)	Shift add a fixed duration to time columns.
final TimeShiftFlux	timeShift(Long amount, ChronoUnit unit, String[] columns)	Shift add a fixed duration to time columns.
final TimeShiftFlux	timeShift(Long amount, ChronoUnit unit, Collection<String> columns)	Shift add a fixed duration to time columns.
final ToFlux	to()	To operation takes data from a stream and writes it to a bucket.
final ToFlux	to(String bucket)	To operation takes data from a stream and writes it to a bucket.
final ToFlux	to(String bucket, String org)	To operation takes data from a stream and writes it to a bucket.
final ToFlux	to(String bucket, String org, String fieldFn)	To operation takes data from a stream and writes it to a bucket.
final ToFlux	to(String bucket, String org, String[] tagColumns, String fieldFn)	To operation takes data from a stream and writes it to a bucket.
final ToFlux	to(String bucket, String org, String host, String token, String timeColumn, String[] tagColumns, String fieldFn)	To operation takes data from a stream and writes it to a bucket.
final ToFlux	to(String bucket, String org, String host, String token, String timeColumn, Collection<String> tagColumns, String fieldFn)	To operation takes data from a stream and writes it to a bucket.
final ToFlux	to(String bucket, String org, Collection<String> tagColumns, String fieldFn)	To operation takes data from a stream and writes it to a bucket.
final ToBoolFlux	toBool()	Convert a value to a bool.
final ToDurationFlux	toDuration()	Convert a value to a duration.
final ToFloatFlux	toFloat()	Convert a value to a float.
final ToIntFlux	toInt()	Convert a value to a int.
String	toString()	Create the Flux query that can be executed by FluxService.
String	toString(Map<String,Object> parameters)	Create the Flux query that can be executed by FluxService.
String	toString(Map<String,Object> parameters, boolean prependImports)
final ToStringFlux	toStringConvert()	Convert a value to a string.
final ToTimeFlux	toTime()	Convert a value to a time.
final ToUIntFlux	toUInt()	Convert a value to a uint.
final TruncateTimeColumnFlux	truncateTimeColumn(ChronoUnit unit)	Truncates all input time values in the _time to a specified unit.
static UnionFlux	union(Flux... tables)	Merges two or more input streams into a single output stream.
final WindowFlux	window()	Groups the results by a given time range.
final WindowFlux	window(Long every, ChronoUnit everyUnit)	Groups the results by a given time range.
final WindowFlux	window(Long every, ChronoUnit everyUnit, Long period, ChronoUnit periodUnit)	Groups the results by a given time range.
final WindowFlux	window(Long every, ChronoUnit everyUnit, Long period, ChronoUnit periodUnit, Long offset, ChronoUnit offsetUnit)	Groups the results by a given time range.
final WindowFlux	window(Long every, ChronoUnit everyUnit, Long period, ChronoUnit periodUnit, Long offset, ChronoUnit offsetUnit, String timeColumn, String startColumn, String stopColumn)	Partitions the results by a given time range.
final WindowFlux	window(Long every, ChronoUnit everyUnit, Long period, ChronoUnit periodUnit, Instant offset)	Groups the results by a given time range.
final WindowFlux	window(Long every, ChronoUnit everyUnit, Long period, ChronoUnit periodUnit, Instant offset, String timeColumn, String startColumn, String stopColumn)	Partitions the results by a given time range.
final Flux	withFunction(String functionName, Object function)	Add named function to current function.
final Flux	withFunctionNamed(String functionName, String namedProperty)	Add named function to current function.
<CALL extends AbstractFunctionCallFlux> CALL	withPipedFunction(AbstractFunctionFlux<CALL> fun)	Creates a piped function call.
final Flux	withPropertyNamed(String property)	Add named property to current function.
final Flux	withPropertyNamed(String fluxName, String namedProperty)	Add named property to current function.
final Flux	withPropertyValue(String property, Long amount, ChronoUnit unit)	Add string property value to current function that will be quoted (value => "value").
final Flux	withPropertyValue(String propertyName, Object value)	Add property value to current function.
final Flux	withPropertyValueEscaped(String property, String value)	Add string property value to current function that will be quoted (value => "value").
final YieldFlux	yield()	Yield a query results to yielded results.
final YieldFlux	yield(String name)	Yield a query results to yielded results.

Methods inherited from class java.lang.Object

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

Field Details

functionsParameters

protected FunctionsParameters functionsParameters

imports

protected Set<String> imports

Constructor Details

Flux

public Flux()

Method Details

from

@Nonnull
public static FromFlux from(@Nonnull
 String bucket)

Get data from the specified database.

Parameters:

bucket - Bucket name

Returns:

FromFlux

from

@Nonnull
public static FromFlux from(@Nonnull
 String bucket,
 @Nonnull
 Collection<String> hosts)

Get data from the specified database.

Parameters:

bucket - Bucket name

hosts - the Fluxd hosts

Returns:

FromFlux

from

@Nonnull
public static FromFlux from(@Nonnull
 String bucket,
 @Nonnull
 String[] hosts)

Get data from the specified database.

Parameters:

bucket - Bucket name

hosts - the Fluxd hosts

Returns:

FromFlux

aggregateWindow

public final AggregateWindow aggregateWindow()

Applies an aggregate or selector function to fixed windows of time.

The parameters had to be defined by:

• AggregateWindow.withEvery(Long, ChronoUnit)
• AggregateWindow.withEvery(String)
• withFunction(String, Object)
• AggregateWindow.withAggregateFunction(String)
• AggregateWindow.withColumn(String)
• AggregateWindow.withTimeSrc(String)
• AggregateWindow.withTimeDst(String)
• AggregateWindow.withCreateEmpty(boolean)

Returns:

AggregateWindow

aggregateWindow

@Nonnull
public final AggregateWindow aggregateWindow(@Nonnull
 Long every,
 @Nonnull
 ChronoUnit everyUnit,
 @Nonnull
 String namedFunction)

Applies an aggregate or selector function to fixed windows of time.

The parameters had to be defined by:

• AggregateWindow.withEvery(Long, ChronoUnit)
• AggregateWindow.withEvery(String)
• withFunction(String, Object)
• AggregateWindow.withAggregateFunction(String)
• AggregateWindow.withColumn(String)
• AggregateWindow.withTimeSrc(String)
• AggregateWindow.withTimeDst(String)
• AggregateWindow.withCreateEmpty(boolean)

Parameters:

every - The duration of windows.

everyUnit - a ChronoUnit determining how to interpret the every.

namedFunction - specifies the named aggregate operation to perform.

Returns:

AggregateWindow

arrayFrom

@Nonnull
public static ArrayFromFlux arrayFrom()

Constructs a table from an array of records.

Returns:

ArrayFromFlux

arrayFrom

@SafeVarargs
@Nonnull
public static ArrayFromFlux arrayFrom(@Nonnull
 Map<String,Object>... rows)

Constructs a table from an array of records.

Parameters:

rows - Array of records to construct a table with.

Returns:

ArrayFromFlux

join

@Nonnull
public static JoinFlux join()

Join two time series together on time and the list of tags.

The parameters had to be defined by:

• JoinFlux.withTable(String, Flux)
• JoinFlux.withOn(String)
• JoinFlux.withOn(String[])
• JoinFlux.withOn(Collection)
• JoinFlux.withMethod(String)
• withPropertyNamed(String)
• withPropertyNamed(String, String)

Returns:

JoinFlux

join

@Nonnull
public static JoinFlux join(@Nonnull
 String name1,
 @Nonnull
 Flux table1,
 @Nonnull
 String name2,
 @Nonnull
 Flux table2,
 @Nonnull
 String tag,
 @Nonnull
 String method)

Join two time series together on time and the list of tags.

Parameters:

name1 - table 1 name

table1 - table 1 Flux script

name2 - table 2 name

table2 - table 2 Flux script

tag - tag key to join

method - the type of join to be performed

Returns:

JoinFlux

keep

@Nonnull
public final KeepFlux keep()

It will return a table containing only columns that are specified.

The parameters had to be defined by:

• KeepFlux.withColumns(String[])
• KeepFlux.withFunction(String)
• withPropertyNamed(String)
• withPropertyNamed(String, String)
• withPropertyValueEscaped(String, String)

Returns:

KeepFlux

keep

@Nonnull
public final KeepFlux keep(@Nonnull
 Collection<String> columns)

It will return a table containing only columns that are specified.

Parameters:

columns - The list of columns that should be included in the resulting table.

Returns:

KeepFlux

keep

@Nonnull
public final KeepFlux keep(@Nonnull
 String[] columns)

It will return a table containing only columns that are specified.

Parameters:

columns - The list of columns that should be included in the resulting table.

Returns:

DropFlux

keep

@Nonnull
public final KeepFlux keep(@Nonnull
 String function)

It will return a table containing only columns that are specified.

Parameters:

function - The function which takes a column name as a parameter and returns a boolean indicating whether or not the column should be included in the resulting table.

Returns:

DropFlux

columns

@Nonnull
public final ColumnsFlux columns()

Lists the column labels of input tables.

Returns:

ColumnsFlux

columns

@Nonnull
public final ColumnsFlux columns(@Nonnull
 String column)

Lists the column labels of input tables.

Parameters:

column - The name of the output column in which to store the column labels.

Returns:

ColumnsFlux

count

@Nonnull
public final CountFlux count()

Counts the number of results.

Returns:

CountFlux

count

@Nonnull
public final CountFlux count(@Nonnull
 String column)

Counts the number of results.

Parameters:

column - The column to aggregate.

Returns:

CountFlux

covariance

@Nonnull
public final CovarianceFlux covariance()

Covariance computes the covariance between two columns.

The parameters had to be defined by:

• CovarianceFlux.withColumns(String[])
• CovarianceFlux.withColumns(Collection)
• CovarianceFlux.withPearsonr(boolean)
• CovarianceFlux.withValueDst(String)
• withPropertyNamed(String)
• withPropertyNamed(String, String)
• withPropertyValueEscaped(String, String)

Returns:

CovarianceFlux

covariance

@Nonnull
public final CovarianceFlux covariance(@Nonnull
 Collection<String> columns)

Covariance computes the covariance between two columns.

Parameters:

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

Returns:

CovarianceFlux

covariance

@Nonnull
public final CovarianceFlux covariance(@Nonnull
 String[] columns)

Covariance computes the covariance between two columns.

Parameters:

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

Returns:

CovarianceFlux

covariance

@Nonnull
public final CovarianceFlux covariance(@Nonnull
 Collection<String> columns,
 boolean pearsonr)

Covariance computes the covariance between two columns.

Parameters:

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

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

Returns:

CovarianceFlux

covariance

@Nonnull
public final CovarianceFlux covariance(@Nonnull
 String[] columns,
 boolean pearsonr)

Covariance computes the covariance between two columns.

Parameters:

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

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

Returns:

CovarianceFlux

covariance

@Nonnull
public final CovarianceFlux covariance(@Nonnull
 Collection<String> columns,
 @Nonnull
 String valueDst)

Covariance computes the covariance between two columns.

Parameters:

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

valueDst - column into which the result will be placed.

Returns:

CovarianceFlux

covariance

@Nonnull
public final CovarianceFlux covariance(@Nonnull
 String[] columns,
 @Nonnull
 String valueDst)

Covariance computes the covariance between two columns.

Parameters:

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

valueDst - column into which the result will be placed.

Returns:

CovarianceFlux

covariance

@Nonnull
public final CovarianceFlux covariance(@Nonnull
 Collection<String> columns,
 boolean pearsonr,
 @Nonnull
 String valueDst)

Covariance computes the covariance between two columns.

Parameters:

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

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

valueDst - column into which the result will be placed.

Returns:

CovarianceFlux

covariance

@Nonnull
public final CovarianceFlux covariance(@Nonnull
 String[] columns,
 boolean pearsonr,
 @Nonnull
 String valueDst)

Covariance computes the covariance between two columns.

Parameters:

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

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

valueDst - column into which the result will be placed.

Returns:

CovarianceFlux

cumulativeSum

@Nonnull
public final CumulativeSumFlux cumulativeSum()

Computes a running sum for non null records in the table.

The parameters had to be defined by:

• CumulativeSumFlux.withColumns(String[])
• CumulativeSumFlux.withColumns(Collection)
• withPropertyNamed(String)
• withPropertyNamed(String, String)
• withPropertyValueEscaped(String, String)

Returns:

CumulativeSumFlux

cumulativeSum

@Nonnull
public final CumulativeSumFlux cumulativeSum(@Nonnull
 String[] columns)

Computes a running sum for non null records in the table.

Parameters:

columns - the columns on which to operate

Returns:

CumulativeSumFlux

cumulativeSum

@Nonnull
public final CumulativeSumFlux cumulativeSum(@Nonnull
 Collection<String> columns)

Computes a running sum for non null records in the table.

Parameters:

columns - the columns on which to operate

Returns:

CumulativeSumFlux

derivative

@Nonnull
public final DerivativeFlux derivative()

Computes the time based difference between subsequent non null records.

The parameters had to be defined by:

• DerivativeFlux.withUnit(Long, ChronoUnit)
• DerivativeFlux.withNonNegative(boolean)
• DerivativeFlux.withColumns(String[])
• DerivativeFlux.withTimeColumn(String)
• withPropertyNamed(String)
• withPropertyNamed(String, String)
• withPropertyValueEscaped(String, String)

Returns:

DerivativeFlux

derivative

@Nonnull
public final DerivativeFlux derivative(@Nonnull
 Long duration,
 @Nonnull
 ChronoUnit unit)

Computes the time based difference between subsequent non null records.

Parameters:

duration - the time duration to use for the result

unit - a ChronoUnit determining how to interpret the duration parameter

Returns:

DerivativeFlux

difference

@Nonnull
public final DifferenceFlux difference()

Difference computes the difference between subsequent non null records.

The parameters had to be defined by:

• DifferenceFlux.withNonNegative(boolean)
• DifferenceFlux.withColumns(String[])
• DifferenceFlux.withColumns(Collection)
• withPropertyNamed(String)
• withPropertyNamed(String, String)
• withPropertyValueEscaped(String, String)

Returns:

DifferenceFlux

difference

@Nonnull
public final DifferenceFlux difference(boolean nonNegative)

Difference computes the difference between subsequent non null records.

Parameters:

nonNegative - indicates if the derivative is allowed to be negative

Returns:

DifferenceFlux

difference

@Nonnull
public final DifferenceFlux difference(@Nonnull
 Collection<String> columns)

Difference computes the difference between subsequent non null records.

Parameters:

columns - list of columns on which to compute the difference

Returns:

DifferenceFlux

difference

@Nonnull
public final DifferenceFlux difference(@Nonnull
 String[] columns)

Difference computes the difference between subsequent non null records.

Parameters:

columns - list of columns on which to compute the difference

Returns:

DifferenceFlux

difference

@Nonnull
public final DifferenceFlux difference(@Nonnull
 Collection<String> columns,
 boolean nonNegative)

Difference computes the difference between subsequent non null records.

Parameters:

columns - list of columns on which to compute the difference

nonNegative - indicates if the derivative is allowed to be negative

Returns:

DifferenceFlux

difference

@Nonnull
public final DifferenceFlux difference(@Nonnull
 String[] columns,
 boolean nonNegative)

Difference computes the difference between subsequent non null records.

Parameters:

columns - list of columns on which to compute the difference

nonNegative - indicates if the derivative is allowed to be negative

Returns:

DifferenceFlux

distinct

@Nonnull
public final DistinctFlux distinct()

Distinct produces the unique values for a given column.

The parameters had to be defined by:

• DistinctFlux.withColumn(String)
• withPropertyNamed(String)
• withPropertyNamed(String, String)
• withPropertyValueEscaped(String, String)

Returns:

DistinctFlux

distinct

@Nonnull
public final DistinctFlux distinct(@Nonnull
 String column)

Distinct produces the unique values for a given column.

Parameters:

column - The column on which to track unique values.

Returns:

DistinctFlux

drop

@Nonnull
public final DropFlux drop()

Drop will exclude specified columns from a table.

The parameters had to be defined by:

• DropFlux.withColumns(String[])
• DropFlux.withFunction(String)
• withPropertyNamed(String)
• withPropertyNamed(String, String)
• withPropertyValueEscaped(String, String)

Returns:

DropFlux

drop

@Nonnull
public final DropFlux drop(@Nonnull
 Collection<String> columns)

Drop will exclude specified columns from a table.

Parameters:

columns - The list of columns which should be excluded from the resulting table.

Returns:

DropFlux

drop

@Nonnull
public final DropFlux drop(@Nonnull
 String[] columns)

Drop will exclude specified columns from a table.

Parameters:

columns - The list of columns which should be excluded from the resulting table.

Returns:

DropFlux

drop

@Nonnull
public final DropFlux drop(@Nonnull
 String function)

Drop will exclude specified columns from a table.

Parameters:

function - The function which takes a column name as a parameter and returns a boolean indicating whether or not the column should be excluded from the resulting table.

Returns:

DropFlux

duplicate

@Nonnull
public final DuplicateFlux duplicate()

Duplicate will duplicate a specified column in a table.

The parameters had to be defined by:

• DuplicateFlux.withAs(String)
• DuplicateFlux.withColumn(String) (String)}
• withPropertyNamed(String)
• withPropertyNamed(String, String)
• withPropertyValueEscaped(String, String)

Returns:

DuplicateFlux

duplicate

@Nonnull
public final DuplicateFlux duplicate(@Nonnull
 String column,
 @Nonnull
 String as)

Duplicate will duplicate a specified column in a table.

The parameters had to be defined by:

• DuplicateFlux.withAs(String)
• DuplicateFlux.withColumn(String) (String)}
• withPropertyNamed(String)
• withPropertyNamed(String, String)
• withPropertyValueEscaped(String, String)

Parameters:

column - the column to duplicate

as - the name that should be assigned to the duplicate column

Returns:

DuplicateFlux

fill

@Nonnull
public final FillFlux fill()

Replaces all null values in input tables with a non-null value.

The parameters had to be defined by:

• FillFlux.withUsePrevious(Boolean)
• FillFlux.withColumn(String)
• FillFlux.withValue(Object)

Returns:

FillFlux

fill

@Nonnull
public final FillFlux fill(@Nonnull
 Object value)

Replaces all null values in input tables with a non-null value.

Parameters:

value - The constant value to use in place of nulls. The type must match the type of the valueColumn.

Returns:

FillFlux

filter

@Nonnull
public final FilterFlux filter()

Returns the first result of the query.

The parameters had to be defined by:

• FilterFlux.withRestrictions(Restrictions)
• withPropertyNamed(String)
• withPropertyNamed(String, String)
• withPropertyValueEscaped(String, String)

Returns:

FilterFlux

filter

@Nonnull
public final FilterFlux filter(@Nonnull
 Restrictions restrictions)

Returns the first result of the query.

Parameters:

restrictions - filter restrictions

Returns:

FilterFlux

first

@Nonnull
public final FirstFlux first()

Returns the first result of the query.

Returns:

FirstFlux

group

@Nonnull
public final GroupFlux group()

Groups results by a user-specified set of tags.

The parameters had to be defined by:

• GroupFlux.withBy(String[])
• GroupFlux.withBy(Collection)
• GroupFlux.withExcept(String[])
• GroupFlux.withExcept(Collection)
• withPropertyNamed(String)
• withPropertyNamed(String, String)
• withPropertyValueEscaped(String, String)

Returns:

GroupFlux

groupBy

@Nonnull
public final GroupFlux groupBy(@Nonnull
 String groupBy)

Groups results by a user-specified set of tags.

Parameters:

groupBy - Group by these specific tag name.

Returns:

GroupFlux

groupBy

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

Groups results by a user-specified set of tags.

Parameters:

groupBy - Group by these specific tag names.

Returns:

GroupFlux

groupBy

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

Groups results by a user-specified set of tags.

Parameters:

groupBy - Group by these specific tag names.

Returns:

GroupFlux

groupExcept

@Nonnull
public final GroupFlux groupExcept(@Nonnull
 Collection<String> except)

Groups results by a user-specified set of tags.

Parameters:

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

Returns:

GroupFlux

groupExcept

@Nonnull
public final GroupFlux groupExcept(@Nonnull
 String except)

Groups results by a user-specified set of tags.

Parameters:

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

Returns:

GroupFlux

groupExcept

@Nonnull
public final GroupFlux groupExcept(@Nonnull
 String[] except)

Groups results by a user-specified set of tags.

Parameters:

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

Returns:

GroupFlux

integral

@Nonnull
public final IntegralFlux integral()

For each aggregate column, it outputs the area under the curve of non null records.

The parameters had to be defined by:

• IntegralFlux.withUnit(Long, ChronoUnit)
• withPropertyNamed(String)
• withPropertyNamed(String, String)

Returns:

IntegralFlux

integral

@Nonnull
public final IntegralFlux integral(@Nonnull
 Long duration,
 @Nonnull
 ChronoUnit unit)

For each aggregate column, it outputs the area under the curve of non null records.

Parameters:

duration - Time duration to use when computing the integral

unit - a ChronoUnit determining how to interpret the duration parameter

Returns:

IntegralFlux

interpolateLinear

@Nonnull
public final InterpolateLinearFlux interpolateLinear()

The `interpolate.linear` function inserts rows at regular intervals using linear interpolation to determine values for inserted rows.

The parameters had to be defined by:

• InterpolateLinearFlux.withEvery(long, ChronoUnit)
• withPropertyNamed(String)
• withPropertyNamed(String, String)

Returns:

InterpolateLinearFlux

interpolateLinear

@Nonnull
public final InterpolateLinearFlux interpolateLinear(@Nonnull
 Long duration,
 @Nonnull
 ChronoUnit unit)

The `interpolate.linear` function inserts rows at regular intervals using linear interpolation to determine values for inserted rows.

Parameters:

duration - Time duration to use when computing the interpolation

unit - a ChronoUnit determining how to interpret the duration parameter

Returns:

InterpolateLinearFlux

last

@Nonnull
public final LastFlux last()

Returns the last result of the query.

Returns:

LastFlux

last

@Nonnull
public final LastFlux last(@Nonnull
 String column)

Returns the last result of the query.

Parameters:

column - The column used to verify the existence of a value.

Returns:

LastFlux

limit

@Nonnull
public final LimitFlux limit()

Restricts the number of rows returned in the results.

The parameters had to be defined by:

• LimitFlux.withN(int)
• withPropertyNamed(String)
• withPropertyNamed(String, String)
• withPropertyValueEscaped(String, String)

Returns:

LimitFlux

limit

@Nonnull
public final LimitFlux limit(int numberOfResults)

Restricts the number of rows returned in the results.

Parameters:

numberOfResults - The number of results

Returns:

LimitFlux

limit

@Nonnull
public final LimitFlux limit(int numberOfResults,
 int offset)

Restricts the number of rows returned in the results.

Parameters:

numberOfResults - The number of results

offset - The number of records to skip per table.

Returns:

LimitFlux

map

@Nonnull
public final MapFlux map()

Applies a function to each row of the table.

The parameters had to be defined by:

• MapFlux.withFunction(String)
• withPropertyNamed(String)
• withPropertyNamed(String, String)

Returns:

MapFlux

map

@Nonnull
public final MapFlux map(@Nonnull
 String function)

Applies a function to each row of the table.

Parameters:

function - The function for map row of table. Example: "r._value * r._value".

Returns:

MapFlux

max

@Nonnull
public final MaxFlux max()

Returns the max value within the results.

Returns:

MaxFlux

max

@Nonnull
public final MaxFlux max(@Nonnull
 String column)

Returns the max value within the results.

Parameters:

column - The column to use to calculate the maximum value.

Returns:

MaxFlux

mean

@Nonnull
public final MeanFlux mean()

Returns the mean of the values within the results.

Returns:

MeanFlux

mean

@Nonnull
public final MeanFlux mean(String column)

Returns the mean of the values within the results.

Parameters:

column - The column to use to compute the mean.

Returns:

MeanFlux

min

@Nonnull
public final MinFlux min()

Returns the min value within the results.

Returns:

MinFlux

min

@Nonnull
public final MinFlux min(@Nonnull
 String column)

Returns the min value within the results.

Parameters:

column - The column to use to calculate the minimum value.

Returns:

MinFlux

quantile

@Nonnull
public final QuantileFlux quantile()

Quantile is both an aggregate operation and a selector operation depending on selected options.

The parameters had to be defined by:

• QuantileFlux.withColumn(String)
• QuantileFlux.withQuantile(Float)
• QuantileFlux.withCompression(Float)
• QuantileFlux.withMethod(String)
• QuantileFlux.withMethod(QuantileFlux.MethodType)
• withPropertyNamed(String)
• withPropertyNamed(String, String)
• withPropertyValueEscaped(String, String)
• withFunction(String, Object)
• withFunctionNamed(String, String)

Returns:

QuantileFlux

quantile

@Nonnull
public final QuantileFlux quantile(@Nonnull
 Float quantile)

Quantile is both an aggregate operation and a selector operation depending on selected options.

Parameters:

quantile - value between 0 and 1 indicating the desired quantile

Returns:

QuantileFlux

quantile

@Nonnull
public final QuantileFlux quantile(@Nonnull
 Float quantile,
 @Nonnull
 QuantileFlux.MethodType method)

Quantile is both an aggregate operation and a selector operation depending on selected options.

Parameters:

quantile - value between 0 and 1 indicating the desired quantile

method - method to aggregate

Returns:

QuantileFlux

quantile

@Nonnull
public final QuantileFlux quantile(@Nonnull
 Float quantile,
 @Nonnull
 QuantileFlux.MethodType method,
 @Nonnull
 Float compression)

Quantile is both an aggregate operation and a selector operation depending on selected options.

Parameters:

quantile - value between 0 and 1 indicating the desired quantile

method - method to aggregate

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

Returns:

QuantileFlux

quantile

@Nonnull
public final QuantileFlux quantile(@Nonnull
 String column,
 @Nonnull
 Float quantile,
 @Nonnull
 QuantileFlux.MethodType method,
 @Nonnull
 Float compression)

Quantile is both an aggregate operation and a selector operation depending on selected options.

Parameters:

column - specifies a column to aggregate

quantile - value between 0 and 1 indicating the desired quantile

method - method to aggregate

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

Returns:

QuantileFlux

pivot

@Nonnull
public final PivotFlux pivot()

Pivot collects values stored vertically (column-wise) in a table and aligns them horizontally (row-wise) into logical sets.

The parameters had to be defined by:

• PivotFlux.withRowKey(String[])
• PivotFlux.withRowKey(Collection)
• PivotFlux.withColumnKey(String[])
• PivotFlux.withColumnKey(Collection)
• PivotFlux.withValueColumn(String)
• withPropertyNamed(String)
• withPropertyNamed(String, String)
• withPropertyValueEscaped(String, String)

Returns:

PivotFlux

pivot

@Nonnull
public final PivotFlux pivot(@Nonnull
 String[] rowKey,
 @Nonnull
 String[] columnKey,
 @Nonnull
 String valueColumn)

Pivot collects values stored vertically (column-wise) in a table and aligns them horizontally (row-wise) into logical sets.

Parameters:

rowKey - the columns used to uniquely identify a row for the output

columnKey - the columns used to pivot values onto each row identified by the rowKey.

valueColumn - the single column that contains the value to be moved around the pivot

Returns:

PivotFlux

pivot

@Nonnull
public final PivotFlux pivot(@Nonnull
 Collection<String> rowKey,
 @Nonnull
 Collection<String> columnKey,
 @Nonnull
 String valueColumn)

Pivot collects values stored vertically (column-wise) in a table and aligns them horizontally (row-wise) into logical sets.

Parameters:

rowKey - the columns used to uniquely identify a row for the output

columnKey - the columns used to pivot values onto each row identified by the rowKey.

valueColumn - the single column that contains the value to be moved around the pivot

Returns:

PivotFlux

range

@Nonnull
public final RangeFlux range()

Filters the results by time boundaries.

The parameters had to be defined by:

• RangeFlux.withStart(Instant)
• RangeFlux.withStart(Long, ChronoUnit)
• RangeFlux.withStop(Instant)
• RangeFlux.withStop(Long, ChronoUnit)
• withPropertyNamed(String)
• withPropertyNamed(String, String)
• withPropertyValueEscaped(String, String)

Returns:

RangeFlux

range

@Nonnull
public final RangeFlux range(@Nonnull
 Instant start)

Filters the results by time boundaries.

Parameters:

start - Specifies the oldest time to be included in the results

Returns:

RangeFlux

range

@Nonnull
public final RangeFlux range(@Nonnull
 Instant start,
 @Nonnull
 Instant stop)

Filters the results by time boundaries.

Parameters:

start - Specifies the oldest time to be included in the results

stop - Specifies the exclusive newest time to be included in the results

Returns:

RangeFlux

range

@Nonnull
public final RangeFlux range(@Nonnull
 Long start,
 @Nonnull
 ChronoUnit unit)

Filters the results by time boundaries.

Parameters:

start - Specifies the oldest time to be included in the results

unit - a ChronoUnit determining how to interpret the start parameter

Returns:

RangeFlux

range

@Nonnull
public final RangeFlux range(@Nonnull
 Long start,
 @Nonnull
 Long stop,
 @Nonnull
 ChronoUnit unit)

Filters the results by time boundaries.

Parameters:

start - Specifies the oldest time to be included in the results

stop - Specifies the exclusive newest time to be included in the results

unit - a ChronoUnit determining how to interpret the start and stop parameter

Returns:

RangeFlux

range

@Nonnull
public final RangeFlux range(Long start,
 Long stop)

Filters the results by time boundaries.

Parameters:

start - Specifies the oldest time (Unix timestamp in seconds) to be included in the results

stop - Specifies the exclusive newest time (Unix timestamp in seconds) to be included in the results

Returns:

RangeFlux

range

@Nonnull
public final RangeFlux range(Long start)

Filters the results by time boundaries.

Parameters:

start - Specifies the oldest time (Unix timestamp in seconds) to be included in the results

Returns:

RangeFlux

reduce

public final ReduceFlux reduce()

Reduce aggregates records in each table according to the reducer.

The parameters had to be defined by:

• ReduceFlux.withFunction(String)
• ReduceFlux.withIdentity(String)

Returns:

ReduceFlux

reduce

public final ReduceFlux reduce(@Nonnull
 String function,
 @Nonnull
 String identity)

Reduce aggregates records in each table according to the reducer.

Parameters:

function - Function to apply to each record. Example: "{sum: r._value + accumulator.sum}".

identity - An initial value to use when creating a reducer. Example: "{sum: 0.0}".

Returns:

ReduceFlux

rename

@Nonnull
public final RenameFlux rename()

Rename will rename specified columns in a table.

The parameters had to be defined by:

• RenameFlux.withColumns(Map)
• RenameFlux.withFunction(String)
• withPropertyNamed(String)
• withPropertyNamed(String, String)
• withPropertyValueEscaped(String, String)

Returns:

RenameFlux

rename

@Nonnull
public final RenameFlux rename(@Nonnull
 Map<String,String> columns)

Rename will rename specified columns in a table.

Parameters:

columns - The map of columns to rename and their corresponding new names.

Returns:

RenameFlux

rename

@Nonnull
public final RenameFlux rename(@Nonnull
 String function)

Rename will rename specified columns in a table.

Parameters:

function - The function which takes a single string parameter (the old column name) and returns a string representing the new column name.

Returns:

RenameFlux

sample

@Nonnull
public final SampleFlux sample()

Sample values from a table.

The parameters had to be defined by:

• SampleFlux.withN(int)
• SampleFlux.withPos(int)
• withPropertyNamed(String)
• withPropertyNamed(String, String)
• withPropertyValueEscaped(String, String)

Returns:

SampleFlux

sample

@Nonnull
public final SampleFlux sample(int n)

Sample values from a table.

Parameters:

n - Sample every Nth element.

Returns:

SampleFlux

sample

@Nonnull
public final SampleFlux sample(int n,
 int pos)

Sample values from a table.

Parameters:

n - Sample every Nth element.

pos - Position offset from start of results to begin sampling. Must be less than @{code n}.

Returns:

SampleFlux

set

@Nonnull
public final SetFlux set()

Assigns a static value to each record.

The parameters had to be defined by:

• SetFlux.withKeyValue(String, String)
• withPropertyNamed(String)
• withPropertyNamed(String, String)
• withPropertyValueEscaped(String, String)

Returns:

SetFlux

set

@Nonnull
public final SetFlux set(@Nonnull
 String key,
 @Nonnull
 String value)

Assigns a static value to each record.

Parameters:

key - label for the column. Has to be defined.

value - value for the column. Has to be defined.

Returns:

SetFlux

timeShift

@Nonnull
public final TimeShiftFlux timeShift()

Shift add a fixed duration to time columns.

The parameters had to be defined by:

• TimeShiftFlux.withDuration(Long, ChronoUnit)
• TimeShiftFlux.withColumns(String[])
• TimeShiftFlux.withColumns(Collection) )}
• withPropertyNamed(String)
• withPropertyNamed(String, String)
• withPropertyValueEscaped(String, String)

Returns:

TimeShiftFlux

timeShift

@Nonnull
public final TimeShiftFlux timeShift(@Nonnull
 Long amount,
 @Nonnull
 ChronoUnit unit)

Shift add a fixed duration to time columns.

Parameters:

amount - The amount to add to each time value

unit - a ChronoUnit determining how to interpret the amount parameter

Returns:

TimeShiftFlux

timeShift

@Nonnull
public final TimeShiftFlux timeShift(@Nonnull
 Long amount,
 @Nonnull
 ChronoUnit unit,
 @Nonnull
 String[] columns)

Shift add a fixed duration to time columns.

Parameters:

amount - The amount to add to each time value

unit - a ChronoUnit determining how to interpret the amount parameter

columns - The list of all columns that should be shifted.

Returns:

TimeShiftFlux

timeShift

@Nonnull
public final TimeShiftFlux timeShift(@Nonnull
 Long amount,
 @Nonnull
 ChronoUnit unit,
 @Nonnull
 Collection<String> columns)

Shift add a fixed duration to time columns.

Parameters:

amount - The amount to add to each time value

unit - a ChronoUnit determining how to interpret the amount parameter

columns - The list of all columns that should be shifted.

Returns:

TimeShiftFlux

skew

@Nonnull
public final SkewFlux skew()

Skew of the results.

Returns:

SkewFlux

skew

@Nonnull
public final SkewFlux skew(@Nonnull
 String column)

Skew of the results.

Parameters:

column - The column on which to operate.

Returns:

SkewFlux

sort

@Nonnull
public final SortFlux sort()

Sorts the results by the specified columns Default sort is ascending.

Returns:

SortFlux

sort

@Nonnull
public final SortFlux sort(boolean desc)

Sorts the results by the specified columns Default sort is ascending.

Parameters:

desc - use the descending sorting

Returns:

SortFlux

sort

@Nonnull
public final SortFlux sort(@Nonnull
 String[] columns)

Sorts the results by the specified columns Default sort is ascending.

Parameters:

columns - columns used to sort

Returns:

SortFlux

sort

@Nonnull
public final SortFlux sort(@Nonnull
 Collection<String> columns)

Sorts the results by the specified columns Default sort is ascending.

Parameters:

columns - columns used to sort

Returns:

SortFlux

sort

@Nonnull
public final SortFlux sort(@Nonnull
 String[] columns,
 boolean desc)

Sorts the results by the specified columns Default sort is ascending.

Parameters:

columns - columns used to sort

desc - use the descending sorting

Returns:

SortFlux

sort

@Nonnull
public final SortFlux sort(@Nonnull
 Collection<String> columns,
 boolean desc)

Sorts the results by the specified columns Default sort is ascending.

Parameters:

columns - columns used to sort

desc - use the descending sorting

Returns:

SortFlux

spread

@Nonnull
public final SpreadFlux spread()

Difference between min and max values.

Returns:

SpreadFlux

spread

@Nonnull
public final SpreadFlux spread(@Nonnull
 String column)

Difference between min and max values.

Parameters:

column - The column on which to operate.

Returns:

SpreadFlux

stddev

@Nonnull
public final StddevFlux stddev()

Standard Deviation of the results.

Returns:

StddevFlux

stddev

@Nonnull
public final StddevFlux stddev(@Nonnull
 String column)

Standard Deviation of the results.

Parameters:

column - The column on which to operate.

Returns:

StddevFlux

sum

@Nonnull
public final SumFlux sum()

Sum of the results.

Returns:

SumFlux

sum

@Nonnull
public final SumFlux sum(@Nonnull
 String column)

Sum of the results.

Parameters:

column - The column on which to operate.

Returns:

SumFlux

tail

@Nonnull
public final TailFlux tail()

Caps the number of records in output tables.

The parameters had to be defined by:

• TailFlux.withN(int)
• withPropertyNamed(String)
• withPropertyNamed(String, String)
• withPropertyValueEscaped(String, String)

Returns:

TailFlux

tail

@Nonnull
public final TailFlux tail(int numberOfResults)

Caps the number of records in output tables.

Parameters:

numberOfResults - The number of results

Returns:

TailFlux

tail

@Nonnull
public final TailFlux tail(int numberOfResults,
 int offset)

Caps the number of records in output tables.

Parameters:

numberOfResults - The number of results

offset - The number of records to skip per table.

Returns:

TailFlux

to

@Nonnull
public final ToFlux to()

To operation takes data from a stream and writes it to a bucket.

The parameters had to be defined by:

• ToFlux.withBucket(String)
• ToFlux.withBucketID(String)
• ToFlux.withOrg(String)
• ToFlux.withOrgID(String)
• ToFlux.withHost(String)
• ToFlux.withToken(String)
• ToFlux.withTimeColumn(String)
• ToFlux.withTagColumns(Collection)
• ToFlux.withTagColumns(String[])
• ToFlux.withFieldFunction(String)
• withPropertyNamed(String)
• withPropertyNamed(String, String)
• withPropertyValueEscaped(String, String)

Returns:

ToFlux

to

@Nonnull
public final ToFlux to(@Nonnull
 String bucket)

To operation takes data from a stream and writes it to a bucket.

Parameters:

bucket - The bucket to which data will be written.

Returns:

ToFlux

to

@Nonnull
public final ToFlux to(@Nonnull
 String bucket,
 @Nonnull
 String org)

To operation takes data from a stream and writes it to a bucket.

Parameters:

bucket - The bucket to which data will be written.

org - The organization name of the above bucket.

Returns:

ToFlux

to

@Nonnull
public final ToFlux to(@Nonnull
 String bucket,
 @Nonnull
 String org,
 @Nonnull
 String fieldFn)

To operation takes data from a stream and writes it to a bucket.

Parameters:

bucket - The bucket to which data will be written.

org - The organization name of the above bucket.

fieldFn - Function that takes a record from the input table and returns an object.

Returns:

ToFlux

to

@Nonnull
public final ToFlux to(@Nonnull
 String bucket,
 @Nonnull
 String org,
 @Nonnull
 String[] tagColumns,
 @Nonnull
 String fieldFn)

To operation takes data from a stream and writes it to a bucket.

Parameters:

bucket - The bucket to which data will be written.

org - The organization name of the above bucket.

tagColumns - The tag columns of the output.

fieldFn - Function that takes a record from the input table and returns an object.

Returns:

ToFlux

to

@Nonnull
public final ToFlux to(@Nonnull
 String bucket,
 @Nonnull
 String org,
 @Nonnull
 Collection<String> tagColumns,
 @Nonnull
 String fieldFn)

To operation takes data from a stream and writes it to a bucket.

Parameters:

bucket - The bucket to which data will be written.

org - The organization name of the above bucket.

tagColumns - The tag columns of the output.

fieldFn - Function that takes a record from the input table and returns an object.

Returns:

ToFlux

to

@Nonnull
public final ToFlux to(@Nonnull
 String bucket,
 @Nonnull
 String org,
 @Nonnull
 String host,
 @Nonnull
 String token,
 @Nonnull
 String timeColumn,
 @Nonnull
 String[] tagColumns,
 @Nonnull
 String fieldFn)

To operation takes data from a stream and writes it to a bucket.

Parameters:

bucket - The bucket to which data will be written.

org - The organization name of the above bucket.

host - The remote host to write to.

token - The authorization token to use when writing to a remote host.

timeColumn - The time column of the output.

tagColumns - The tag columns of the output.

fieldFn - Function that takes a record from the input table and returns an object.

Returns:

ToFlux

to

@Nonnull
public final ToFlux to(@Nonnull
 String bucket,
 @Nonnull
 String org,
 @Nonnull
 String host,
 @Nonnull
 String token,
 @Nonnull
 String timeColumn,
 @Nonnull
 Collection<String> tagColumns,
 @Nonnull
 String fieldFn)

To operation takes data from a stream and writes it to a bucket.

Parameters:

bucket - The bucket to which data will be written.

org - The organization name of the above bucket.

host - The remote host to write to.

token - The authorization token to use when writing to a remote host.

timeColumn - The time column of the output.

tagColumns - The tag columns of the output.

fieldFn - Function that takes a record from the input table and returns an object.

Returns:

ToFlux

toBool

@Nonnull
public final ToBoolFlux toBool()

Convert a value to a bool.

Returns:

ToBoolFlux

toInt

@Nonnull
public final ToIntFlux toInt()

Convert a value to a int.

Returns:

ToIntFlux

toFloat

@Nonnull
public final ToFloatFlux toFloat()

Convert a value to a float.

Returns:

ToFloatFlux

toDuration

@Nonnull
public final ToDurationFlux toDuration()

Convert a value to a duration.

Returns:

ToDurationFlux

toStringConvert

@Nonnull
public final ToStringFlux toStringConvert()

Convert a value to a string.

Returns:

ToStringFlux

toTime

@Nonnull
public final ToTimeFlux toTime()

Convert a value to a time.

Returns:

ToTimeFlux

toUInt

@Nonnull
public final ToUIntFlux toUInt()

Convert a value to a uint.

Returns:

ToUIntFlux

truncateTimeColumn

@Nonnull
public final TruncateTimeColumnFlux truncateTimeColumn(@Nonnull
 ChronoUnit unit)

Truncates all input time values in the _time to a specified unit.

Parameters:

unit - Unit of time to truncate to. Has to be defined.

Returns:

TruncateTimeColumnFlux

union

public static UnionFlux union(@Nonnull
 Flux... tables)

Merges two or more input streams into a single output stream.

Parameters:

tables - the tables to union

Returns:

UnionFlux

window

@Nonnull
public final WindowFlux window()

Groups the results by a given time range.

The parameters had to be defined by:

• WindowFlux.withEvery(Long, ChronoUnit)
• WindowFlux.withPeriod(Long, ChronoUnit)
• WindowFlux.withOffset(Long, ChronoUnit)
• WindowFlux.withOffset(Instant)
• WindowFlux.withTimeColumn(String)
• WindowFlux.withStartColumn(String)
• WindowFlux.withStartColumn(String)
• withPropertyNamed(String)
• withPropertyNamed(String, String)
• withPropertyValueEscaped(String, String)

Returns:

WindowFlux

window

@Nonnull
public final WindowFlux window(@Nonnull
 Long every,
 @Nonnull
 ChronoUnit everyUnit)

Groups the results by a given time range.

Parameters:

every - duration of time between windows

everyUnit - a ChronoUnit determining how to interpret the every

Returns:

WindowFlux

window

@Nonnull
public final WindowFlux window(@Nonnull
 Long every,
 @Nonnull
 ChronoUnit everyUnit,
 @Nonnull
 Long period,
 @Nonnull
 ChronoUnit periodUnit)

Groups the results by a given time range.

Parameters:

every - duration of time between windows

everyUnit - a ChronoUnit determining how to interpret the every

period - duration of the windowed partition

periodUnit - a ChronoUnit determining how to interpret the period

Returns:

WindowFlux

window

@Nonnull
public final WindowFlux window(@Nonnull
 Long every,
 @Nonnull
 ChronoUnit everyUnit,
 @Nonnull
 Long period,
 @Nonnull
 ChronoUnit periodUnit,
 @Nonnull
 Instant offset)

Groups the results by a given time range.

Parameters:

every - duration of time between windows

everyUnit - a ChronoUnit determining how to interpret the every

period - duration of the windowed partition

periodUnit - a ChronoUnit determining how to interpret the period

offset - The offset duration relative to the location offset

Returns:

WindowFlux

window

@Nonnull
public final WindowFlux window(@Nonnull
 Long every,
 @Nonnull
 ChronoUnit everyUnit,
 @Nonnull
 Long period,
 @Nonnull
 ChronoUnit periodUnit,
 @Nonnull
 Long offset,
 @Nonnull
 ChronoUnit offsetUnit)

Groups the results by a given time range.

Parameters:

every - duration of time between windows

everyUnit - a ChronoUnit determining how to interpret the every

period - duration of the windowed partition

periodUnit - a ChronoUnit determining how to interpret the period

offset - The offset duration relative to the location offset

offsetUnit - a ChronoUnit determining how to interpret the offset

Returns:

WindowFlux

window

@Nonnull
public final WindowFlux window(@Nonnull
 Long every,
 @Nonnull
 ChronoUnit everyUnit,
 @Nonnull
 Long period,
 @Nonnull
 ChronoUnit periodUnit,
 @Nonnull
 Long offset,
 @Nonnull
 ChronoUnit offsetUnit,
 @Nonnull
 String timeColumn,
 @Nonnull
 String startColumn,
 @Nonnull
 String stopColumn)

Partitions the results by a given time range.

Parameters:

every - duration of time between windows

everyUnit - a ChronoUnit determining how to interpret the every

period - duration of the windowed partition

periodUnit - a ChronoUnit determining how to interpret the period

offset - The offset duration relative to the location offset

offsetUnit - a ChronoUnit determining how to interpret the offset

timeColumn - name of the time column to use

startColumn - name of the column containing the window start time

stopColumn - name of the column containing the window stop time

Returns:

WindowFlux

window

@Nonnull
public final WindowFlux window(@Nonnull
 Long every,
 @Nonnull
 ChronoUnit everyUnit,
 @Nonnull
 Long period,
 @Nonnull
 ChronoUnit periodUnit,
 @Nonnull
 Instant offset,
 @Nonnull
 String timeColumn,
 @Nonnull
 String startColumn,
 @Nonnull
 String stopColumn)

Partitions the results by a given time range.

Parameters:

every - duration of time between windows

everyUnit - a ChronoUnit determining how to interpret the every

period - duration of the windowed partition

periodUnit - a ChronoUnit determining how to interpret the period

offset - The offset duration relative to the location offset

timeColumn - name of the time column to use

startColumn - name of the column containing the window start time

stopColumn - name of the column containing the window stop time

Returns:

WindowFlux

yield

@Nonnull
public final YieldFlux yield()

Yield a query results to yielded results.

The parameters had to be defined by:

• YieldFlux.withName(String)
• withPropertyNamed(String)
• withPropertyNamed(String, String)
• withPropertyValueEscaped(String, String)

Returns:

YieldFlux

yield

@Nonnull
public final YieldFlux yield(@Nonnull
 String name)

Yield a query results to yielded results.

Parameters:

name - The unique name to give to yielded results. Has to be defined.

Returns:

YieldFlux

expression

@Nonnull
public final ExpressionFlux expression(@Nonnull
 String expression)

Write the custom Flux expression.

Parameters:

expression - flux expression

Returns:

ExpressionFlux

function

@Nonnull
public final <F extends AbstractParametrizedFlux> F function(@Nonnull
 Class<F> type)

Create new function with type type.

 Flux flux = Flux
      .from("telegraf")
      .function(FilterMeasurement.class)
          .withName("cpu")
      .sum();
 

Type Parameters:

F - function type

Parameters:

type - function type

Returns:

function with type

withPipedFunction

public <CALL extends AbstractFunctionCallFlux> CALL withPipedFunction(AbstractFunctionFlux<CALL> fun)

Creates a piped function call.

Example Definition

 public static class MultByXFunction extends AbstractFunctionFlux<MultByXFunction.MultByXFunctionCall> {

     public MultByXFunction() {
         super("multByX",
                 new FreestyleExpression("tables")
                         .map("(r) => ({r with _value: r._value * x})"),
                 MultByXFunctionCall::new,
                 new Parameter("tables").withPipeForward(true),
                 new Parameter("x"));
     }

     public static class MultByXFunctionCall extends AbstractFunctionCallFlux {

         public MultByXFunctionCall(@Nonnull String name) {
             super(name);
         }

         public MultByXFunctionCall withX(final Number x) {
             this.withPropertyValue("x", x);
             return this;
         }
     }
 }
 

Example Usage

 MultByXFunction multByX = new MultByXFunction();

 Expressions flux = new Expressions(
         multByX,
         Flux.from("telegraph")
                 .withPipedFunction(multByX)
                 .withX(42.)
                 .count()
 );
 

Type Parameters:

CALL - the type of the invocation

Parameters:

fun - the function to be piped

Returns:

the invocation

withPropertyNamed

@Nonnull
public final Flux withPropertyNamed(@Nonnull
 String property)

Add named property to current function.

  FluxChain fluxChain = new FluxChain()
      .withPropertyNamed("every", 15, ChronoUnit.MINUTES)
      .withPropertyNamed("period", 20L, ChronoUnit.SECONDS)
      .withPropertyNamed("start", -50, ChronoUnit.DAYS)
      .withPropertyNamed("round", 1L, ChronoUnit.HOURS);

  Flux flux = Flux.from("telegraf")
      .window()
          .withPropertyNamed("every")
          .withPropertyNamed("period")
          .withPropertyNamed("start")
          .withPropertyNamed("round")
      .sum();

 flux.print(fluxChain);
 

Parameters:

property - name in Flux query and in named properties

Returns:

a current function.

withPropertyNamed

@Nonnull
public final Flux withPropertyNamed(@Nonnull
 String fluxName,
 @Nonnull
 String namedProperty)

Add named property to current function.

 Flux flux = Flux
      .from("telegraf")
      .limit()
          .withPropertyNamed("n", "limit")
      .sum();

 FluxChain fluxChain = new FluxChain()
      .withPropertyNamed("limit", 15);

 flux.print(fluxChain);
 

Parameters:

fluxName - name in Flux query

namedProperty - name in named properties

Returns:

a current function

withPropertyValue

@Nonnull
public final Flux withPropertyValue(@Nonnull
 String propertyName,
 @Nullable
 Object value)

Add property value to current function.

 Flux flux = Flux
      .from("telegraf")
      .limit()
          .withPropertyValue("n", 5)
      .sum();
 

Parameters:

propertyName - name in Flux query

value - value of property. If null than ignored.

Returns:

a current function

withFunction

@Nonnull
public final Flux withFunction(@Nonnull
 String functionName,
 @Nullable
 Object function)

Add named function to current function.

 Flux flux = Flux
      .from("telegraf")
      .drop()
           .withFunction("fn", "column =~ free*");
 

Parameters:

functionName - name in Flux query

function - defined function

Returns:

a current function

withFunctionNamed

@Nonnull
public final Flux withFunctionNamed(@Nonnull
 String functionName,
 @Nonnull
 String namedProperty)

Add named function to current function.

 Map<String, Object> parameters = new HashMap<>();
 parameters.put("function", "r._value * 10");

 Flux flux = Flux
     .from("telegraf")
     .range(-12L, ChronoUnit.HOURS)
     .map()
          .withFunctionNamed("fn: (r)", "function");
 

Parameters:

functionName - name in Flux query

namedProperty - name in named properties

Returns:

a current function

withPropertyValue

@Nonnull
public final Flux withPropertyValue(@Nonnull
 String property,
 @Nullable
 Long amount,
 @Nullable
 ChronoUnit unit)

Add string property value to current function that will be quoted (value => "value").

 Flux flux = Flux
      .from("telegraf")
      .window(5, ChronoUnit.MINUTES)
          .withPropertyValueEscaped("startColumn", "differentCol")
      .sum();
 

Parameters:

property - name of property in Flux query

amount - the amount of the duration, measured in terms of the unit, positive or negative

unit - the unit that the duration is measured in, must have an exact duration. If null than ignored.

Returns:

a current function

withPropertyValueEscaped

@Nonnull
public final Flux withPropertyValueEscaped(@Nonnull
 String property,
 @Nullable
 String value)

Add string property value to current function that will be quoted (value => "value").

 Flux flux = Flux
      .from("telegraf")
      .window(5, ChronoUnit.MINUTES)
          .withPropertyValueEscaped("startColumn", "differentCol")
      .sum();
 

Parameters:

property - name of property in Flux query

value - value of property. If null than ignored.

Returns:

a current function

appendActual

public abstract void appendActual(@Nonnull
 Map<String,Object> parameters,
 @Nonnull
 StringBuilder builder)

Append actual Flux function to Flux query.

Parameters:

parameters - named parameters for Flux query

builder - Flux query chaing

toString

@Nonnull
public String toString()

Create the Flux query that can be executed by FluxService.

Overrides:

toString in class Object

Returns:

Flux query

toString

@Nonnull
public String toString(@Nonnull
 Map<String,Object> parameters)

Create the Flux query that can be executed by FluxService.

Parameters:

parameters - flux query named parameters

Returns:

Flux query

toString

public String toString(@Nonnull
 Map<String,Object> parameters,
 boolean prependImports)

Specified by:

toString in interface Expression

Parameters:

parameters - parameters to resolve

prependImports - true, if the imports should be prepended

Returns:

the string representation of the expression

asVariable

public VariableAssignment asVariable(String name)

Converts this flux to a variable assignment so multiple fluxes can be used in conjunction with Expressions.

Parameters:

name - the name of the variable

Returns:

a variable assignment

See Also:

• Expressions

getImports

public Set<String> getImports()

Specified by:

getImports in interface HasImports

Returns:

all used imports of this flux

collectImports

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

Collects all imports of the flux.

Parameters:

collectedImports - a set to be filled by the used imports

addImport

protected Flux addImport(String pImport)

Adds a new import to this flux.

Parameters:

pImport - the import to be added

Returns:

this