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

Class UnresolvedFunction

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

All Implemented Interfaces:

NamedWriteable, Writeable, Resolvable, Unresolvable

public class UnresolvedFunction
extends Function
implements Unresolvable

An unresolved function call. We build these while walking the syntax tree and then resolve them into other Function subclasses during analysis.

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.core.tree.Node

TO_STRING_MAX_WIDTH

Fields inherited from interface org.elasticsearch.xpack.esql.core.capabilities.Unresolvable

UNRESOLVED_PREFIX

Constructor Summary

Constructors

Constructor	Description
UnresolvedFunction(Source source, String name, FunctionResolutionStrategy resolutionStrategy, List<Expression> children)
UnresolvedFunction(Source source, String name, FunctionResolutionStrategy resolutionStrategy, List<Expression> children, boolean analyzed, String unresolvedMessage)	Constructor used for specifying a more descriptive message (typically 'did you mean') instead of the default one.

Method Summary

Modifier and Type	Method	Description
boolean	analyzed()
Function	buildResolved(Configuration configuration, FunctionDefinition def)	Build a function to replace this one after resolving the function.
DataType	dataType()	The DataType returned by executing the tree rooted at this expression.
boolean	equals(Object obj)
String	getWriteableName()
int	hashCode()
protected NodeInfo<UnresolvedFunction>	info()	Normally, you want to use one of the static create methods to implement this.
UnresolvedFunction	missing(String normalizedName, Iterable<FunctionDefinition> alternatives)	Build a marker UnresolvedFunction with an error message about the function being missing.
String	name()
String	nodeString()
Nullability	nullable()
Expression	replaceChildren(List<Expression> newChildren)
FunctionResolutionStrategy	resolutionStrategy()
boolean	resolved()
protected Expression.TypeResolution	resolveType()	The implementation of Expression.typeResolved(), which is just a caching wrapper around this method.
String	toString()
String	unresolvedMessage()	NOTE: Any non-null return value from this method indicates that the item in question could not be resolved.
UnresolvedFunction	withMessage(String message)
void	writeTo(StreamOutput out)

Methods inherited from class org.elasticsearch.xpack.esql.core.expression.function.Function

arguments, functionName

Methods inherited from class org.elasticsearch.xpack.esql.core.expression.Expression

canonical, canonicalize, childrenResolved, fold, foldable, propertiesToString, references, semanticEquals, semanticHash, 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

UnresolvedFunction

public UnresolvedFunction(Source source,
 String name,
 FunctionResolutionStrategy resolutionStrategy,
 List<Expression> children)

UnresolvedFunction

public UnresolvedFunction(Source source,
 String name,
 FunctionResolutionStrategy resolutionStrategy,
 List<Expression> children,
 boolean analyzed,
 String unresolvedMessage)

Constructor used for specifying a more descriptive message (typically 'did you mean') instead of the default one.

See Also:

• withMessage(String)

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

info

protected NodeInfo<UnresolvedFunction> 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 Expression replaceChildren(List<Expression> newChildren)

Specified by:

replaceChildren in class Node<Expression>

withMessage

public UnresolvedFunction withMessage(String message)

buildResolved

public Function buildResolved(Configuration configuration,
 FunctionDefinition def)

Build a function to replace this one after resolving the function.

missing

public UnresolvedFunction missing(String normalizedName,
 Iterable<FunctionDefinition> alternatives)

Build a marker UnresolvedFunction with an error message about the function being missing.

resolved

public boolean resolved()

Specified by:

resolved in interface Resolvable

Specified by:

resolved in interface Unresolvable

Overrides:

resolved in class Expression

name

public String name()

resolutionStrategy

public FunctionResolutionStrategy resolutionStrategy()

analyzed

public boolean analyzed()

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

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

unresolvedMessage

public String unresolvedMessage()

Description copied from interface: Unresolvable

NOTE: Any non-null return value from this method indicates that the item in question could not be resolved.

Specified by:

unresolvedMessage in interface Unresolvable

toString

public String toString()

Overrides:

toString in class Expression

nodeString

public String nodeString()

Overrides:

nodeString in class Function

equals

public boolean equals(Object obj)

Overrides:

equals in class Function

hashCode

public int hashCode()

Overrides:

hashCode in class Function