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

Class TopNBy

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

All Implemented Interfaces:

NamedWriteable, Writeable, Resolvable, PipelineBreaker

public class TopNBy
extends UnaryPlan
implements PipelineBreaker

Logical plan node for SORT order1, order2 | LIMIT N BY grouping1, grouping2, .... Sorts the input rows retaining at most N rows per group defined by the grouping expressions.

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.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
TopNBy(Source source, LogicalPlan child, List<Order> order, Expression limitPerGroup, List<Expression> groupings)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
boolean	expressionsResolved()
String	getWriteableName()
List<Expression>	groupings()
int	hashCode()
protected NodeInfo<TopNBy>	info()	Normally, you want to use one of the static create methods to implement this.
Expression	limitPerGroup()
List<Order>	order()
TopNBy	replaceChild(LogicalPlan newChild)
void	writeTo(StreamOutput out)

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

child, inputSet, output, 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

Field Details

ENTRY

public static final NamedWriteableRegistry.Entry ENTRY

Constructor Details

TopNBy

public TopNBy(Source source,
 LogicalPlan child,
 List<Order> order,
 Expression limitPerGroup,
 List<Expression> groupings)

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

expressionsResolved

public boolean expressionsResolved()

Specified by:

expressionsResolved in class LogicalPlan

info

protected NodeInfo<TopNBy> 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 TopNBy replaceChild(LogicalPlan newChild)

Specified by:

replaceChild in class UnaryPlan

limitPerGroup

public Expression limitPerGroup()

order

public List<Order> order()

groupings

public List<Expression> groupings()

hashCode

public int hashCode()

Overrides:

hashCode in class UnaryPlan

equals

public boolean equals(Object obj)

Overrides:

equals in class UnaryPlan