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

Class Sparkline

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

All Implemented Interfaces:

NamedWriteable, Writeable, PostAnalysisPlanVerificationAware, Resolvable, AggregateMetricDoubleNativeSupport

public class Sparkline
extends AggregateFunction
implements AggregateMetricDoubleNativeSupport

Nested Class Summary

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

NO_WINDOW, WINDOW_INTERVAL

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

TO_STRING_MAX_LINES, TO_STRING_MAX_WIDTH

Constructor Summary

Constructors

Constructor	Description
Sparkline(Source source, Expression field, Expression key, Expression buckets, Expression from, Expression to)
Sparkline(Source source, Expression field, Expression filter, Expression window, Expression key, Expression buckets, Expression from, Expression to)

Method Summary

Modifier and Type	Method	Description
Expression	buckets()
DataType	dataType()	The DataType returned by executing the tree rooted at this expression.
Expression	from()
String	getWriteableName()
protected NodeInfo<Sparkline>	info()	Normally, you want to use one of the static create methods to implement this.
Expression	key()
Sparkline	replaceChildren(List<Expression> newChildren)
protected Expression.TypeResolution	resolveType()	The implementation of Expression.typeResolved(), which is just a caching wrapper around this method.
Expression	to()
Sparkline	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, withField, withFilter, withFilter, withParameters, withWindow, 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, 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

Sparkline

public Sparkline(Source source,
 Expression field,
 Expression key,
 Expression buckets,
 Expression from,
 Expression to)

Sparkline

public Sparkline(Source source,
 Expression field,
 Expression filter,
 Expression window,
 Expression key,
 Expression buckets,
 Expression from,
 Expression to)

Method Details

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 AggregateFunction

getWriteableName

public String getWriteableName()

Specified by:

getWriteableName in interface NamedWriteable

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

info

protected NodeInfo<Sparkline> 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>

key

public Expression key()

buckets

public Expression buckets()

from

public Expression from()

to

public Expression to()

replaceChildren

public Sparkline replaceChildren(List<Expression> newChildren)

Specified by:

replaceChildren in class Node<Expression>

withFilter

public Sparkline withFilter(Expression filter)

Description copied from class: AggregateFunction

Attach a filter to the aggregate function.

Specified by:

withFilter in class AggregateFunction