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

Class EsSourceExec

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

All Implemented Interfaces:

NamedWriteable, Writeable, DataSourceExec

public class EsSourceExec
extends LeafExec
implements DataSourceExec

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.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
EsSourceExec(Source source, String indexPattern, IndexMode indexMode, List<Attribute> attributes, QueryBuilder query)
EsSourceExec(EsRelation relation)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
String	getWriteableName()
int	hashCode()
IndexMode	indexMode()
String	indexPattern()
protected NodeInfo<? extends PhysicalPlan>	info()	Normally, you want to use one of the static create methods to implement this.
void	nodeString(StringBuilder sb, Node.NodeStringFormat format)	Append this Node's string representation to sb.
List<Attribute>	output()	The ordered list of attributes (i.e.
QueryBuilder	query()
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

allMatch, anyMatch, children, collect, collect, collect, collectFirstChildren, collectLeaves, doCollectFirst, forEachDown, forEachDown, forEachDownMayReturnEarly, forEachProperty, forEachPropertyDown, forEachPropertyOnly, forEachPropertyUp, forEachUp, forEachUp, nodeName, nodeProperties, 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.physical.DataSourceExec

source

Field Details

ENTRY

public static final NamedWriteableRegistry.Entry ENTRY

Constructor Details

EsSourceExec

public EsSourceExec(EsRelation relation)

EsSourceExec

public EsSourceExec(Source source,
 String indexPattern,
 IndexMode indexMode,
 List<Attribute> attributes,
 QueryBuilder query)

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

indexPattern

public String indexPattern()

indexMode

public IndexMode indexMode()

query

public QueryBuilder query()

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 interface DataSourceExec

Specified by:

output in class QueryPlan<PhysicalPlan>

info

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

hashCode

public int hashCode()

Specified by:

hashCode in class PhysicalPlan

equals

public boolean equals(Object obj)

Specified by:

equals in class PhysicalPlan

nodeString

public void nodeString(StringBuilder sb,
 Node.NodeStringFormat format)

Description copied from class: Node

Append this Node's string representation to sb. This does not include this node's Node.children().

Overrides:

nodeString in class Node<PhysicalPlan>

Parameters:

sb - target for the string

format - configuration for rendering the string representation