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

Class ParameterizedQuery

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

All Implemented Interfaces:

NamedWriteable, Writeable, Resolvable

public class ParameterizedQuery
extends LeafPlan

Logical plan node representing a parameterized lookup query source. This replaces EsRelation in the lookup node's logical plan, representing a source that receives input pages (match keys) from the exchange and generates parameterized queries against the lookup index.

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

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

TO_STRING_MAX_LINES, TO_STRING_MAX_WIDTH

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
boolean	emptyResult()
boolean	equals(Object obj)
boolean	expressionsResolved()
String	getWriteableName()
int	hashCode()
protected NodeInfo<ParameterizedQuery>	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.
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

Field Details

ENTRY

public static final NamedWriteableRegistry.Entry ENTRY

Constructor Details

ParameterizedQuery

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

ParameterizedQuery

public ParameterizedQuery(Source source,
 List<Attribute> output,
 List<MatchConfig> matchFields,
 @Nullable
 Expression joinOnConditions,
 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<LogicalPlan>

matchFields

public List<MatchConfig> matchFields()

joinOnConditions

@Nullable
public Expression joinOnConditions()

emptyResult

public boolean emptyResult()

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Throws:

IOException

getWriteableName

public String getWriteableName()

expressionsResolved

public boolean expressionsResolved()

Specified by:

expressionsResolved in class LogicalPlan

info

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

hashCode

public int hashCode()

Specified by:

hashCode in class LogicalPlan

equals

public boolean equals(Object obj)

Specified by:

equals in class LogicalPlan