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

Class EsqlFunctionRegistry

java.lang.Object

org.elasticsearch.xpack.esql.expression.function.EsqlFunctionRegistry

public class EsqlFunctionRegistry
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	EsqlFunctionRegistry.ArgSignature
static final record	EsqlFunctionRegistry.FunctionDescription
static class	EsqlFunctionRegistry.MapArgSignature
static final record	EsqlFunctionRegistry.MapEntryArgSignature

Constructor Summary

Constructors

Constructor	Description
EsqlFunctionRegistry()

Method Summary

Modifier and Type	Method	Description
protected final void	addCapabilities(Set<String> filterAliases, EsqlCapabilities.Builder capabilities, boolean enabled)
void	addCapabilities(EsqlCapabilities.Builder capabilities)	Add capabilities for registered functions to the set of capabilities.
protected void	buildDataTypesForStringLiteralConversion(FunctionDefinition[]... groupFunctions)
static EsqlFunctionRegistry.FunctionDescription	description(FunctionDefinition def)
boolean	functionExists(Class<? extends Function> clazz)
boolean	functionExists(String functionName)
static FunctionInfo	functionInfo(FunctionDefinition def)
String	functionName(Class<? extends Function> clazz)
List<DataType>	getDataTypeForStringLiteralConversion(Class<? extends Function> clazz)
static boolean	isSnapshotOnly(String functionName)
Collection<FunctionDefinition>	listFunctions()
static EsqlFunctionRegistry.ArgSignature	mapParam(MapParam mapParam)
static String	normalizeName(String name)
static EsqlFunctionRegistry.ArgSignature	param(Param param, boolean variadic)
static EsqlFunctionRegistry.ArgSignature	paramWithoutAnnotation(String name)
String	resolveAlias(String alias)
FunctionDefinition	resolveFunction(String functionName)
EsqlFunctionRegistry	snapshotRegistry()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

EsqlFunctionRegistry

public EsqlFunctionRegistry()

Method Details

resolveFunction

public FunctionDefinition resolveFunction(String functionName)

resolveAlias

public String resolveAlias(String alias)

functionExists

public boolean functionExists(String functionName)

functionExists

public boolean functionExists(Class<? extends Function> clazz)

functionName

public String functionName(Class<? extends Function> clazz)

listFunctions

public Collection<FunctionDefinition> listFunctions()

snapshotRegistry

public EsqlFunctionRegistry snapshotRegistry()

isSnapshotOnly

public static boolean isSnapshotOnly(String functionName)

normalizeName

public static String normalizeName(String name)

description

public static EsqlFunctionRegistry.FunctionDescription description(FunctionDefinition def)

param

public static EsqlFunctionRegistry.ArgSignature param(Param param,
 boolean variadic)

mapParam

public static EsqlFunctionRegistry.ArgSignature mapParam(MapParam mapParam)

paramWithoutAnnotation

public static EsqlFunctionRegistry.ArgSignature paramWithoutAnnotation(String name)

functionInfo

public static FunctionInfo functionInfo(FunctionDefinition def)

getDataTypeForStringLiteralConversion

public List<DataType> getDataTypeForStringLiteralConversion(Class<? extends Function> clazz)

buildDataTypesForStringLiteralConversion

protected void buildDataTypesForStringLiteralConversion(FunctionDefinition[]... groupFunctions)

addCapabilities

public void addCapabilities(EsqlCapabilities.Builder capabilities)

Add capabilities for registered functions to the set of capabilities.

addCapabilities

protected final void addCapabilities(Set<String> filterAliases,
 EsqlCapabilities.Builder capabilities,
 boolean enabled)