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

Class TimeSeriesWithout

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.grouping.GroupingFunction

org.elasticsearch.xpack.esql.expression.function.grouping.GroupingFunction.NonEvaluatableGroupingFunction

org.elasticsearch.xpack.esql.expression.function.grouping.TimeSeriesWithout

All Implemented Interfaces:

NamedWriteable, Writeable, PostAnalysisPlanVerificationAware, Resolvable, OptionalArgument

public class TimeSeriesWithout
extends GroupingFunction.NonEvaluatableGroupingFunction
implements OptionalArgument

Grouping function that keeps time-series grouping generic while excluding the specified dimensions. An empty field list means "group by all dimensions".

Nested Class Summary

Nested classes/interfaces inherited from class org.elasticsearch.xpack.esql.expression.function.grouping.GroupingFunction

GroupingFunction.EvaluatableGroupingFunction, GroupingFunction.NonEvaluatableGroupingFunction

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

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

TO_STRING_MAX_LINES, TO_STRING_MAX_WIDTH

Constructor Summary

Constructors

Constructor	Description
TimeSeriesWithout(Source source, List<Expression> fields)

Method Summary

Modifier and Type	Method	Description
DataType	dataType()	The DataType returned by executing the tree rooted at this expression.
Set<String>	excludedFieldNames()	Returns the set of field names to exclude from the time-series grouping.
String	getWriteableName()
protected NodeInfo<? extends Expression>	info()	Normally, you want to use one of the static create methods to implement this.
Nullability	nullable()
TimeSeriesWithout	replaceChildren(List<Expression> newChildren)
protected Expression.TypeResolution	resolveType()	The implementation of Expression.typeResolved(), which is just a caching wrapper around this method.
Alias	toAttribute()	Returns the canonical grouping expression for the _timeseries metadata column.
Alias	toAttribute(NameId id)	Returns the canonical grouping expression for the _timeseries metadata column.
String	toString()
void	writeTo(StreamOutput out)

Methods inherited from class org.elasticsearch.xpack.esql.expression.function.grouping.GroupingFunction

postAnalysisPlanVerification

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, fold, foldable, propertiesToString, references, resolved, semanticEquals, semanticHash, 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, 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

Field Details

ENTRY

public static final NamedWriteableRegistry.Entry ENTRY

DEFINITION

public static final FunctionDefinition DEFINITION

Constructor Details

TimeSeriesWithout

public TimeSeriesWithout(Source source,
 List<Expression> fields)

Method Details

toAttribute

public Alias toAttribute()

Returns the canonical grouping expression for the _timeseries metadata column.

toAttribute

public Alias toAttribute(@Nullable
 NameId id)

Returns the canonical grouping expression for the _timeseries metadata column.

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

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>

replaceChildren

public TimeSeriesWithout replaceChildren(List<Expression> newChildren)

Specified by:

replaceChildren in class Node<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

nullable

public Nullability nullable()

Overrides:

nullable in class Function

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

excludedFieldNames

public Set<String> excludedFieldNames()

Returns the set of field names to exclude from the time-series grouping.

toString

public String toString()

Overrides:

toString in class Expression