Package org.elasticsearch.xpack.esql.expression.function.scalar.convert

Class ToIntegerSurrogate

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

org.elasticsearch.xpack.esql.expression.function.scalar.convert.ToIntegerSurrogate

All Implemented Interfaces:

NamedWriteable, Writeable, Resolvable, EvaluatorMapper, OptionalArgument, ConvertFunction, SurrogateExpression

public class ToIntegerSurrogate
extends EsqlScalarFunction
implements SurrogateExpression, OptionalArgument, ConvertFunction

In a single-parameter mode, the function converts the first parameter to an integer.

• TO_INTEGER(value) - value supports ...

In two-parameter mode, the function parses the first string parameter into an integer using the second parameter as a base.

• TO_INTEGER(string, base) - base supports integer, long and unsigned_long

Nested Class Summary

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

Constructor Summary

Constructors

Constructor	Description
ToIntegerSurrogate(Source source, Expression field, Expression base)

Method Summary

Modifier and Type	Method	Description
DataType	dataType()	The DataType returned by executing the tree rooted at this expression.
Expression	field()	Expression containing the values to be converted.
String	getWriteableName()
protected NodeInfo<? extends Expression>	info()	Normally, you want to use one of the static create methods to implement this.
Expression	replaceChildren(List<Expression> newChildren)
protected Expression.TypeResolution	resolveType()	The implementation of Expression.typeResolved(), which is just a caching wrapper around this method.
Set<DataType>	supportedTypes()	The types that ConvertFunction.field() can have.
Expression	surrogate()	Returns the expression to be replaced by or null if this cannot be replaced.
EvalOperator.ExpressionEvaluator.Factory	toEvaluator(EvaluatorMapper.ToEvaluator toEvaluator)	Convert this into an EvalOperator.ExpressionEvaluator.
void	writeTo(StreamOutput out)

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

fold

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

arguments, equals, functionName, hashCode, nodeString, nullable

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

canonical, canonicalize, childrenResolved, foldable, 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

Constructor Details

ToIntegerSurrogate

public ToIntegerSurrogate(Source source,
 Expression field,
 Expression base)

Method Details

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Writeable

Throws:

IOException

getWriteableName

public String getWriteableName()

Specified by:

getWriteableName in interface NamedWriteable

toEvaluator

public EvalOperator.ExpressionEvaluator.Factory toEvaluator(EvaluatorMapper.ToEvaluator toEvaluator)

Description copied from interface: EvaluatorMapper

Convert this into an EvalOperator.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 EvalOperator.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

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.

Specified by:

dataType in class Expression

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 Expression

replaceChildren

public Expression replaceChildren(List<Expression> newChildren)

Specified by:

replaceChildren in class Node<Expression>

surrogate

public Expression surrogate()

Description copied from interface: SurrogateExpression

Returns the expression to be replaced by or null if this cannot be replaced.

Specified by:

surrogate in interface SurrogateExpression

info

protected NodeInfo<? extends Expression> 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>

field

public Expression field()

Description copied from interface: ConvertFunction

Expression containing the values to be converted.

Specified by:

field in interface ConvertFunction

supportedTypes

public Set<DataType> supportedTypes()

Description copied from interface: ConvertFunction

The types that ConvertFunction.field() can have.

Specified by:

supportedTypes in interface ConvertFunction