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

Class EsqlScalarFunction

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

All Implemented Interfaces:

NamedWriteable, Writeable, Resolvable, EvaluatorMapper

Direct Known Subclasses:

Atan2, Case, Chunk, CIDRMatch, Clamp, ClampMax, ClampMin, Coalesce, Concat, Contains, CopySign, DateDiff, DateParse, Decay, EndsWith, EsqlConfigurationFunction, ExtractHistogramComponent, FromAggregateMetricDouble, Greatest, Hash, HistogramPercentile, Hypot, In, IpPrefix, Least, Left, Locate, Log, MvAppend, MvPercentile, MvPSeriesWeightedSum, MvSlice, MvSort, MvZip, NetworkDirection, Pow, Repeat, Replace, Right, Round, RoundTo, Scalb, StartsWith, Substring, ToIp, UnaryScalarFunction

public abstract class EsqlScalarFunction
extends ScalarFunction
implements EvaluatorMapper

A ScalarFunction is a Function that takes values from some operation and converts each to another value. An example would be ABS(), which takes one value at a time, applies a function to the value (abs) and returns a new value.

We have a guide for writing these in the javadoc for org.elasticsearch.xpack.esql.expression.function.scalar.

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

Modifier	Constructor	Description
protected	EsqlScalarFunction(Source source)
protected	EsqlScalarFunction(Source source, List<Expression> fields)

Method Summary

Modifier and Type	Method	Description
Object	fold(FoldContext ctx)

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, dataType, foldable, propertiesToString, references, resolved, resolveType, semanticEquals, semanticHash, toString, typeResolved

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

anyMatch, children, collect, collectFirstChildren, collectLeaves, doCollectFirst, forEachDown, forEachDown, forEachDownMayReturnEarly, forEachProperty, forEachPropertyDown, forEachPropertyOnly, forEachPropertyUp, forEachUp, forEachUp, info, nodeName, nodeProperties, replaceChildren, 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, toEvaluator

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

getWriteableName

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

writeTo

Constructor Details

EsqlScalarFunction

protected EsqlScalarFunction(Source source)

EsqlScalarFunction

protected EsqlScalarFunction(Source source,
 List<Expression> fields)

Method Details

fold

public Object fold(FoldContext ctx)

Overrides:

fold in class Expression