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

Class EsqlArithmeticOperation

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,Object,BinaryArithmeticOperation>

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

org.elasticsearch.xpack.esql.expression.predicate.operator.arithmetic.ArithmeticOperation

org.elasticsearch.xpack.esql.expression.predicate.operator.arithmetic.EsqlArithmeticOperation

All Implemented Interfaces:

NamedWriteable, Writeable, Resolvable, EvaluatorMapper

Direct Known Subclasses:

DenseVectorArithmeticOperation, Mod

public abstract class EsqlArithmeticOperation
extends ArithmeticOperation
implements EvaluatorMapper

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	EsqlArithmeticOperation.BinaryEvaluator	Arithmetic (quad) function.

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

Method Summary

Modifier and Type	Method	Description
protected Expression.TypeResolution	checkCompatibility()	Check if the two input types are compatible for this operation
DataType	dataType()	The DataType returned by executing the tree rooted at this expression.
Object	fold(FoldContext ctx)	Evaluate this expression statically to a constant.
static String	formatIncompatibleTypesMessage(String symbol, DataType leftType, DataType rightType)
protected Expression.TypeResolution	resolveType()	The implementation of Expression.typeResolved(), which is just a caching wrapper around this method.
ExpressionEvaluator.Factory	toEvaluator(EvaluatorMapper.ToEvaluator toEvaluator)	Convert this into an ExpressionEvaluator.

Methods inherited from class org.elasticsearch.xpack.esql.expression.predicate.operator.arithmetic.ArithmeticOperation

resolveInputType, swapLeftAndRight

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, replaceChildren, right, writeTo

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

Method Details

fold

public Object 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,Object,BinaryArithmeticOperation>

dataType

public DataType dataType()

Description copied from class: Expression

The DataType returned by executing the tree rooted at this expression. If Expression.typeResolved() returns an error then the behavior of this method is undefined. It may return a valid type. Or it may throw an exception. Or it may return a totally nonsensical type.

Overrides:

dataType in class ArithmeticOperation

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,Object,BinaryArithmeticOperation>

checkCompatibility

protected Expression.TypeResolution checkCompatibility()

Check if the two input types are compatible for this operation

Returns:

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

formatIncompatibleTypesMessage

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

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