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

Class LimitByExec

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

All Implemented Interfaces:

NamedWriteable, Writeable, EstimatesRowSize

public class LimitByExec
extends UnaryExec
implements EstimatesRowSize

Physical plan node for LIMIT N BY expr1, expr2, .... Retains at most N rows per group defined by the grouping expressions.

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
LimitByExec(Source source, PhysicalPlan child, Expression limitPerGroup, List<Expression> groupings, Integer estimatedRowSize)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
Integer	estimatedRowSize()
PhysicalPlan	estimateRowSize(EstimatesRowSize.State unused)	Estimate the number of bytes that'll be loaded per position before the stream of pages is consumed.
String	getWriteableName()
List<Expression>	groupings()
int	hashCode()
protected NodeInfo<? extends LimitByExec>	info()	Normally, you want to use one of the static create methods to implement this.
Expression	limitPerGroup()
LimitByExec	replaceChild(PhysicalPlan newChild)
void	writeTo(StreamOutput out)

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

child, inputSet, output, outputSet, replaceChildren

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

Field Details

ENTRY

public static final NamedWriteableRegistry.Entry ENTRY

Constructor Details

LimitByExec

public LimitByExec(Source source,
 PhysicalPlan child,
 Expression limitPerGroup,
 List<Expression> groupings,
 Integer estimatedRowSize)

Method Details

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Writeable

Throws:

IOException

getWriteableName

public String getWriteableName()

Specified by:

getWriteableName in interface NamedWriteable

info

protected NodeInfo<? extends LimitByExec> 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<PhysicalPlan>

replaceChild

public LimitByExec replaceChild(PhysicalPlan newChild)

Specified by:

replaceChild in class UnaryExec

limitPerGroup

public Expression limitPerGroup()

groupings

public List<Expression> groupings()

estimatedRowSize

public Integer estimatedRowSize()

estimateRowSize

public PhysicalPlan estimateRowSize(EstimatesRowSize.State unused)

Description copied from interface: EstimatesRowSize

Estimate the number of bytes that'll be loaded per position before the stream of pages is consumed.

Specified by:

estimateRowSize in interface EstimatesRowSize

hashCode

public int hashCode()

Overrides:

hashCode in class UnaryExec

equals

public boolean equals(Object obj)

Overrides:

equals in class UnaryExec