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

Class SampledAggregate

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

org.elasticsearch.xpack.esql.plan.logical.SampledAggregate

All Implemented Interfaces:

NamedWriteable, Writeable, PostAnalysisVerificationAware, TelemetryAware, Resolvable, ExecutesOn, ExecutesOn.Coordinator, PipelineBreaker, SortAgnostic

public class SampledAggregate
extends Aggregate

Aggregate, which upon execution 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.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.xpack.esql.plan.logical.ExecutesOn

ExecutesOn.Coordinator, ExecutesOn.ExecuteLocation, ExecutesOn.Remote

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.plan.logical.Aggregate

aggregates, groupings, lazyOutput

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

TO_STRING_MAX_LINES, TO_STRING_MAX_WIDTH

Constructor Summary

Constructors

Constructor	Description
SampledAggregate(StreamInput in)
SampledAggregate(Source source, LogicalPlan child, List<Expression> groupings, List<? extends NamedExpression> aggregates, List<? extends NamedExpression> originalAggregates, Expression sampleProbability)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
String	getWriteableName()
int	hashCode()
protected NodeInfo<Aggregate>	info()	Normally, you want to use one of the static create methods to implement this.
List<? extends NamedExpression>	originalAggregates()
SampledAggregate	replaceChild(LogicalPlan newChild)
Expression	sampleProbability()
SampledAggregate	with(LogicalPlan child, List<Expression> newGroupings, List<? extends NamedExpression> newAggregates)
void	writeTo(StreamOutput out)

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

aggregates, checkTimeSeriesAggregates, computeReferences, computeReferences, expressionsResolved, groupings, output, output, postAnalysisVerification, telemetryLabel, with

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

Methods inherited from interface org.elasticsearch.xpack.esql.plan.logical.ExecutesOn.Coordinator

executesOn

Field Details

ENTRY

public static final NamedWriteableRegistry.Entry ENTRY

Constructor Details

SampledAggregate

public SampledAggregate(Source source,
 LogicalPlan child,
 List<Expression> groupings,
 List<? extends NamedExpression> aggregates,
 List<? extends NamedExpression> originalAggregates,
 Expression sampleProbability)

SampledAggregate

public SampledAggregate(StreamInput in)
                 throws IOException

Throws:

IOException

Method Details

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Writeable

Overrides:

writeTo in class Aggregate

Throws:

IOException

getWriteableName

public String getWriteableName()

Specified by:

getWriteableName in interface NamedWriteable

Overrides:

getWriteableName in class Aggregate

info

protected NodeInfo<Aggregate> 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 Aggregate

replaceChild

public SampledAggregate replaceChild(LogicalPlan newChild)

Overrides:

replaceChild in class Aggregate

with

public SampledAggregate with(LogicalPlan child,
 List<Expression> newGroupings,
 List<? extends NamedExpression> newAggregates)

Overrides:

with in class Aggregate

originalAggregates

public List<? extends NamedExpression> originalAggregates()

sampleProbability

public Expression sampleProbability()

hashCode

public int hashCode()

Overrides:

hashCode in class Aggregate

equals

public boolean equals(Object obj)

Overrides:

equals in class Aggregate