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

Class TopNExec

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

All Implemented Interfaces:

NamedWriteable, Writeable, EstimatesRowSize

public class TopNExec
extends UnaryExec
implements EstimatesRowSize

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
TopNExec(Source source, PhysicalPlan child, List<Order> order, Expression limit, Integer estimatedRowSize)

Method Summary

Modifier and Type	Method	Description
Set<Attribute>	docValuesAttributes()
static TopNEncoder	encoder(DataType type, IndexedByShardId<? extends org.elasticsearch.core.RefCounted> shardContexts)	The encoder to use when a field is included in the sort.
boolean	equals(Object obj)
Integer	estimatedRowSize()	Estimate of the number of bytes that'll be loaded per position before the stream of pages is consumed.
PhysicalPlan	estimateRowSize(EstimatesRowSize.State state)	Estimate the number of bytes that'll be loaded per position before the stream of pages is consumed.
String	getWriteableName()
int	hashCode()
protected NodeInfo<TopNExec>	info()	Normally, you want to use one of the static create methods to implement this.
TopNOperator.InputOrdering	inputOrdering()
Expression	limit()
SharedMinCompetitive.Supplier	minCompetitive()
List<SharedMinCompetitive.KeyConfig>	minCompetitiveKeyConfig()
List<Order>	order()
TopNExec	replaceChild(PhysicalPlan newChild)
TopNExec	withDocValuesAttributes(Set<Attribute> docValuesAttributes)
TopNExec	withMinCompetitive(SharedMinCompetitive.Supplier minCompetitive)
TopNExec	withNonSortedInput()
TopNExec	withSortedInput()
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

TopNExec

public TopNExec(Source source,
 PhysicalPlan child,
 List<Order> order,
 Expression limit,
 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<TopNExec> 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 TopNExec replaceChild(PhysicalPlan newChild)

Specified by:

replaceChild in class UnaryExec

withDocValuesAttributes

public TopNExec withDocValuesAttributes(Set<Attribute> docValuesAttributes)

withSortedInput

public TopNExec withSortedInput()

withNonSortedInput

public TopNExec withNonSortedInput()

minCompetitive

public SharedMinCompetitive.Supplier minCompetitive()

minCompetitiveKeyConfig

public List<SharedMinCompetitive.KeyConfig> minCompetitiveKeyConfig()

withMinCompetitive

public TopNExec withMinCompetitive(SharedMinCompetitive.Supplier minCompetitive)

limit

public Expression limit()

order

public List<Order> order()

docValuesAttributes

public Set<Attribute> docValuesAttributes()

estimatedRowSize

public Integer estimatedRowSize()

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

estimateRowSize

public PhysicalPlan estimateRowSize(EstimatesRowSize.State state)

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

inputOrdering

public TopNOperator.InputOrdering inputOrdering()

encoder

public static TopNEncoder encoder(DataType type,
 IndexedByShardId<? extends org.elasticsearch.core.RefCounted> shardContexts)

The encoder to use when a field is included in the sort.

This is essentially one big switch statement on type. It intentionally doesn't have a default and shouldn't add one. We want to make sure that folks who add a new type think about sorting.

While a type is underConstruction its fine if the switch throws an IllegalStateException. But before the type is released we need to support the type.