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

Class SampledAggregateExec

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

All Implemented Interfaces:

NamedWriteable, Writeable, EstimatesRowSize

public class SampledAggregateExec
extends AggregateExec

Aggregate, which is either:

• sampled with the sampleProbability for fast execution; or
• replaced by an exact aggregate if the originalAggregates can be pushed down to Lucene.

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
SampledAggregateExec(Source source, PhysicalPlan child, List<? extends Expression> groupings, List<? extends NamedExpression> aggregates, List<? extends NamedExpression> originalAggregates, Expression sampleProbability, AggregatorMode mode, List<Attribute> intermediateAttributes, List<Attribute> originalIntermediateAttributes, Integer estimatedRowSize)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
String	getWriteableName()
int	hashCode()
protected NodeInfo<AggregateExec>	info()	Normally, you want to use one of the static create methods to implement this.
List<? extends NamedExpression>	originalAggregates()
List<Attribute>	originalIntermediateAttributes()
SampledAggregateExec	replaceChild(PhysicalPlan newChild)
Expression	sampleProbability()
AggregateExec	withAggregates(List<? extends NamedExpression> newAggregates)
protected AggregateExec	withEstimatedSize(int estimatedRowSize)
SampledAggregateExec	withMode(AggregatorMode newMode)
void	writeTo(StreamOutput out)

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

aggregates, computeReferences, estimatedRowSize, estimateRowSize, getMode, groupings, 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

SampledAggregateExec

public SampledAggregateExec(Source source,
 PhysicalPlan child,
 List<? extends Expression> groupings,
 List<? extends NamedExpression> aggregates,
 List<? extends NamedExpression> originalAggregates,
 Expression sampleProbability,
 AggregatorMode mode,
 List<Attribute> intermediateAttributes,
 List<Attribute> originalIntermediateAttributes,
 Integer estimatedRowSize)

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 SampledAggregateExec replaceChild(PhysicalPlan newChild)

Overrides:

replaceChild in class AggregateExec

withAggregates

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

Overrides:

withAggregates in class AggregateExec

withMode

public SampledAggregateExec withMode(AggregatorMode newMode)

Overrides:

withMode in class AggregateExec

withEstimatedSize

protected AggregateExec withEstimatedSize(int estimatedRowSize)

Overrides:

withEstimatedSize in class AggregateExec

originalAggregates

public List<? extends NamedExpression> originalAggregates()

sampleProbability

public Expression sampleProbability()

originalIntermediateAttributes

public List<Attribute> originalIntermediateAttributes()

equals

public boolean equals(Object obj)

Overrides:

equals in class AggregateExec

hashCode

public int hashCode()

Overrides:

hashCode in class AggregateExec