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

Class UnresolvedRelation

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

All Implemented Interfaces:

NamedWriteable, Writeable, TelemetryAware, Resolvable, Unresolvable

public class UnresolvedRelation
extends LeafPlan
implements Unresolvable, TelemetryAware

Nested Class Summary

Nested classes/interfaces inherited from class org.elasticsearch.xpack.esql.plan.logical.LogicalPlan

LogicalPlan.Stage

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

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

TO_STRING_MAX_WIDTH

Fields inherited from interface org.elasticsearch.xpack.esql.core.capabilities.Unresolvable

UNRESOLVED_PREFIX

Constructor Summary

Constructors

Constructor	Description
UnresolvedRelation(Source source, IndexPattern indexPattern, boolean frozen, List<Attribute> metadataFields, String unresolvedMessage, SourceCommand sourceCommand)
UnresolvedRelation(Source source, IndexPattern table, boolean frozen, List<Attribute> metadataFields, IndexMode indexMode, String unresolvedMessage)
UnresolvedRelation(Source source, IndexPattern indexPattern, boolean frozen, List<Attribute> metadataFields, IndexMode indexMode, String unresolvedMessage, String commandName)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
boolean	expressionsResolved()
boolean	frozen()
String	getWriteableName()
int	hashCode()
IndexMode	indexMode()
IndexPattern	indexPattern()
protected NodeInfo<UnresolvedRelation>	info()	Normally, you want to use one of the static create methods to implement this.
boolean	isTimeSeriesMode()
List<Attribute>	metadataFields()
List<Object>	nodeProperties()	The values of all the properties that are important to this Node.
List<Attribute>	output()	The ordered list of attributes (i.e.
boolean	resolved()
String	telemetryLabel()	This is used by PlanTelemetry to collect query statistics It can return "FROM" if this a |FROM idx command "METRICS" if it is the result of a | METRICS idx some_aggs() BY fields command
String	toString()
String	unresolvedMessage()	NOTE: Any non-null return value from this method indicates that the item in question could not be resolved.
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, 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

anyMatch, children, collect, collect, collect, collectFirstChildren, collectLeaves, doCollectFirst, forEachDown, forEachDown, forEachDownMayReturnEarly, forEachProperty, forEachPropertyDown, forEachPropertyOnly, forEachPropertyUp, forEachUp, forEachUp, nodeName, nodeString, propertiesToString, replaceChildrenSameSize, source, sourceLocation, sourceText, 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

Constructor Details

UnresolvedRelation

public UnresolvedRelation(Source source,
 IndexPattern indexPattern,
 boolean frozen,
 List<Attribute> metadataFields,
 String unresolvedMessage,
 SourceCommand sourceCommand)

UnresolvedRelation

public UnresolvedRelation(Source source,
 IndexPattern indexPattern,
 boolean frozen,
 List<Attribute> metadataFields,
 IndexMode indexMode,
 String unresolvedMessage,
 @Nullable
 String commandName)

UnresolvedRelation

public UnresolvedRelation(Source source,
 IndexPattern table,
 boolean frozen,
 List<Attribute> metadataFields,
 IndexMode indexMode,
 String unresolvedMessage)

Method Details

writeTo

public void writeTo(StreamOutput out)

Specified by:

writeTo in interface Writeable

getWriteableName

public String getWriteableName()

Specified by:

getWriteableName in interface NamedWriteable

info

protected NodeInfo<UnresolvedRelation> 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 IndexPattern indexPattern()

frozen

public boolean frozen()

resolved

public boolean resolved()

Specified by:

resolved in interface Resolvable

Specified by:

resolved in interface Unresolvable

Overrides:

resolved in class LogicalPlan

telemetryLabel

public String telemetryLabel()

This is used by PlanTelemetry to collect query statistics It can return

• "FROM" if this a |FROM idx command
• "METRICS" if it is the result of a | METRICS idx some_aggs() BY fields command

Specified by:

telemetryLabel in interface TelemetryAware

Returns:

the label reported in the telemetry data. Only needs to be overwritten if the label doesn't match the class name.

expressionsResolved

public boolean expressionsResolved()

Specified by:

expressionsResolved in class LogicalPlan

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>

metadataFields

public List<Attribute> metadataFields()

indexMode

public IndexMode indexMode()

unresolvedMessage

public String unresolvedMessage()

Description copied from interface: Unresolvable

NOTE: Any non-null return value from this method indicates that the item in question could not be resolved.

Specified by:

unresolvedMessage in interface Unresolvable

hashCode

public int hashCode()

Specified by:

hashCode in class LogicalPlan

equals

public boolean equals(Object obj)

Specified by:

equals in class LogicalPlan

nodeProperties

public List<Object> nodeProperties()

Description copied from class: Node

The values of all the properties that are important to this Node.

Overrides:

nodeProperties in class Node<LogicalPlan>

toString

public String toString()

Overrides:

toString in class Node<LogicalPlan>

isTimeSeriesMode

public boolean isTimeSeriesMode()

Returns:

true if and only if this relation is being loaded in "time series mode", which changes a number of behaviors in the planner.