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

Class Function

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

All Implemented Interfaces:

NamedWriteable, Writeable, Resolvable

Direct Known Subclasses:

ScalarFunction

public abstract class Function
extends Expression

Any SQL expression with parentheses, like MAX(), or ABS(). A function is always a NamedExpression.

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

TO_STRING_MAX_LINES, TO_STRING_MAX_WIDTH

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Function(Source source, List<Expression> children)

Method Summary

Modifier and Type	Method	Description
final List<Expression>	arguments()
boolean	equals(Object obj)
String	functionName()
int	hashCode()
void	nodeString(StringBuilder sb, Node.NodeStringFormat format)	Append this Node's string representation to sb.
Nullability	nullable()

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

canonical, canonicalize, childrenResolved, dataType, fold, foldable, propertiesToString, references, resolved, resolveType, semanticEquals, semanticHash, toString, toString, typeResolved

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

anyMatch, children, collect, collectFirstChildren, collectLeaves, doCollectFirst, forEachDown, forEachDown, forEachProperty, forEachPropertyDown, forEachPropertyOnly, forEachPropertyUp, forEachUp, forEachUp, info, nodeName, nodeProperties, nodeString, replaceChildren, replaceChildrenSameSize, source, sourceLocation, sourceText, transformChildren, transformChildren, transformDown, 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

Methods inherited from interface org.elasticsearch.common.io.stream.NamedWriteable

getWriteableName

Methods inherited from interface org.elasticsearch.common.io.stream.Writeable

writeTo

Constructor Details

Function

protected Function(Source source,
 List<Expression> children)

Method Details

arguments

public final List<Expression> arguments()

functionName

public String functionName()

nullable

public Nullability nullable()

Specified by:

nullable in class Expression

hashCode

public int hashCode()

Overrides:

hashCode in class Node<Expression>

equals

public boolean equals(Object obj)

Overrides:

equals in class Node<Expression>

nodeString

public void nodeString(StringBuilder sb,
 Node.NodeStringFormat format)

Description copied from class: Node

Append this Node's string representation to sb. This does not include this node's Node.children().

Overrides:

nodeString in class Node<Expression>

Parameters:

sb - target for the string

format - configuration for rendering the string representation