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

Class FirstDocId

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

All Implemented Interfaces:

NamedWriteable, Writeable, PostAnalysisPlanVerificationAware, Resolvable, ToAggregator

public class FirstDocId
extends AggregateFunction
implements ToAggregator

Internal aggregation function that collects the first seen docId per group.

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 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
FirstDocId(Source source, Expression v)
FirstDocId(Source source, Expression field, Expression filter, Expression window)

Method Summary

Modifier and Type	Method	Description
DataType	dataType()
String	getWriteableName()
protected NodeInfo<FirstDocId>	info()
FirstDocId	replaceChildren(List<Expression> newChildren)
protected Expression.TypeResolution	resolveType()
AggregatorFunctionSupplier	supplier()
FirstDocId	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, 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

Constructor Details

FirstDocId

public FirstDocId(Source source,
 Expression v)

FirstDocId

public FirstDocId(Source source,
 Expression field,
 Expression filter,
 Expression window)

Method Details

getWriteableName

public String getWriteableName()

Specified by:

getWriteableName in interface NamedWriteable

info

protected NodeInfo<FirstDocId> info()

Specified by:

info in class Node<Expression>

replaceChildren

public FirstDocId replaceChildren(List<Expression> newChildren)

Specified by:

replaceChildren in class Node<Expression>

withFilter

public FirstDocId withFilter(Expression filter)

Description copied from class: AggregateFunction

Attach a filter to the aggregate function.

Specified by:

withFilter in class AggregateFunction

dataType

public DataType dataType()

Specified by:

dataType in class Expression

resolveType

protected Expression.TypeResolution resolveType()

Overrides:

resolveType in class AggregateFunction

supplier

public AggregatorFunctionSupplier supplier()

Specified by:

supplier in interface ToAggregator