Package org.elasticsearch.xpack.esql.plan.physical

Class TimeSeriesAggregateExec

java.lang.Object

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

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

org.elasticsearch.xpack.esql.plan.physical.PhysicalPlan

org.elasticsearch.xpack.esql.plan.physical.UnaryExec

org.elasticsearch.xpack.esql.plan.physical.AggregateExec

org.elasticsearch.xpack.esql.plan.physical.TimeSeriesAggregateExec

All Implemented Interfaces:

NamedWriteable, Writeable, EstimatesRowSize

public class TimeSeriesAggregateExec
extends AggregateExec

An extension of Aggregate to perform time-series aggregation per time-series, such as rate or _over_time. The grouping must be `_tsid` and `tbucket` or just `_tsid`.

Nested Class Summary

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

Node.NodeStringFormat

Nested classes/interfaces inherited from interface org.elasticsearch.xpack.esql.plan.physical.EstimatesRowSize

EstimatesRowSize.State

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 NamedWriteableRegistry.Entry	ENTRY

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

TO_STRING_MAX_LINES, TO_STRING_MAX_WIDTH

Constructor Summary

Constructors

Constructor	Description
TimeSeriesAggregateExec(Source source, PhysicalPlan child, List<? extends Expression> groupings, List<? extends NamedExpression> aggregates, AggregatorMode mode, List<Attribute> intermediateAttributes, Integer estimatedRowSize, Bucket timeBucket)
TimeSeriesAggregateExec(Source source, PhysicalPlan child, List<? extends Expression> groupings, List<? extends NamedExpression> aggregates, AggregatorMode mode, List<Attribute> intermediateAttributes, Integer estimatedRowSize, Bucket timeBucket, Bucket outputTimeBucket)

Method Summary

Modifier and Type	Method	Description
String	getWriteableName()
protected NodeInfo<AggregateExec>	info()	Normally, you want to use one of the static create methods to implement this.
Bucket	outputTimeBucket()
Rounding.Prepared	outputTimeBucketRounding(FoldContext foldContext)
TimeSeriesAggregateExec	replaceChild(PhysicalPlan newChild)
Bucket	timeBucket()
Rounding.Prepared	timeBucketRounding(FoldContext foldContext)
AggregateExec	withAggregates(List<? extends NamedExpression> newAggregates)
protected AggregateExec	withEstimatedSize(int estimatedRowSize)
TimeSeriesAggregateExec	withMode(AggregatorMode newMode)
void	writeTo(StreamOutput out)

Methods inherited from class org.elasticsearch.xpack.esql.plan.physical.AggregateExec

aggregates, computeReferences, equals, estimatedRowSize, estimateRowSize, getMode, groupings, hashCode, intermediateAttributes, output

Methods inherited from class org.elasticsearch.xpack.esql.plan.physical.UnaryExec

child, inputSet, outputSet, replaceChildren

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

computeExpressions, 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

Field Details

ENTRY

public static final NamedWriteableRegistry.Entry ENTRY

Constructor Details

TimeSeriesAggregateExec

public TimeSeriesAggregateExec(Source source,
 PhysicalPlan child,
 List<? extends Expression> groupings,
 List<? extends NamedExpression> aggregates,
 AggregatorMode mode,
 List<Attribute> intermediateAttributes,
 Integer estimatedRowSize,
 Bucket timeBucket)

TimeSeriesAggregateExec

public TimeSeriesAggregateExec(Source source,
 PhysicalPlan child,
 List<? extends Expression> groupings,
 List<? extends NamedExpression> aggregates,
 AggregatorMode mode,
 List<Attribute> intermediateAttributes,
 Integer estimatedRowSize,
 Bucket timeBucket,
 Bucket outputTimeBucket)

Method Details

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Writeable

Overrides:

writeTo in class AggregateExec

Throws:

IOException

getWriteableName

public String getWriteableName()

Specified by:

getWriteableName in interface NamedWriteable

Overrides:

getWriteableName in class AggregateExec

info

protected NodeInfo<AggregateExec> 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.

Overrides:

info in class AggregateExec

replaceChild

public TimeSeriesAggregateExec replaceChild(PhysicalPlan newChild)

Overrides:

replaceChild in class AggregateExec

withAggregates

public AggregateExec withAggregates(List<? extends NamedExpression> newAggregates)

Overrides:

withAggregates in class AggregateExec

withMode

public TimeSeriesAggregateExec withMode(AggregatorMode newMode)

Overrides:

withMode in class AggregateExec

withEstimatedSize

protected AggregateExec withEstimatedSize(int estimatedRowSize)

Overrides:

withEstimatedSize in class AggregateExec

timeBucket

public Bucket timeBucket()

outputTimeBucket

public Bucket outputTimeBucket()

timeBucketRounding

public Rounding.Prepared timeBucketRounding(FoldContext foldContext)

outputTimeBucketRounding

public Rounding.Prepared outputTimeBucketRounding(FoldContext foldContext)