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

Class PromqlFunctionCall

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

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

All Implemented Interfaces:

NamedWriteable, Writeable, Resolvable, PromqlPlan

Direct Known Subclasses:

AcrossSeriesAggregate, ScalarConversionFunction, ValueTransformationFunction, VectorConversionFunction, WithinSeriesAggregate

public abstract sealed class PromqlFunctionCall
extends UnaryPlan
implements PromqlPlan
permits AcrossSeriesAggregate, ScalarConversionFunction, WithinSeriesAggregate, ValueTransformationFunction, VectorConversionFunction

Represents a PromQL function call in the logical plan. This is a surrogate logical plan that encapsulates a PromQL function invocation and delegates to the PromqlFunctionRegistry for validation and ESQL function construction.

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
PromqlFunctionCall(Source source, LogicalPlan child, String functionName, List<Expression> parameters)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
boolean	expressionsResolved()
String	functionName()
abstract FunctionType	functionType()
String	getWriteableName()
int	hashCode()
List<Attribute>	output()	The ordered list of attributes (i.e.
List<Expression>	parameters()
final PromqlDataType	returnType()	The PromQL return type of this plan node.
void	writeTo(StreamOutput out)

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

child, inputSet, outputSet, replaceChild, replaceChildren

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, 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, info, 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

PromqlFunctionCall

public PromqlFunctionCall(Source source,
 LogicalPlan child,
 String functionName,
 List<Expression> parameters)

Method Details

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

functionName

public String functionName()

parameters

public List<Expression> parameters()

expressionsResolved

public boolean expressionsResolved()

Specified by:

expressionsResolved in class LogicalPlan

hashCode

public int hashCode()

Overrides:

hashCode in class UnaryPlan

equals

public boolean equals(Object obj)

Overrides:

equals in class UnaryPlan

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

Overrides:

output in class UnaryPlan

functionType

public abstract FunctionType functionType()

returnType

public final PromqlDataType returnType()

Description copied from interface: PromqlPlan

The PromQL return type of this plan node.

Specified by:

returnType in interface PromqlPlan