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

Class AntiJoin

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

org.elasticsearch.xpack.esql.plan.logical.join.Join

org.elasticsearch.xpack.esql.plan.logical.join.AbstractSubqueryJoin

org.elasticsearch.xpack.esql.plan.logical.join.AntiJoin

All Implemented Interfaces:

NamedWriteable, Writeable, PostAnalysisVerificationAware, PostOptimizationVerificationAware, Resolvable, ExecutesOn, ExecutesOn.Coordinator, SortAgnostic, SortPreserving

public class AntiJoin
extends AbstractSubqueryJoin

An anti join used to implement WHERE field NOT IN (subquery).

The dual of SemiJoin: it shares the AbstractSubqueryJoin dedup pipeline and only flips the hooks that distinguish NOT IN from IN — it uses JoinTypes.ANTI, wraps the inline filter in Not, keeps unmatched rows on the hash-join path (IS NULL on the sentinel), and short-circuits to Filter(FALSE) on any NULL right value.

Nested Class Summary

Nested classes/interfaces inherited from class org.elasticsearch.xpack.esql.plan.logical.join.AbstractSubqueryJoin

AbstractSubqueryJoin.LogicalPlanTuple

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.xpack.esql.plan.logical.ExecutesOn

ExecutesOn.Coordinator, ExecutesOn.ExecuteLocation, ExecutesOn.Remote

Nested classes/interfaces inherited from interface org.elasticsearch.xpack.esql.capabilities.PostOptimizationVerificationAware

PostOptimizationVerificationAware.CoordinatorOnly

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.plan.logical.join.Join

ENTRY, UNSUPPORTED_TYPES

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

TO_STRING_MAX_LINES, TO_STRING_MAX_WIDTH

Constructor Summary

Constructors

Constructor	Description
AntiJoin(Source source, LogicalPlan left, LogicalPlan right, List<Attribute> leftFields, List<Attribute> rightFields)
AntiJoin(Source source, LogicalPlan left, LogicalPlan right, JoinConfig config)

Method Summary

Modifier and Type	Method	Description
protected LogicalPlan	buildEmptyRightSidePlan(Source source)	Build the terminal plan when the right side has zero rows.
protected NodeInfo<Join>	info()	Normally, you want to use one of the static create methods to implement this.
Join	replaceChildren(LogicalPlan left, LogicalPlan right)
protected Expression	sentinelFilterCondition(Source source, Attribute sentinel)	Sentinel-column filter that drives the hash-join path.
protected boolean	shortCircuitOnAnyRightNull()	Whether any NULL on the right side makes the predicate non-TRUE for every left row.
protected Expression	wrapInExpression(Source source, Expression in)	Wraps the In expression built from the dedup keys for the inline-filter path.

Methods inherited from class org.elasticsearch.xpack.esql.plan.logical.join.AbstractSubqueryJoin

buildFilterPathPlan, buildHashJoinPathPlan, buildShortCircuitPlan, computeOutputExpressions, expressionsResolved, filterNullLeftKeysBeforeHashJoin, firstSubPlan, getWriteableName, inlineData, inListFromDedupKeys, isSubqueryJoinUnsupported, newMainPlan, postAnalysisVerification, writeTo

Methods inherited from class org.elasticsearch.xpack.esql.plan.logical.join.Join

computeOutputExpressions, config, equals, executesOn, getRightToSerialize, hashCode, isRemote, leftReferences, makeReference, output, postOptimizationVerification, resolved, rightOutputFields, rightReferences, withConfig

Methods inherited from class org.elasticsearch.xpack.esql.plan.logical.BinaryPlan

left, replaceChildren, replaceLeft, replaceRight, right

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, 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, 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.xpack.esql.plan.logical.ExecutesOn.Coordinator

executesOn

Methods inherited from interface org.elasticsearch.xpack.esql.capabilities.PostAnalysisVerificationAware

postAnalysisVerification

Constructor Details

AntiJoin

public AntiJoin(Source source,
 LogicalPlan left,
 LogicalPlan right,
 JoinConfig config)

AntiJoin

public AntiJoin(Source source,
 LogicalPlan left,
 LogicalPlan right,
 List<Attribute> leftFields,
 List<Attribute> rightFields)

Method Details

info

protected NodeInfo<Join> 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.

Overrides:

info in class Join

replaceChildren

public Join replaceChildren(LogicalPlan left,
 LogicalPlan right)

Overrides:

replaceChildren in class Join

buildEmptyRightSidePlan

protected LogicalPlan buildEmptyRightSidePlan(Source source)

Description copied from class: AbstractSubqueryJoin

Build the terminal plan when the right side has zero rows. x IN () ≡ FALSE for SEMI / MARK; x NOT IN () ≡ TRUE for ANTI. MarkJoin produces an Eval that sets the mark attribute to FALSE.

Specified by:

buildEmptyRightSidePlan in class AbstractSubqueryJoin

shortCircuitOnAnyRightNull

protected boolean shortCircuitOnAnyRightNull()

Description copied from class: AbstractSubqueryJoin

Whether any NULL on the right side makes the predicate non-TRUE for every left row. For ANTI (x NOT IN (..., NULL, ...)) this is always the case, so once AbstractSubqueryJoin.inlineData(org.elasticsearch.xpack.esql.plan.logical.join.AbstractSubqueryJoin, org.elasticsearch.xpack.esql.plan.logical.local.LocalRelation, int, org.elasticsearch.compute.data.BlockFactory, java.util.concurrent.atomic.AtomicReference<org.elasticsearch.compute.data.Page>) detects a NULL position in the BlockHash dedup output it short-circuits to Filter(FALSE). For SEMI the NULL stays in the dedup output for the filter path (x IN (a, b, NULL) ≡ x IN (a, b) under WHERE semantics) and is stripped before constructing the LocalRelation on the hash-join path. For MARK the rightHadNulls flag is forwarded to the hash-join path's CASE expression; the filter path uses the NULL position in the dedup output directly.

Overrides:

shortCircuitOnAnyRightNull in class AbstractSubqueryJoin

wrapInExpression

protected Expression wrapInExpression(Source source,
 Expression in)

Description copied from class: AbstractSubqueryJoin

Wraps the In expression built from the dedup keys for the inline-filter path. SEMI returns it as-is; ANTI wraps it in Not.

Overrides:

wrapInExpression in class AbstractSubqueryJoin

sentinelFilterCondition

protected Expression sentinelFilterCondition(Source source,
 Attribute sentinel)

Description copied from class: AbstractSubqueryJoin

Sentinel-column filter that drives the hash-join path. SEMI keeps matched rows (IS NOT NULL on the sentinel); ANTI keeps unmatched rows (IS NULL).

Overrides:

sentinelFilterCondition in class AbstractSubqueryJoin