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

Class ViewShadowRelation

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

All Implemented Interfaces:

NamedWriteable, Writeable, Resolvable, Unresolvable

public class ViewShadowRelation
extends LeafPlan
implements Unresolvable

Marker leaf node that represents a view-name being looked up on linked projects (CPS) as a potential remote index with the same name as a local view. It is emitted by ViewResolver (only when CPS is enabled) as a sibling of each resolved view's recursive substitution, inside the per-resolution-level ViewUnionAll.

Lifecycle, with the parts each PR is responsible for:

1. Emitted during view resolution alongside the strict (recursive) resolution. The shadow and its strict sibling form the strict/lenient pair for that level. (landed in the ViewResolver refactor)
2. ViewCompaction.preIndexResolution reshapes user-written Subquery/ UnionAll structures into ViewUnionAll but leaves shadows in place so PreAnalyzer can still pair each shadow with its sibling at index-resolution time. (landed)
3. PreAnalyzer collects ViewShadowRelation patterns into a separate set, and EsqlSession issues a lenient field-caps request per batch (ALLOW_UNAVAILABLE_TARGETS + project routing scoped to linked projects only — IndexResolver.FLAT_WORLD_OPTIONS). Results land in AnalyzerContext.optionalLinkedResolution, keyed by the shadow's full linkedIndexPattern() (view name + applicable exclusions). (deferred to the lenient field-caps PR)
4. The ResolveViewShadow analyzer rule (sibling of ResolveTable, in the Initialize batch) consults AnalyzerContext.optionalLinkedResolution for this shadow's linkedIndexPattern(). If a remote index is found the shadow is replaced with a corresponding EsRelation; otherwise the shadow is left unresolved. (this PR — backed by a mocked optionalLinkedResolution map until the lenient field-caps PR provides real data)
5. ViewCompactionPostIndexResolution runs after ResolveViewShadow: any still-unresolved shadow is stripped, then nested ViewUnionAlls are flattened and remaining NamedSubquery wrappers unwrapped. Per Strategy A in esql-planning#543, sibling EsRelations stay separate (a UnionAll/ViewUnionAll of EsRelations) rather than being merged via a third combined field-caps call. (landed)

The strict, default-options field-caps path on the local cluster keeps resolveViews(true) unchanged, so a remote project that has a view with the same name still fails the query with RemoteViewNotSupportedException. This node only enables lookup of remote indices with the same name as a local view.

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
ViewShadowRelation(Source source, String viewName, LinkedIndexPattern.Kind kind, String pattern)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
boolean	expressionsResolved()
String	getWriteableName()
int	hashCode()
protected NodeInfo<ViewShadowRelation>	info()	Normally, you want to use one of the static create methods to implement this.
LinkedIndexPattern	linkedIndexPattern()
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	toString()
String	unresolvedMessage()	NOTE: Any non-null return value from this method indicates that the item in question could not be resolved.
String	viewName()
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, 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

ViewShadowRelation

public ViewShadowRelation(Source source,
 String viewName,
 LinkedIndexPattern.Kind kind,
 String pattern)

Method Details

viewName

public String viewName()

linkedIndexPattern

public LinkedIndexPattern linkedIndexPattern()

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

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>