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

Class RoundTo

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

All Implemented Interfaces:

NamedWriteable, Writeable, Resolvable, EvaluatorMapper, BlockLoaderExpression

public class RoundTo
extends EsqlScalarFunction
implements BlockLoaderExpression

Round down to one of a list of values.

Nested Class Summary

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.expression.function.blockloader.BlockLoaderExpression

BlockLoaderExpression.PushedBlockLoaderExpression

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

Modifier and Type	Field	Description
static final FunctionDefinition	DEFINITION
static final NamedWriteableRegistry.Entry	ENTRY
static final TransportVersion	ESQL_ROUND_TO_CONVENTION

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

Constructor	Description
RoundTo(Source source, Expression field, List<Expression> points)
RoundTo(Source source, Expression field, List<Expression> points, Rounding.RoundingConvention convention)

Method Summary

Modifier and Type	Method	Description
DataType	dataType()	The DataType returned by executing the tree rooted at this expression.
Expression	field()
boolean	foldable()	Whether the expression can be evaluated statically, aka "folded", or not.
String	getWriteableName()
protected NodeInfo<? extends Expression>	info()	Normally, you want to use one of the static create methods to implement this.
Nullability	nullable()
List<Expression>	points()
final Expression	replaceChildren(List<Expression> newChildren)
protected Expression.TypeResolution	resolveType()	The implementation of Expression.typeResolved(), which is just a caching wrapper around this method.
Rounding.RoundingConvention	roundingConvention()
ExpressionEvaluator.Factory	toEvaluator(EvaluatorMapper.ToEvaluator toEvaluator)	Convert this into an ExpressionEvaluator.
BlockLoaderExpression.PushedBlockLoaderExpression	tryPushToFieldLoading(SearchStats stats)	The field and loading configuration that replaces this expression, effectively "fusing" the expression into the load.
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

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

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

fold

Field Details

ENTRY

public static final NamedWriteableRegistry.Entry ENTRY

DEFINITION

public static final FunctionDefinition DEFINITION

ESQL_ROUND_TO_CONVENTION

public static final TransportVersion ESQL_ROUND_TO_CONVENTION

Constructor Details

RoundTo

public RoundTo(Source source,
 Expression field,
 List<Expression> points)

RoundTo

public RoundTo(Source source,
 Expression field,
 List<Expression> points,
 Rounding.RoundingConvention convention)

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

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

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

foldable

public boolean foldable()

Description copied from class: Expression

Whether the expression can be evaluated statically, aka "folded", or not.

Overrides:

foldable in class Expression

nullable

public Nullability nullable()

Overrides:

nullable in class Function

replaceChildren

public final Expression replaceChildren(List<Expression> newChildren)

Specified by:

replaceChildren in class Node<Expression>

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()

points

public List<Expression> points()

roundingConvention

public Rounding.RoundingConvention roundingConvention()

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

tryPushToFieldLoading

public BlockLoaderExpression.PushedBlockLoaderExpression tryPushToFieldLoading(SearchStats stats)

Description copied from interface: BlockLoaderExpression

The field and loading configuration that replaces this expression, effectively "fusing" the expression into the load. Or null if the fusion isn't possible.

SearchStats.supportsLoaderConfig(org.elasticsearch.xpack.esql.core.expression.FieldAttribute.FieldName, org.elasticsearch.index.mapper.blockloader.BlockLoaderFunctionConfig, org.elasticsearch.index.mapper.MappedFieldType.FieldExtractPreference) checks that the configuration is supported by all field mappers. Callers to this method must call that to confirm that configurations returned are supported. Implementations of this method do not need to call it, though they may use methods like SearchStats.hasDocValues(org.elasticsearch.xpack.esql.core.expression.FieldAttribute.FieldName) and SearchStats.isIndexed(org.elasticsearch.xpack.esql.core.expression.FieldAttribute.FieldName) as preflight checks. They should use those methods if it is expensive to build the BlockLoaderFunctionConfig.

Specified by:

tryPushToFieldLoading in interface BlockLoaderExpression