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

Class Project

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

All Implemented Interfaces:

NamedWriteable, Writeable, Resolvable, SortAgnostic, SortPreserving, Streaming

Direct Known Subclasses:

Keep, ResolvingProject

public class Project
extends UnaryPlan
implements Streaming, SortAgnostic, SortPreserving

Remove, duplicate or rename columns.

In FROM idx | KEEP x, y, the KEEP command is a Project. But it can also stand for DROP and RENAME, or a mix of all of them (after optimization).

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

Modifier and Type	Field	Description
static final NamedWriteableRegistry.Entry	ENTRY
static final NamedWriteableRegistry.Entry	V9_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
Project(Source source, LogicalPlan child, List<? extends NamedExpression> projections)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
boolean	expressionsResolved()
String	getWriteableName()
int	hashCode()
protected NodeInfo<Project>	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.
List<? extends NamedExpression>	projections()
Project	replaceChild(LogicalPlan newChild)
boolean	resolved()
Project	withProjections(List<? extends NamedExpression> projections)
void	writeTo(StreamOutput out)

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

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

Field Details

ENTRY

public static final NamedWriteableRegistry.Entry ENTRY

V9_ENTRY

public static final NamedWriteableRegistry.Entry V9_ENTRY

Constructor Details

Project

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

Method Details

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Writeable

Throws:

IOException

getWriteableName

public String getWriteableName()

Specified by:

getWriteableName in interface NamedWriteable

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.

Specified by:

info in class Node<LogicalPlan>

replaceChild

public Project replaceChild(LogicalPlan newChild)

Specified by:

replaceChild in class UnaryPlan

projections

public List<? extends NamedExpression> projections()

withProjections

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

resolved

public boolean resolved()

Specified by:

resolved in interface Resolvable

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.

Overrides:

output in class UnaryPlan

hashCode

public int hashCode()

Overrides:

hashCode in class UnaryPlan

equals

public boolean equals(Object obj)

Overrides:

equals in class UnaryPlan