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

Class NamedSubquery

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

org.elasticsearch.xpack.esql.plan.logical.Subquery

org.elasticsearch.xpack.esql.plan.logical.NamedSubquery

All Implemented Interfaces:

NamedWriteable, Writeable, TelemetryAware, Resolvable, SortAgnostic

public class NamedSubquery
extends Subquery

A Subquery that carries the view name it was resolved from.

Unlike plain Subquery, the name participates in equals(java.lang.Object) and hashCode(), which allows Node.transformDown to distinguish a newly-tagged subquery from its untagged predecessor. After view resolution, a post-processing pass converts UnionAll nodes containing NamedSubquery children into ViewUnionAll.

This class should only be used during query re-writing and not survive in the final query plan. If we decide to keep named subqueries as a feature later, we should add serialization support.

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.plan.logical.Subquery

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
NamedSubquery(Source source, LogicalPlan subqueryPlan, String name)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
int	hashCode()
protected NodeInfo<NamedSubquery>	info()	Normally, you want to use one of the static create methods to implement this.
String	name()
void	nodeString(StringBuilder sb, Node.NodeStringFormat format)	Append this Node's string representation to sb.
UnaryPlan	replaceChild(LogicalPlan newChild)

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

expressionsResolved, getWriteableName, output, plan, writeTo

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

child, inputSet, outputSet, 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, computeReferences, expressions, forEachExpression, forEachExpression, forEachExpressionDown, forEachExpressionUp, 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.capabilities.TelemetryAware

telemetryLabel

Constructor Details

NamedSubquery

public NamedSubquery(Source source,
 LogicalPlan subqueryPlan,
 String name)

Method Details

name

public String name()

info

protected NodeInfo<NamedSubquery> 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.

Overrides:

info in class Subquery

replaceChild

public UnaryPlan replaceChild(LogicalPlan newChild)

Overrides:

replaceChild in class Subquery

hashCode

public int hashCode()

Overrides:

hashCode in class Subquery

equals

public boolean equals(Object obj)

Overrides:

equals in class Subquery

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 Subquery

Parameters:

sb - target for the string

format - configuration for rendering the string representation