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

Class MvAvg

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

org.elasticsearch.xpack.esql.expression.function.scalar.multivalue.AbstractMultivalueFunction

org.elasticsearch.xpack.esql.expression.function.scalar.multivalue.MvAvg

All Implemented Interfaces:

NamedWriteable, Writeable, Resolvable, EvaluatorMapper

public class MvAvg
extends AbstractMultivalueFunction

Reduce a multivalued field to a single valued field containing the average value.

Nested Class Summary

Nested classes/interfaces inherited from class org.elasticsearch.xpack.esql.expression.function.scalar.multivalue.AbstractMultivalueFunction

AbstractMultivalueFunction.AbstractEvaluator, AbstractMultivalueFunction.AbstractNullableEvaluator

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

Modifier and Type	Field	Description
static final NamedWriteableRegistry.Entry	ENTRY

Fields inherited from class org.elasticsearch.xpack.esql.expression.function.scalar.UnaryScalarFunction

field

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
MvAvg(Source source, Expression field)

Method Summary

Modifier and Type	Method	Description
DataType	dataType()	The DataType returned by executing the tree rooted at this expression.
protected EvalOperator.ExpressionEvaluator.Factory	evaluator(EvalOperator.ExpressionEvaluator.Factory fieldEval)	Build the evaluator given the evaluator a multivalued field.
static double	finish(CompensatedSum sum, int valueCount)
String	getWriteableName()
protected NodeInfo<? extends Expression>	info()	Normally, you want to use one of the static create methods to implement this.
static void	process(CompensatedSum sum, double v)
Expression	replaceChildren(List<Expression> newChildren)
protected Expression.TypeResolution	resolveFieldType()

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

resolveType, toEvaluator, writeTo

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

field, foldable

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

Field Details

ENTRY

public static final NamedWriteableRegistry.Entry ENTRY

Constructor Details

MvAvg

public MvAvg(Source source,
 Expression field)

Method Details

getWriteableName

public String getWriteableName()

resolveFieldType

protected Expression.TypeResolution resolveFieldType()

Specified by:

resolveFieldType in class AbstractMultivalueFunction

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 UnaryScalarFunction

evaluator

protected EvalOperator.ExpressionEvaluator.Factory evaluator(EvalOperator.ExpressionEvaluator.Factory fieldEval)

Description copied from class: AbstractMultivalueFunction

Build the evaluator given the evaluator a multivalued field.

Specified by:

evaluator in class AbstractMultivalueFunction

replaceChildren

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

process

public static void process(CompensatedSum sum,
 double v)

finish

public static double finish(CompensatedSum sum,
 int valueCount)