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

Class ParameterizedQueryExec

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

org.elasticsearch.xpack.esql.plan.physical.ParameterizedQueryExec

All Implemented Interfaces:

NamedWriteable, Writeable

public class ParameterizedQueryExec
extends LeafExec

Physical plan node representing a lookup source operation. This represents the source of a lookup query before conversion to operators. The QueryList is created later during operator creation from a factory and will receive the Page to operate on in the runtime when we call queryList.getQuery(position, inputPage).

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.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

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

TO_STRING_MAX_LINES, TO_STRING_MAX_WIDTH

Constructor Summary

Constructors

Constructor	Description
ParameterizedQueryExec(Source source, List<Attribute> output, List<MatchConfig> matchFields, Expression joinOnConditions, QueryBuilder query)
ParameterizedQueryExec(Source source, List<Attribute> output, List<MatchConfig> matchFields, Expression joinOnConditions, QueryBuilder query, boolean emptyResult)

Method Summary

Modifier and Type	Method	Description
boolean	emptyResult()
boolean	equals(Object o)
String	getWriteableName()
int	hashCode()
protected NodeInfo<ParameterizedQueryExec>	info()	Normally, you want to use one of the static create methods to implement this.
Expression	joinOnConditions()
List<MatchConfig>	matchFields()
List<Attribute>	output()	The ordered list of attributes (i.e.
QueryBuilder	query()
ParameterizedQueryExec	withQuery(QueryBuilder query)
void	writeTo(StreamOutput out)

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

computeReferences, replaceChildren

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

Constructor Details

ParameterizedQueryExec

public ParameterizedQueryExec(Source source,
 List<Attribute> output,
 List<MatchConfig> matchFields,
 @Nullable
 Expression joinOnConditions,
 @Nullable
 QueryBuilder query)

ParameterizedQueryExec

public ParameterizedQueryExec(Source source,
 List<Attribute> output,
 List<MatchConfig> matchFields,
 @Nullable
 Expression joinOnConditions,
 @Nullable
 QueryBuilder query,
 boolean emptyResult)

Method Details

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

matchFields

public List<MatchConfig> matchFields()

joinOnConditions

@Nullable
public Expression joinOnConditions()

query

@Nullable
public QueryBuilder query()

emptyResult

public boolean emptyResult()

withQuery

public ParameterizedQueryExec withQuery(QueryBuilder query)

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Throws:

IOException

getWriteableName

public String getWriteableName()

info

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

equals

public boolean equals(Object o)

Specified by:

equals in class PhysicalPlan

hashCode

public int hashCode()

Specified by:

hashCode in class PhysicalPlan