Package org.elasticsearch.xpack.esql.plan.physical

Class CompoundOutputEvalExec

java.lang.Object

org.elasticsearch.xpack.esql.core.tree.Node<PhysicalPlan>

org.elasticsearch.xpack.esql.plan.QueryPlan<PhysicalPlan>

org.elasticsearch.xpack.esql.plan.physical.PhysicalPlan

org.elasticsearch.xpack.esql.plan.physical.UnaryExec

org.elasticsearch.xpack.esql.plan.physical.CompoundOutputEvalExec

All Implemented Interfaces:

NamedWriteable, Writeable, EstimatesRowSize

Direct Known Subclasses:

RegisteredDomainExec, UriPartsExec, UserAgentExec

public abstract class CompoundOutputEvalExec
extends UnaryExec
implements EstimatesRowSize

Abstract base class for physical plans that produce compound outputs from a single input.

Nested Class Summary

Nested classes/interfaces inherited from class org.elasticsearch.xpack.esql.core.tree.Node

Node.NodeStringFormat

Nested classes/interfaces inherited from interface org.elasticsearch.xpack.esql.plan.physical.EstimatesRowSize

EstimatesRowSize.State

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
protected final Expression	input	The input by which the evaluation is performed.

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

TO_STRING_MAX_LINES, TO_STRING_MAX_WIDTH

Constructor Summary

Constructors

Constructor	Description
CompoundOutputEvalExec(StreamInput in)
CompoundOutputEvalExec(Source source, PhysicalPlan child, Expression input, List<String> outputFieldNames, List<Attribute> outputFieldAttributes)

Method Summary

Modifier and Type	Method	Description
protected AttributeSet	computeReferences()	This very likely needs to be overridden for QueryPlan.references() to be correct when inheriting.
abstract CompoundOutputEvalExec	createNewInstance(Source source, PhysicalPlan child, Expression input, List<String> outputFieldNames, List<Attribute> outputFields)	Creates a new instance of the specific CompoundOutputEvalExec subclass with the provided parameters.
boolean	equals(Object o)
PhysicalPlan	estimateRowSize(EstimatesRowSize.State state)	Estimate the number of bytes that'll be loaded per position before the stream of pages is consumed.
int	hashCode()
protected NodeInfo<? extends PhysicalPlan>	info()	Normally, you want to use one of the static create methods to implement this.
protected abstract boolean	innerEquals(CompoundOutputEvalExec other)
protected abstract int	innerHashCode()
Expression	input()
List<Attribute>	output()	The ordered list of attributes (i.e.
List<Attribute>	outputFieldAttributes()
List<String>	outputFieldNames()
UnaryExec	replaceChild(PhysicalPlan newChild)
void	writeTo(StreamOutput out)

Methods inherited from class org.elasticsearch.xpack.esql.plan.physical.UnaryExec

child, inputSet, outputSet, replaceChildren

Methods inherited from class org.elasticsearch.xpack.esql.plan.QueryPlan

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

Methods inherited from interface org.elasticsearch.common.io.stream.NamedWriteable

getWriteableName

Field Details

input

protected final Expression input

The input by which the evaluation is performed.

Constructor Details

CompoundOutputEvalExec

public CompoundOutputEvalExec(Source source,
 PhysicalPlan child,
 Expression input,
 List<String> outputFieldNames,
 List<Attribute> outputFieldAttributes)

CompoundOutputEvalExec

public CompoundOutputEvalExec(StreamInput in)
                       throws IOException

Throws:

IOException

Method Details

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Writeable

Throws:

IOException

createNewInstance

public abstract CompoundOutputEvalExec createNewInstance(Source source,
 PhysicalPlan child,
 Expression input,
 List<String> outputFieldNames,
 List<Attribute> outputFields)

Creates a new instance of the specific CompoundOutputEvalExec subclass with the provided parameters.

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 UnaryExec

computeReferences

protected AttributeSet computeReferences()

Description copied from class: QueryPlan

This very likely needs to be overridden for QueryPlan.references() to be correct when inheriting. This can be called on unresolved plans and therefore must not rely on calls to QueryPlan.output().

Overrides:

computeReferences in class QueryPlan<PhysicalPlan>

input

public Expression input()

outputFieldNames

public List<String> outputFieldNames()

outputFieldAttributes

public List<Attribute> outputFieldAttributes()

estimateRowSize

public PhysicalPlan estimateRowSize(EstimatesRowSize.State state)

Description copied from interface: EstimatesRowSize

Estimate the number of bytes that'll be loaded per position before the stream of pages is consumed.

Specified by:

estimateRowSize in interface EstimatesRowSize

replaceChild

public UnaryExec replaceChild(PhysicalPlan newChild)

Specified by:

replaceChild in class UnaryExec

info

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

innerEquals

protected abstract boolean innerEquals(CompoundOutputEvalExec other)

equals

public boolean equals(Object o)

Overrides:

equals in class UnaryExec

innerHashCode

protected abstract int innerHashCode()

hashCode

public int hashCode()

Overrides:

hashCode in class UnaryExec