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

Class BulkLookupMvFilterExec

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

All Implemented Interfaces:

NamedWriteable, Writeable

public class BulkLookupMvFilterExec
extends UnaryExec

Physical plan node inserted in a LOOKUP JOIN plan by LuceneBulkLookup when it decides to use the bulk lookup optimization which directly reads docids for terms instead of issuing Lucene queries.

Directly reading the docids that way is fast but does not give the correct result when multivalues are present, so we use this node to direct the LookupExecutionPlanner to use an operator factory producing a filter that uses BulkLookupSingleValued to ensure false-positive multivalue matches are replaced by null in the final result.

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
BulkLookupMvFilterExec(Source source, PhysicalPlan child, Attribute field)

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.
boolean	equals(Object obj)
Attribute	field()
String	getWriteableName()
int	hashCode()
protected NodeInfo<BulkLookupMvFilterExec>	info()	Normally, you want to use one of the static create methods to implement this.
BulkLookupMvFilterExec	replaceChild(PhysicalPlan newChild)
void	writeTo(StreamOutput out)

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

child, inputSet, output, 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, 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

BulkLookupMvFilterExec

public BulkLookupMvFilterExec(Source source,
 PhysicalPlan child,
 Attribute field)

Method Details

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Throws:

IOException

getWriteableName

public String getWriteableName()

info

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

replaceChild

public BulkLookupMvFilterExec replaceChild(PhysicalPlan newChild)

Specified by:

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

field

public Attribute field()

hashCode

public int hashCode()

Overrides:

hashCode in class UnaryExec

equals

public boolean equals(Object obj)

Overrides:

equals in class UnaryExec