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

Class EsRelation

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

org.elasticsearch.xpack.esql.plan.logical.EsRelation

All Implemented Interfaces:

NamedWriteable, Writeable, Resolvable

public class EsRelation
extends LeafPlan

Source representing an Elasticsearch index.

In FROM idx | ... this corresponds to the FROM.

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
EsRelation(Source source, String indexPattern, IndexMode indexMode, Map<String,List<String>> originalIndices, Map<String,List<String>> concreteIndices, Map<String,IndexMode> indexNameWithModes, List<Attribute> attributes)

Method Summary

Modifier and Type	Method	Description
Map<String,List<String>>	concreteIndices()
Set<String>	concreteQualifiedIndices()
boolean	equals(Object obj)
boolean	expressionsResolved()
String	getWriteableName()
int	hashCode()
IndexMode	indexMode()
Map<String,IndexMode>	indexNameWithModes()
String	indexPattern()
protected NodeInfo<EsRelation>	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.
Map<String,List<String>>	originalIndices()
List<Attribute>	output()	The ordered list of attributes (i.e.
EsRelation	withAdditionalAttribute(Attribute additionalAttribute)
EsRelation	withAttributes(List<Attribute> newAttributes)
EsRelation	withIndexMode(IndexMode indexMode)
void	writeTo(StreamOutput out)

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

computeReferences, 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, 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

Field Details

ENTRY

public static final NamedWriteableRegistry.Entry ENTRY

Constructor Details

EsRelation

public EsRelation(Source source,
 String indexPattern,
 IndexMode indexMode,
 Map<String,List<String>> originalIndices,
 Map<String,List<String>> concreteIndices,
 Map<String,IndexMode> indexNameWithModes,
 List<Attribute> attributes)

Method Details

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Throws:

IOException

getWriteableName

public String getWriteableName()

info

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

indexPattern

public String indexPattern()

indexMode

public IndexMode indexMode()

originalIndices

public Map<String,List<String>> originalIndices()

concreteIndices

public Map<String,List<String>> concreteIndices()

indexNameWithModes

public Map<String,IndexMode> indexNameWithModes()

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<LogicalPlan>

concreteQualifiedIndices

public Set<String> concreteQualifiedIndices()

expressionsResolved

public boolean expressionsResolved()

Specified by:

expressionsResolved in class LogicalPlan

hashCode

public int hashCode()

Specified by:

hashCode in class LogicalPlan

equals

public boolean equals(Object obj)

Specified by:

equals in class LogicalPlan

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<LogicalPlan>

Parameters:

sb - target for the string

format - configuration for rendering the string representation

withAttributes

public EsRelation withAttributes(List<Attribute> newAttributes)

withAdditionalAttribute

public EsRelation withAdditionalAttribute(Attribute additionalAttribute)

withIndexMode

public EsRelation withIndexMode(IndexMode indexMode)