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

Class Explain

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

All Implemented Interfaces:

NamedWriteable, Writeable, TelemetryAware, Resolvable

public class Explain
extends LeafPlan
implements TelemetryAware

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	Explain.Type

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 List<Attribute>	OUTPUT_ATTRIBUTES	Output columns for EXPLAIN command.

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

TO_STRING_MAX_LINES, TO_STRING_MAX_WIDTH

Constructor Summary

Constructors

Constructor	Description
Explain(Source source, LogicalPlan query)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
boolean	expressionsResolved()
String	getWriteableName()
int	hashCode()
protected NodeInfo<? extends LogicalPlan>	info()	Normally, you want to use one of the static create methods to implement this.
List<Attribute>	output()	The ordered list of attributes (i.e.
LogicalPlan	query()
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, 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

Field Details

OUTPUT_ATTRIBUTES

public static final List<Attribute> OUTPUT_ATTRIBUTES

Output columns for EXPLAIN command. - cluster: the cluster alias (empty string for local cluster) - node: the node name where the plan runs - role: coordinator, data, or subplan - type: the plan type (parsedPlan, optimizedLogicalPlan, optimizedPhysicalPlan, localPlan) - plan: the plan string representation

Constructor Details

Explain

public Explain(Source source,
 LogicalPlan query)

Method Details

writeTo

public void writeTo(StreamOutput out)

Specified by:

writeTo in interface Writeable

getWriteableName

public String getWriteableName()

Specified by:

getWriteableName in interface NamedWriteable

query

public LogicalPlan query()

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>

expressionsResolved

public boolean expressionsResolved()

Specified by:

expressionsResolved in class LogicalPlan

info

protected NodeInfo<? extends LogicalPlan> 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>

equals

public boolean equals(Object o)

Specified by:

equals in class LogicalPlan

hashCode

public int hashCode()

Specified by:

hashCode in class LogicalPlan