Package org.elasticsearch.xpack.esql.plan.logical.promql

Class UnresolvedPromqlFunction

java.lang.Object

org.elasticsearch.xpack.esql.core.tree.Node<LogicalPlan>

org.elasticsearch.xpack.esql.plan.QueryPlan<LogicalPlan>

org.elasticsearch.xpack.esql.plan.logical.LogicalPlan

org.elasticsearch.xpack.esql.plan.logical.promql.UnresolvedPromqlFunction

All Implemented Interfaces:

NamedWriteable, Writeable, Resolvable, PromqlPlan

public final class UnresolvedPromqlFunction
extends LogicalPlan
implements PromqlPlan

Unresolved PromQL function call produced by the parser and replaced by a resolved node (e.g. WithinSeriesAggregate, AcrossSeriesAggregate) during analysis.

The parser cannot validate function names, arity, or parameter types without consulting the function registry; that semantic work is deliberately deferred to the analyzer.

Nested Class Summary

Nested classes/interfaces inherited from class org.elasticsearch.xpack.esql.plan.logical.LogicalPlan

LogicalPlan.Stage

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 inherited from class org.elasticsearch.xpack.esql.core.tree.Node

TO_STRING_MAX_LINES, TO_STRING_MAX_WIDTH

Constructor Summary

Constructors

Constructor	Description
UnresolvedPromqlFunction(Source source, String functionName, List<LogicalPlan> rawParams, AcrossSeriesAggregate.Grouping grouping, List<Attribute> groupingKeys)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
boolean	expressionsResolved()
String	functionName()
String	getWriteableName()
AcrossSeriesAggregate.Grouping	grouping()
List<Attribute>	groupingKeys()
int	hashCode()
protected NodeInfo<UnresolvedPromqlFunction>	info()	Normally, you want to use one of the static create methods to implement this.
List<Attribute>	output()	The ordered list of attributes (i.e.
List<LogicalPlan>	rawParams()
UnresolvedPromqlFunction	replaceChildren(List<LogicalPlan> newChildren)
PromqlDataType	returnType()	Always throws: the return type is not known until the function name has been resolved against the registry during analysis.
String	toString()
void	writeTo(StreamOutput out)

Methods inherited from class org.elasticsearch.xpack.esql.plan.logical.LogicalPlan

analyzed, childrenResolved, optimized, preAnalyzed, preOptimized, resolved, setAnalyzed, setOptimized, setPreAnalyzed, setPreOptimized

Methods inherited from class org.elasticsearch.xpack.esql.plan.QueryPlan

computeExpressions, computeReferences, expressions, forEachExpression, forEachExpression, forEachExpressionDown, forEachExpressionUp, inputSet, outputSet, references, transformExpressionsDown, transformExpressionsDown, transformExpressionsOnly, transformExpressionsOnly, transformExpressionsOnlyUp, transformExpressionsUp, transformExpressionsUp

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, nodeString, propertiesToString, replaceChildrenSameSize, source, sourceLocation, sourceText, toString, toString, 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

Constructor Details

UnresolvedPromqlFunction

public UnresolvedPromqlFunction(Source source,
 String functionName,
 List<LogicalPlan> rawParams,
 @Nullable
 AcrossSeriesAggregate.Grouping grouping,
 List<Attribute> groupingKeys)

Method Details

functionName

public String functionName()

rawParams

public List<LogicalPlan> rawParams()

grouping

@Nullable
public AcrossSeriesAggregate.Grouping grouping()

groupingKeys

public List<Attribute> groupingKeys()

info

protected NodeInfo<UnresolvedPromqlFunction> 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<LogicalPlan>

replaceChildren

public UnresolvedPromqlFunction replaceChildren(List<LogicalPlan> newChildren)

Specified by:

replaceChildren in class Node<LogicalPlan>

output

public List<Attribute> output()

Description copied from class: QueryPlan

The ordered list of attributes (i.e. columns) this plan produces when executed. Must be called only on resolved plans, otherwise may throw an exception or return wrong results.

Specified by:

output in interface PromqlPlan

Specified by:

output in class QueryPlan<LogicalPlan>

returnType

public PromqlDataType returnType()

Always throws: the return type is not known until the function name has been resolved against the registry during analysis.

Specified by:

returnType in interface PromqlPlan

Throws:

UnsupportedOperationException - always

expressionsResolved

public boolean expressionsResolved()

Specified by:

expressionsResolved in class LogicalPlan

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

equals

public boolean equals(Object obj)

Specified by:

equals in class LogicalPlan

hashCode

public int hashCode()

Specified by:

hashCode in class LogicalPlan

toString

public String toString()

Overrides:

toString in class Node<LogicalPlan>