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

Class EsqlBinaryComparison

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

All Implemented Interfaces:

NamedWriteable, Writeable, TranslationAware, TranslationAware.SingleValueTranslationAware, Resolvable, EvaluatorMapper

Direct Known Subclasses:

Equals, GreaterThan, GreaterThanOrEqual, LessThan, LessThanOrEqual, NotEquals

public abstract class EsqlBinaryComparison
extends BinaryComparison
implements EvaluatorMapper, TranslationAware.SingleValueTranslationAware

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	EsqlBinaryComparison.BinaryComparisonOperation
static interface	EsqlBinaryComparison.BinaryOperatorConstructor

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

Expression.TypeResolution

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.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 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_LINES, TO_STRING_MAX_WIDTH

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	EsqlBinaryComparison(Source source, Expression left, Expression right, EsqlBinaryComparison.BinaryComparisonOperation operation, ZoneId zoneId, Map<DataType,EsqlArithmeticOperation.BinaryEvaluator> evaluatorMap, EsqlArithmeticOperation.BinaryEvaluator nanosToMillisEvaluator, EsqlArithmeticOperation.BinaryEvaluator millisToNanosEvaluator)
protected	EsqlBinaryComparison(Source source, Expression left, Expression right, EsqlBinaryComparison.BinaryComparisonOperation operation, Map<DataType,EsqlArithmeticOperation.BinaryEvaluator> evaluatorMap, EsqlArithmeticOperation.BinaryEvaluator nanosToMillisEvaluator, EsqlArithmeticOperation.BinaryEvaluator millisToNanosEvaluator)

Method Summary

Modifier and Type	Method	Description
static boolean	areTypesCompatible(DataType leftType, DataType rightType)	Check if the two types are compatible for binary comparison.
Query	asQuery(LucenePushdownPredicates pushdownPredicates, TranslatorHandler handler)	This method is responsible for pushing the ES|QL Binary Comparison operators into Lucene.
protected Expression.TypeResolution	checkCompatibility()	Check if the two input types are compatible for this operation.
Boolean	fold(FoldContext ctx)	Evaluate this expression statically to a constant.
static String	formatIncompatibleTypesMessage(DataType leftType, DataType rightType, String sourceText)
EsqlBinaryComparison.BinaryComparisonOperation	getFunctionType()
static EsqlBinaryComparison	readFrom(StreamInput in)
protected Expression.TypeResolution	resolveInputType(Expression e, TypeResolutions.ParamOrdinal paramOrdinal)
protected Expression.TypeResolution	resolveType()	The implementation of Expression.typeResolved(), which is just a caching wrapper around this method.
Expression	singleValueField()	Returns the field that only supports single-value semantics.
ExpressionEvaluator.Factory	toEvaluator(EvaluatorMapper.ToEvaluator toEvaluator)	Convert this into an ExpressionEvaluator.
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.
final void	writeTo(StreamOutput out)

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

compare, dataType, reverse, zoneId

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

canonicalize, collectCommutative, isCommutative, swapLeftAndRight

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, 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, toString, typeResolved

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, info, nodeName, nodeProperties, nodeString, replaceChildrenSameSize, source, sourceLocation, sourceText, 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.evaluator.mapper.EvaluatorMapper

fold

Methods inherited from interface org.elasticsearch.common.io.stream.NamedWriteable

getWriteableName

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

asLuceneQuery

Constructor Details

EsqlBinaryComparison

protected EsqlBinaryComparison(Source source,
 Expression left,
 Expression right,
 EsqlBinaryComparison.BinaryComparisonOperation operation,
 Map<DataType,EsqlArithmeticOperation.BinaryEvaluator> evaluatorMap,
 EsqlArithmeticOperation.BinaryEvaluator nanosToMillisEvaluator,
 EsqlArithmeticOperation.BinaryEvaluator millisToNanosEvaluator)

EsqlBinaryComparison

protected EsqlBinaryComparison(Source source,
 Expression left,
 Expression right,
 EsqlBinaryComparison.BinaryComparisonOperation operation,
 ZoneId zoneId,
 Map<DataType,EsqlArithmeticOperation.BinaryEvaluator> evaluatorMap,
 EsqlArithmeticOperation.BinaryEvaluator nanosToMillisEvaluator,
 EsqlArithmeticOperation.BinaryEvaluator millisToNanosEvaluator)

Method Details

readFrom

public static EsqlBinaryComparison readFrom(StreamInput in)
                                     throws IOException

Throws:

IOException

writeTo

public final void writeTo(StreamOutput out)
                   throws IOException

Specified by:

writeTo in interface Writeable

Overrides:

writeTo in class BinaryScalarFunction

Throws:

IOException

getFunctionType

public EsqlBinaryComparison.BinaryComparisonOperation getFunctionType()

toEvaluator

public ExpressionEvaluator.Factory toEvaluator(EvaluatorMapper.ToEvaluator toEvaluator)

Description copied from interface: EvaluatorMapper

Convert this into an ExpressionEvaluator.

Note for implementors: If you are implementing this function, you should call the passed-in lambda on your children, after doing any other manipulation (casting, etc.) necessary.

Note for Callers: If you are attempting to call this method, and you have an Expression and a Layout, you likely want to call EvalMapper.toEvaluator(org.elasticsearch.xpack.esql.core.expression.FoldContext, org.elasticsearch.xpack.esql.core.expression.Expression, org.elasticsearch.xpack.esql.planner.Layout) instead. On the other hand, if you already have something that looks like the parameter for this method, you should call this method with that function.

Build an ExpressionEvaluator.Factory for the tree of expressions rooted at this node. This is only guaranteed to return a sensible evaluator if this node has a valid type. If this node is a subclass of Expression then "valid type" means that Expression.typeResolved() returns a non-error resolution. If Expression.typeResolved() returns an error then this method may throw. Or return an evaluator that produces garbage. Or return an evaluator that throws when run.

Specified by:

toEvaluator in interface EvaluatorMapper

fold

public Boolean fold(FoldContext ctx)

Description copied from class: Expression

Evaluate this expression statically to a constant. It is an error to call this if Expression.foldable() returns false.

Overrides:

fold in class BinaryPredicate<Object,Object,Boolean,BinaryComparisonOperation>

resolveType

protected Expression.TypeResolution resolveType()

Description copied from class: Expression

The implementation of Expression.typeResolved(), which is just a caching wrapper around this method. See it's javadoc for what this method should return.

Implementations will rarely interact with the Expression.TypeResolution class directly, instead usually calling the utility methods on TypeResolutions.

Implementations should fail if Expression.childrenResolved() returns false.

Overrides:

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

resolveInputType

protected Expression.TypeResolution resolveInputType(Expression e,
 TypeResolutions.ParamOrdinal paramOrdinal)

Overrides:

resolveInputType in class BinaryComparison

checkCompatibility

protected Expression.TypeResolution checkCompatibility()

Check if the two input types are compatible for this operation. NOTE: this method should be consistent with Verifier.validateBinaryComparison(BinaryComparison)

Returns:

TypeResolution.TYPE_RESOLVED if the types are compatible. Otherwise, an appropriate type resolution error.

areTypesCompatible

public static boolean areTypesCompatible(DataType leftType,
 DataType rightType)

Check if the two types are compatible for binary comparison.

For UNSIGNED_LONG types, we ensure they are not implicitly converted when used in binary operations, as this cannot be done since: - unsigned longs are passed through the engine as longs, so/and - negative values cannot be represented (i.e. range [Long.MIN_VALUE, "abs"(Long.MIN_VALUE) + Long.MAX_VALUE] won't fit on 64 bits); - a conversion to double isn't possible, since upper range UL values can no longer be distinguished ex: (double) 18446744073709551615 == (double) 18446744073709551614 - the implicit ESQL's Cast doesn't currently catch Exception and nullify the result. Let the user handle the operation explicitly.

Parameters:

leftType - the left operand type

rightType - the right operand type

Returns:

true if the types are compatible for comparison

formatIncompatibleTypesMessage

public static String formatIncompatibleTypesMessage(DataType leftType,
 DataType rightType,
 String sourceText)

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

asQuery

public Query asQuery(LucenePushdownPredicates pushdownPredicates,
 TranslatorHandler handler)

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

singleValueField

public Expression singleValueField()

Description copied from interface: TranslationAware.SingleValueTranslationAware

Returns the field that only supports single-value semantics.

Specified by:

singleValueField in interface TranslationAware.SingleValueTranslationAware