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

Class EsqlProject

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

org.elasticsearch.xpack.esql.plan.logical.local.EsqlProject

All Implemented Interfaces:

NamedWriteable, Writeable, Resolvable, SortAgnostic, SortPreserving, Streaming

Direct Known Subclasses:

ResolvingProject

public class EsqlProject
extends Project

A projection when first parsed, i.e. obtained from KEEP, DROP, RENAME. After the analysis step, we use Project.

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

Modifier and Type	Field	Description
static final NamedWriteableRegistry.Entry	ENTRY

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

TO_STRING_MAX_WIDTH

Constructor Summary

Constructors

Constructor	Description
EsqlProject(StreamInput in)
EsqlProject(Source source, LogicalPlan child, List<? extends NamedExpression> projections)

Method Summary

Modifier and Type	Method	Description
boolean	expressionsResolved()
String	getWriteableName()
protected NodeInfo<Project>	info()	Normally, you want to use one of the static create methods to implement this.
EsqlProject	replaceChild(LogicalPlan newChild)
Project	withProjections(List<? extends NamedExpression> projections)
void	writeTo(StreamOutput out)

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

equals, hashCode, output, projections, resolved

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

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

Field Details

ENTRY

public static final NamedWriteableRegistry.Entry ENTRY

Constructor Details

EsqlProject

public EsqlProject(Source source,
 LogicalPlan child,
 List<? extends NamedExpression> projections)

EsqlProject

public EsqlProject(StreamInput in)
            throws IOException

Throws:

IOException

Method Details

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Writeable

Overrides:

writeTo in class Project

Throws:

IOException

getWriteableName

public String getWriteableName()

Specified by:

getWriteableName in interface NamedWriteable

Overrides:

getWriteableName in class Project

info

protected NodeInfo<Project> 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 Project

replaceChild

public EsqlProject replaceChild(LogicalPlan newChild)

Overrides:

replaceChild in class Project

expressionsResolved

public boolean expressionsResolved()

Overrides:

expressionsResolved in class Project

withProjections

public Project withProjections(List<? extends NamedExpression> projections)

Overrides:

withProjections in class Project