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

Class AcrossSeriesAggregate

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.AcrossSeriesAggregate

All Implemented Interfaces:

NamedWriteable, Writeable, Resolvable, PromqlPlan

public final class AcrossSeriesAggregate
extends PromqlFunctionCall

Represents a PromQL aggregate function call that operates across multiple time series.

These functions aggregate elements from multiple time series into a single result vector, optionally grouping by specific labels. This corresponds to PromQL syntax:

 function_name(instant_vector) [without|by (label_list)]
 

Examples:

 sum(http_requests_total)
 sum(rate(http_requests_total[5m]))
 avg(cpu_usage) by (host, env)
 max(response_time) without (instance)
 

These functions reduce the number of time series by aggregating values across series that share the same grouping labels (or all series if no grouping is specified).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	AcrossSeriesAggregate.Grouping

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
AcrossSeriesAggregate(Source source, LogicalPlan child, String functionName, List<Expression> parameters, AcrossSeriesAggregate.Grouping grouping, List<Attribute> groupings)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
boolean	expressionsResolved()
FunctionType	functionType()
AcrossSeriesAggregate.Grouping	grouping()
List<Attribute>	groupings()
int	hashCode()
protected NodeInfo<PromqlFunctionCall>	info()	Normally, you want to use one of the static create methods to implement this.
List<Attribute>	output()	WITHOUT uses a dynamic _timeseries output because the concrete retained labels are not known until lowering time.
AcrossSeriesAggregate	replaceChild(LogicalPlan newChild)

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

functionName, getWriteableName, 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, 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

AcrossSeriesAggregate

public AcrossSeriesAggregate(Source source,
 LogicalPlan child,
 String functionName,
 List<Expression> parameters,
 AcrossSeriesAggregate.Grouping grouping,
 List<Attribute> groupings)

Method Details

grouping

public AcrossSeriesAggregate.Grouping grouping()

groupings

public List<Attribute> groupings()

expressionsResolved

public boolean expressionsResolved()

Overrides:

expressionsResolved in class PromqlFunctionCall

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 AcrossSeriesAggregate replaceChild(LogicalPlan newChild)

Specified by:

replaceChild in class UnaryPlan

equals

public boolean equals(Object o)

Overrides:

equals in class PromqlFunctionCall

output

public List<Attribute> output()

WITHOUT uses a dynamic _timeseries output because the concrete retained labels are not known until lowering time. BY and NONE export concrete labels or nothing.

Specified by:

output in interface PromqlPlan

Overrides:

output in class PromqlFunctionCall

hashCode

public int hashCode()

Overrides:

hashCode in class PromqlFunctionCall

functionType

public FunctionType functionType()

Specified by:

functionType in class PromqlFunctionCall