Package org.elasticsearch.xpack.esql.plan.logical.promql

Class WithinSeriesAggregate

java.lang.Object

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

org.elasticsearch.xpack.esql.plan.QueryPlan<LogicalPlan>

org.elasticsearch.xpack.esql.plan.logical.LogicalPlan

org.elasticsearch.xpack.esql.plan.logical.UnaryPlan

org.elasticsearch.xpack.esql.plan.logical.promql.PromqlFunctionCall

org.elasticsearch.xpack.esql.plan.logical.promql.WithinSeriesAggregate

All Implemented Interfaces:

NamedWriteable, Writeable, Resolvable, PromqlPlan

public final class WithinSeriesAggregate
extends PromqlFunctionCall

Represents a PromQL aggregate function call that operates on range vectors.

These functions take a range vector as input and aggregate the values within each series over the specified time range, returning an instant vector. This corresponds to PromQL syntax:

 function_name(range_vector)
 

Examples:

 rate(http_requests_total[5m])
 increase(errors_total[1h])
 delta(cpu_temp_celsius[30m])
 

These functions operate independently on each time series selected by the range vector. The result contains one sample per series at the evaluation timestamp.

Nested Class Summary

Nested classes/interfaces inherited from class org.elasticsearch.xpack.esql.plan.logical.LogicalPlan

LogicalPlan.Stage

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 inherited from class org.elasticsearch.xpack.esql.core.tree.Node

TO_STRING_MAX_LINES, TO_STRING_MAX_WIDTH

Constructor Summary

Constructors

Constructor	Description
WithinSeriesAggregate(Source source, LogicalPlan child, PromqlFunctionDefinition definition, List<Expression> parameters)

Method Summary

Modifier and Type	Method	Description
FunctionType	functionType()
protected NodeInfo<PromqlFunctionCall>	info()	Normally, you want to use one of the static create methods to implement this.
List<Attribute>	output()	The ordered list of attributes (i.e.
WithinSeriesAggregate	replaceChild(LogicalPlan newChild)

Methods inherited from class org.elasticsearch.xpack.esql.plan.logical.promql.PromqlFunctionCall

buildEsqlFunction, definition, equals, expressionsResolved, functionName, getWriteableName, hashCode, parameters, returnType, writeTo

Methods inherited from class org.elasticsearch.xpack.esql.plan.logical.UnaryPlan

child, inputSet, outputSet, replaceChildren

Methods inherited from class org.elasticsearch.xpack.esql.plan.logical.LogicalPlan

analyzed, childrenResolved, optimized, preAnalyzed, preOptimized, resolved, setAnalyzed, setOptimized, setPreAnalyzed, setPreOptimized

Methods inherited from class org.elasticsearch.xpack.esql.plan.QueryPlan

computeExpressions, computeReferences, expressions, forEachExpression, forEachExpression, forEachExpressionDown, forEachExpressionUp, references, transformExpressionsDown, transformExpressionsDown, transformExpressionsOnly, transformExpressionsOnly, transformExpressionsOnlyUp, transformExpressionsUp, transformExpressionsUp

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, nodeString, propertiesToString, replaceChildrenSameSize, source, sourceLocation, sourceText, toString, toString, 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

Constructor Details

WithinSeriesAggregate

public WithinSeriesAggregate(Source source,
 LogicalPlan child,
 PromqlFunctionDefinition definition,
 List<Expression> parameters)

Method Details

info

protected NodeInfo<PromqlFunctionCall> 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<LogicalPlan>

replaceChild

public WithinSeriesAggregate replaceChild(LogicalPlan newChild)

Specified by:

replaceChild in class UnaryPlan

output

public List<Attribute> output()

Description copied from class: QueryPlan

The ordered list of attributes (i.e. columns) this plan produces when executed. Must be called only on resolved plans, otherwise may throw an exception or return wrong results.

Specified by:

output in interface PromqlPlan

Overrides:

output in class PromqlFunctionCall

functionType

public FunctionType functionType()

Specified by:

functionType in class PromqlFunctionCall