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

Class EsQueryExec

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

org.elasticsearch.xpack.esql.plan.physical.EsQueryExec

All Implemented Interfaces:

NamedWriteable, Writeable, EstimatesRowSize

public class EsQueryExec
extends LeafExec
implements EstimatesRowSize

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	EsQueryExec.Direction
static final record	EsQueryExec.FieldSort
static final record	EsQueryExec.GeoDistanceSort
static enum	EsQueryExec.Missing
static final record	EsQueryExec.QueryBuilderAndTags
static final record	EsQueryExec.ScoreSort
static interface	EsQueryExec.Sort

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 EsField	DOC_ID_FIELD
static final List<EsField>	TIME_SERIES_SOURCE_FIELDS

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

TO_STRING_MAX_WIDTH

Constructor Summary

Constructors

Constructor	Description
EsQueryExec(Source source, String indexPattern, IndexMode indexMode, List<Attribute> attrs, Expression limit, List<EsQueryExec.Sort> sorts, Integer estimatedRowSize, List<EsQueryExec.QueryBuilderAndTags> queryBuilderAndTags)

Method Summary

Modifier and Type	Method	Description
List<Attribute>	attrs()
boolean	canPushSorts()
boolean	canSubstituteRoundToWithQueryBuilderAndTags()
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()
boolean	hasScoring()
IndexMode	indexMode()
String	indexPattern()
protected NodeInfo<EsQueryExec>	info()	Normally, you want to use one of the static create methods to implement this.
static boolean	isDocAttribute(Attribute attr)
Expression	limit()
String	nodeString()
List<Attribute>	output()	The ordered list of attributes (i.e.
QueryBuilder	query()	query is merged into queryBuilderAndTags, keep this method as it is called by many many places in both tests and product code.
List<EsQueryExec.QueryBuilderAndTags>	queryBuilderAndTags()
List<EsQueryExec.Sort>	sorts()
EsQueryExec	withLimit(Expression limit)
EsQueryExec	withQuery(QueryBuilder query)	query is merged into queryBuilderAndTags, keep this method as it is called by too many places.
EsQueryExec	withSorts(List<EsQueryExec.Sort> sorts)
void	writeTo(StreamOutput out)

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

computeReferences, replaceChildren

Methods inherited from class org.elasticsearch.xpack.esql.plan.QueryPlan

computeExpressions, expressions, forEachExpression, forEachExpression, forEachExpressionDown, forEachExpressionUp, inputSet, outputSet, references, transformExpressionsDown, transformExpressionsDown, transformExpressionsOnly, transformExpressionsOnly, transformExpressionsOnlyUp, transformExpressionsUp, transformExpressionsUp

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

anyMatch, children, collect, collect, collect, collectFirstChildren, collectLeaves, doCollectFirst, forEachDown, forEachDown, forEachDownMayReturnEarly, forEachProperty, forEachPropertyDown, forEachPropertyOnly, forEachPropertyUp, forEachUp, forEachUp, nodeName, nodeProperties, propertiesToString, replaceChildrenSameSize, source, sourceLocation, sourceText, toString, transformChildren, transformDown, transformDown, transformDown, transformNodeProps, transformPropertiesDown, transformPropertiesOnly, transformPropertiesUp, transformUp, transformUp, transformUp

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

DOC_ID_FIELD

public static final EsField DOC_ID_FIELD

TIME_SERIES_SOURCE_FIELDS

public static final List<EsField> TIME_SERIES_SOURCE_FIELDS

Constructor Details

EsQueryExec

public EsQueryExec(Source source,
 String indexPattern,
 IndexMode indexMode,
 List<Attribute> attrs,
 Expression limit,
 List<EsQueryExec.Sort> sorts,
 Integer estimatedRowSize,
 List<EsQueryExec.QueryBuilderAndTags> queryBuilderAndTags)

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

isDocAttribute

public static boolean isDocAttribute(Attribute attr)

hasScoring

public boolean hasScoring()

info

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

indexPattern

public String indexPattern()

indexMode

public IndexMode indexMode()

query

public QueryBuilder query()

query is merged into queryBuilderAndTags, keep this method as it is called by many many places in both tests and product code. If this method is called, the caller looks for the original queryBuilder, before ReplaceRoundToWithQueryAndTags converts it to multiple queries with tags.

output

public List<Attribute> output()

Description copied from class: QueryPlan

The ordered list of attributes (i.e. columns) this plan produces when executed. Must be called only on resolved plans, otherwise may throw an exception or return wrong results.

Specified by:

output in class QueryPlan<PhysicalPlan>

limit

public Expression limit()

sorts

public List<EsQueryExec.Sort> sorts()

attrs

public List<Attribute> attrs()

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

Returns:

withLimit

public EsQueryExec withLimit(Expression limit)

canPushSorts

public boolean canPushSorts()

withSorts

public EsQueryExec withSorts(List<EsQueryExec.Sort> sorts)

withQuery

public EsQueryExec withQuery(QueryBuilder query)

query is merged into queryBuilderAndTags, keep this method as it is called by too many places. If this method is called, the caller looks for the original queryBuilder, before ReplaceRoundToWithQueryAndTags converts it to multiple queries with tags.

queryBuilderAndTags

public List<EsQueryExec.QueryBuilderAndTags> queryBuilderAndTags()

canSubstituteRoundToWithQueryBuilderAndTags

public boolean canSubstituteRoundToWithQueryBuilderAndTags()

hashCode

public int hashCode()

Specified by:

hashCode in class PhysicalPlan

equals

public boolean equals(Object obj)

Specified by:

equals in class PhysicalPlan

nodeString

public String nodeString()

Overrides:

nodeString in class Node<PhysicalPlan>