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

Class HistogramMerge

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.expression.function.aggregate.AggregateFunction

org.elasticsearch.xpack.esql.expression.function.aggregate.HistogramMerge

All Implemented Interfaces:

NamedWriteable, Writeable, PostAnalysisPlanVerificationAware, Resolvable, ToAggregator

public class HistogramMerge
extends AggregateFunction
implements ToAggregator

Merges multiple histograms into a single histogram. Note that this function is currently only intended for usage in surrogates and not available as a user-facing function. Therefore, it is intentionally not registered in EsqlFunctionRegistry.

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

NO_WINDOW, WINDOW_INTERVAL

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

TO_STRING_MAX_WIDTH

Constructor Summary

Constructors

Constructor	Description
HistogramMerge(Source source, Expression field)
HistogramMerge(Source source, Expression field, Expression filter)

Method Summary

Modifier and Type	Method	Description
DataType	dataType()
String	getWriteableName()
protected NodeInfo<HistogramMerge>	info()
HistogramMerge	replaceChildren(List<Expression> newChildren)
protected Expression.TypeResolution	resolveType()
final AggregatorFunctionSupplier	supplier()
HistogramMerge	withFilter(Expression filter)	Attach a filter to the aggregate function.

Methods inherited from class org.elasticsearch.xpack.esql.expression.function.aggregate.AggregateFunction

aggregateInputReferences, equals, field, filter, hasFilter, hashCode, hasWindow, parameters, postAnalysisPlanVerification, readWindow, window, withParameters, writeTo

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

arguments, functionName, nodeString, nullable

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

canonical, canonicalize, childrenResolved, fold, foldable, propertiesToString, references, resolved, 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, 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

Field Details

ENTRY

public static final NamedWriteableRegistry.Entry ENTRY

Constructor Details

HistogramMerge

public HistogramMerge(Source source,
 Expression field)

HistogramMerge

public HistogramMerge(Source source,
 Expression field,
 Expression filter)

Method Details

getWriteableName

public String getWriteableName()

Specified by:

getWriteableName in interface NamedWriteable

dataType

public DataType dataType()

Specified by:

dataType in class Expression

resolveType

protected Expression.TypeResolution resolveType()

Overrides:

resolveType in class AggregateFunction

info

protected NodeInfo<HistogramMerge> info()

Specified by:

info in class Node<Expression>

replaceChildren

public HistogramMerge replaceChildren(List<Expression> newChildren)

Specified by:

replaceChildren in class Node<Expression>

withFilter

public HistogramMerge withFilter(Expression filter)

Description copied from class: AggregateFunction

Attach a filter to the aggregate function.

Specified by:

withFilter in class AggregateFunction

supplier

public final AggregatorFunctionSupplier supplier()

Specified by:

supplier in interface ToAggregator