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

Class UnresolvedExternalRelation

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

All Implemented Interfaces:

NamedWriteable, Writeable, Resolvable, Unresolvable

public class UnresolvedExternalRelation
extends LeafPlan
implements Unresolvable

Represents an unresolved external data source reference (Iceberg table or Parquet file). This plan node is created by the parser and later resolved by the analyzer using metadata from ExternalSourceResolver.

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 inherited from class org.elasticsearch.xpack.esql.core.tree.Node

TO_STRING_MAX_LINES, TO_STRING_MAX_WIDTH

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

UNRESOLVED_PREFIX

Constructor Summary

Constructors

Constructor	Description
UnresolvedExternalRelation(Source source, Expression tablePath, Map<String,Expression> params)	Creates an unresolved external relation.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
boolean	expressionsResolved()
String	getWriteableName()
int	hashCode()
protected NodeInfo<UnresolvedExternalRelation>	info()	Normally, you want to use one of the static create methods to implement this.
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.
Map<String,Expression>	params()
boolean	resolved()
Expression	tablePath()
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

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

Constructor Details

UnresolvedExternalRelation

public UnresolvedExternalRelation(Source source,
 Expression tablePath,
 Map<String,Expression> params)

Creates an unresolved external relation.

Parameters:

source - the source location in the query

tablePath - the S3 path or external table identifier (can be a Literal or parameter reference)

params - additional parameters (e.g., S3 credentials, options)

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

tablePath

public Expression tablePath()

params

public Map<String,Expression> params()

resolved

public boolean resolved()

Specified by:

resolved in interface Resolvable

Specified by:

resolved in interface Unresolvable

Overrides:

resolved in class LogicalPlan

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>

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>