Package org.elasticsearch.xpack.esql.expression.predicate.operator.comparison

Class Equals

java.lang.Object

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

org.elasticsearch.xpack.esql.core.expression.Expression

org.elasticsearch.xpack.esql.core.expression.function.Function

org.elasticsearch.xpack.esql.core.expression.function.scalar.ScalarFunction

org.elasticsearch.xpack.esql.core.expression.function.scalar.BinaryScalarFunction

org.elasticsearch.xpack.esql.core.expression.predicate.BinaryPredicate<Object,Object,Boolean,BinaryComparisonOperation>

org.elasticsearch.xpack.esql.core.expression.predicate.BinaryOperator<Object,Object,Boolean,BinaryComparisonOperation>

org.elasticsearch.xpack.esql.core.expression.predicate.operator.comparison.BinaryComparison

org.elasticsearch.xpack.esql.expression.predicate.operator.comparison.EsqlBinaryComparison

org.elasticsearch.xpack.esql.expression.predicate.operator.comparison.Equals

All Implemented Interfaces:

NamedWriteable, Writeable, TranslationAware, TranslationAware.SingleValueTranslationAware, Resolvable, Negatable<EsqlBinaryComparison>, EvaluatorMapper

public class Equals
extends EsqlBinaryComparison
implements Negatable<EsqlBinaryComparison>

Nested Class Summary

Nested classes/interfaces inherited from class org.elasticsearch.xpack.esql.expression.predicate.operator.comparison.EsqlBinaryComparison

EsqlBinaryComparison.BinaryComparisonOperation, EsqlBinaryComparison.BinaryOperatorConstructor

Nested classes/interfaces inherited from class org.elasticsearch.xpack.esql.core.expression.Expression

Expression.TypeResolution

Nested classes/interfaces inherited from interface org.elasticsearch.xpack.esql.evaluator.mapper.EvaluatorMapper

EvaluatorMapper.ToEvaluator

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

TranslationAware.FinishedTranslatable, TranslationAware.SingleValueTranslationAware, TranslationAware.Translatable

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.expression.function.scalar.ScalarFunction

MAX_BYTES_REF_RESULT_SIZE

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

TO_STRING_MAX_WIDTH

Constructor Summary

Constructors

Constructor	Description
Equals(Source source, Expression left, Expression right)
Equals(Source source, Expression left, Expression right, ZoneId zoneId)

Method Summary

Modifier and Type	Method	Description
Query	asQuery(LucenePushdownPredicates pushdownPredicates, TranslatorHandler handler)	This method is responsible for pushing the ES|QL Binary Comparison operators into Lucene.
String	getWriteableName()
protected NodeInfo<Equals>	info()	Normally, you want to use one of the static create methods to implement this.
EsqlBinaryComparison	negate()
protected Equals	replaceChildren(Expression newLeft, Expression newRight)
EsqlBinaryComparison	reverse()	Reverses the direction of this comparison on the comparison axis.
Equals	swapLeftAndRight()
TranslationAware.Translatable	translatable(LucenePushdownPredicates pushdownPredicates)	Can this instance be translated or not? Usually checks whether the expression arguments are actual fields that exist in Lucene.

Methods inherited from class org.elasticsearch.xpack.esql.expression.predicate.operator.comparison.EsqlBinaryComparison

checkCompatibility, fold, formatIncompatibleTypesMessage, getFunctionType, readFrom, resolveInputType, resolveType, singleValueField, toEvaluator, writeTo

Methods inherited from class org.elasticsearch.xpack.esql.core.expression.predicate.operator.comparison.BinaryComparison

compare, dataType, zoneId

Methods inherited from class org.elasticsearch.xpack.esql.core.expression.predicate.BinaryOperator

canonicalize, collectCommutative, isCommutative

Methods inherited from class org.elasticsearch.xpack.esql.core.expression.predicate.BinaryPredicate

equals, function, hashCode, nodeString, symbol

Methods inherited from class org.elasticsearch.xpack.esql.core.expression.function.scalar.BinaryScalarFunction

foldable, left, replaceChildren, right

Methods inherited from class org.elasticsearch.xpack.esql.core.expression.function.Function

arguments, functionName, nullable

Methods inherited from class org.elasticsearch.xpack.esql.core.expression.Expression

canonical, childrenResolved, propertiesToString, references, resolved, semanticEquals, semanticHash, toString, typeResolved

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

anyMatch, children, collect, collect, collect, collectFirstChildren, collectLeaves, doCollectFirst, forEachDown, forEachDown, forEachDownMayReturnEarly, forEachProperty, forEachPropertyDown, forEachPropertyOnly, forEachPropertyUp, forEachUp, forEachUp, nodeName, nodeProperties, replaceChildrenSameSize, source, sourceLocation, sourceText, transformChildren, transformDown, transformDown, transformDown, 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.evaluator.mapper.EvaluatorMapper

fold

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

asLuceneQuery

Field Details

ENTRY

public static final NamedWriteableRegistry.Entry ENTRY

Constructor Details

Equals

public Equals(Source source,
 Expression left,
 Expression right)

Equals

public Equals(Source source,
 Expression left,
 Expression right,
 ZoneId zoneId)

Method Details

translatable

public TranslationAware.Translatable translatable(LucenePushdownPredicates pushdownPredicates)

Description copied from interface: TranslationAware

Can this instance be translated or not? Usually checks whether the expression arguments are actual fields that exist in Lucene. See TranslationAware.Translatable for precisely what can be signaled from this method.

Specified by:

translatable in interface TranslationAware

Overrides:

translatable in class EsqlBinaryComparison

asQuery

public Query asQuery(LucenePushdownPredicates pushdownPredicates,
 TranslatorHandler handler)

Description copied from class: EsqlBinaryComparison

This method is responsible for pushing the ES|QL Binary Comparison operators into Lucene. It covers:

• Equals
• NotEquals
• GreaterThanOrEqual
• GreaterThan
• LessThanOrEqual
• LessThan

In general, we are able to push these down when one of the arguments is a constant (i.e. is foldable). This class assumes that an earlier pass through the query has rearranged things so that the foldable value will be the right hand side input to the operation.

Specified by:

asQuery in interface TranslationAware

Overrides:

asQuery in class EsqlBinaryComparison

getWriteableName

public String getWriteableName()

Specified by:

getWriteableName in interface NamedWriteable

info

protected NodeInfo<Equals> 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<Expression>

replaceChildren

protected Equals replaceChildren(Expression newLeft,
 Expression newRight)

Specified by:

replaceChildren in class BinaryScalarFunction

swapLeftAndRight

public Equals swapLeftAndRight()

Specified by:

swapLeftAndRight in class BinaryOperator<Object,Object,Boolean,BinaryComparisonOperation>

reverse

public EsqlBinaryComparison reverse()

Description copied from class: BinaryComparison

Reverses the direction of this comparison on the comparison axis. Some operations like Greater/LessThan/OrEqual will behave as if the operands of a numerical comparison get multiplied with a negative number. Others like Not/Equal can be immutable to this operation.

Specified by:

reverse in class BinaryComparison

negate

public EsqlBinaryComparison negate()

Specified by:

negate in interface Negatable<EsqlBinaryComparison>