Package org.elasticsearch.xpack.esql.expression.function.aggregate

Class Rate

java.lang.Object

org.elasticsearch.xpack.esql.core.tree.Node<Expression>

org.elasticsearch.xpack.esql.core.expression.Expression

org.elasticsearch.xpack.esql.core.expression.function.Function

org.elasticsearch.xpack.esql.expression.function.aggregate.AggregateFunction

org.elasticsearch.xpack.esql.expression.function.aggregate.TimeSeriesAggregateFunction

org.elasticsearch.xpack.esql.expression.function.aggregate.Rate

All Implemented Interfaces:

NamedWriteable, Writeable, PostAnalysisPlanVerificationAware, Resolvable, OptionalArgument, TemporalityAware, TimestampAware, ToAggregator

public class Rate
extends TimeSeriesAggregateFunction
implements OptionalArgument, ToAggregator, TimestampAware, TemporalityAware

Nested Class Summary

Nested classes/interfaces inherited from class org.elasticsearch.xpack.esql.core.expression.Expression

Expression.TypeResolution

Nested classes/interfaces inherited from class org.elasticsearch.xpack.esql.core.tree.Node

Node.NodeStringFormat

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

Fields

Modifier and Type	Field	Description
static final FunctionDefinition	DEFINITION
static final NamedWriteableRegistry.Entry	ENTRY
static final PromqlFunctionDefinition	PROMQL_DEFINITION

Fields inherited from class org.elasticsearch.xpack.esql.expression.function.aggregate.AggregateFunction

NO_WINDOW, WINDOW_INTERVAL

Fields inherited from class org.elasticsearch.xpack.esql.core.tree.Node

TO_STRING_MAX_LINES, TO_STRING_MAX_WIDTH

Constructor Summary

Constructors

Constructor	Description
Rate(Source source, Expression field, Expression window, Expression timestamp, Expression temporality)
Rate(Source source, Expression field, Expression filter, Expression window, Expression timestamp, Expression temporality)

Method Summary

Modifier and Type	Method	Description
static Rate	createWithImplicitTemporality(Source source, Expression field, Expression window, Expression timestamp)
DataType	dataType()	The DataType returned by executing the tree rooted at this expression.
String	getWriteableName()
protected NodeInfo<Rate>	info()	Normally, you want to use one of the static create methods to implement this.
Rate	perTimeSeriesAggregation()	Returns the aggregation function to be used in the first aggregation stage, which is grouped by `_tsid` (and `time_bucket`).
Rate	replaceChildren(List<Expression> newChildren)
boolean	requiredTimeSeriesSource()
protected Expression.TypeResolution	resolveType()	The implementation of Expression.typeResolved(), which is just a caching wrapper around this method.
AggregatorFunctionSupplier	supplier()
Expression	temporality()	The current value for the temporality argument of the function.
Expression	timestamp()
String	toString()
Rate	withFilter(Expression filter)	Attach a filter to the aggregate function.
Rate	withTemporality(Expression newTemporality)	Returns a copy of this function with the provided value as temporality argument.

Methods inherited from class org.elasticsearch.xpack.esql.expression.function.aggregate.TimeSeriesAggregateFunction

aggregateInputReferences

Methods inherited from class org.elasticsearch.xpack.esql.expression.function.aggregate.AggregateFunction

equals, field, filter, hasFilter, hashCode, hasWindow, parameters, postAnalysisPlanVerification, readWindow, window, withField, withFilter, withFilter, withParameters, withWindow, writeTo

Methods inherited from class org.elasticsearch.xpack.esql.core.expression.function.Function

arguments, functionName, nodeString, nullable

Methods inherited from class org.elasticsearch.xpack.esql.core.expression.Expression

canonical, canonicalize, childrenResolved, fold, foldable, propertiesToString, references, resolved, semanticEquals, semanticHash, toString, typeResolved

Methods inherited from class org.elasticsearch.xpack.esql.core.tree.Node

allMatch, anyMatch, children, collect, collect, collect, collectFirstChildren, collectLeaves, doCollectFirst, forEachDown, forEachDown, forEachDownMayReturnEarly, forEachProperty, forEachPropertyDown, forEachPropertyOnly, forEachPropertyUp, forEachUp, forEachUp, nodeName, nodeProperties, nodeString, replaceChildrenSameSize, source, sourceLocation, sourceText, toString, transformChildren, transformChildren, transformDown, transformDown, transformDown, transformDown, transformDownSkipBranch, transformNodeProps, transformPropertiesDown, transformPropertiesOnly, transformPropertiesUp, transformUp, transformUp, transformUp

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

ENTRY

public static final NamedWriteableRegistry.Entry ENTRY

DEFINITION

public static final FunctionDefinition DEFINITION

PROMQL_DEFINITION

public static final PromqlFunctionDefinition PROMQL_DEFINITION

Constructor Details

Rate

public Rate(Source source,
 Expression field,
 Expression window,
 Expression timestamp,
 @Nullable
 Expression temporality)

Rate

public Rate(Source source,
 Expression field,
 Expression filter,
 Expression window,
 Expression timestamp,
 @Nullable
 Expression temporality)

Method Details

createWithImplicitTemporality

public static Rate createWithImplicitTemporality(Source source,
 Expression field,
 Expression window,
 Expression timestamp)

getWriteableName

public String getWriteableName()

Specified by:

getWriteableName in interface NamedWriteable

info

protected NodeInfo<Rate> info()

Description copied from class: Node

Normally, you want to use one of the static create methods to implement this.

For QueryPlans, it is very important that the properties contain all of the expressions and references relevant to this node, and that all the properties are used in the provided constructor; otherwise query plan transformations like QueryPlan#transformExpressionsOnly(Function) will not have an effect.

Specified by:

info in class Node<Expression>

replaceChildren

public Rate replaceChildren(List<Expression> newChildren)

Specified by:

replaceChildren in class Node<Expression>

withFilter

public Rate withFilter(Expression filter)

Description copied from class: AggregateFunction

Attach a filter to the aggregate function.

Specified by:

withFilter in class AggregateFunction

dataType

public DataType dataType()

Description copied from class: Expression

The DataType returned by executing the tree rooted at this expression. If Expression.typeResolved() returns an error then the behavior of this method is undefined. It may return a valid type. Or it may throw an exception. Or it may return a totally nonsensical type.

Specified by:

dataType in class Expression

resolveType

protected Expression.TypeResolution resolveType()

Description copied from class: Expression

The implementation of Expression.typeResolved(), which is just a caching wrapper around this method. See it's javadoc for what this method should return.

Implementations will rarely interact with the Expression.TypeResolution class directly, instead usually calling the utility methods on TypeResolutions.

Implementations should fail if Expression.childrenResolved() returns false.

Overrides:

resolveType in class AggregateFunction

supplier

public AggregatorFunctionSupplier supplier()

Specified by:

supplier in interface ToAggregator

perTimeSeriesAggregation

public Rate perTimeSeriesAggregation()

Description copied from class: TimeSeriesAggregateFunction

Returns the aggregation function to be used in the first aggregation stage, which is grouped by `_tsid` (and `time_bucket`).

Specified by:

perTimeSeriesAggregation in class TimeSeriesAggregateFunction

See Also:

• TranslateTimeSeriesAggregate

toString

public String toString()

Overrides:

toString in class Expression

timestamp

public Expression timestamp()

Specified by:

timestamp in interface TimestampAware

temporality

public Expression temporality()

Description copied from interface: TemporalityAware

The current value for the temporality argument of the function. If this is null, it will be injected automatically during local planning.

Specified by:

temporality in interface TemporalityAware

Returns:

the current value for the temporality argument

withTemporality

public Rate withTemporality(Expression newTemporality)

Description copied from interface: TemporalityAware

Returns a copy of this function with the provided value as temporality argument.

Specified by:

withTemporality in interface TemporalityAware

requiredTimeSeriesSource

public boolean requiredTimeSeriesSource()

Overrides:

requiredTimeSeriesSource in class TimeSeriesAggregateFunction