org.apache.flink.table.catalog

Class FunctionCatalog

java.lang.Object

org.apache.flink.table.catalog.FunctionCatalog

All Implemented Interfaces:

FunctionLookup

@Internal
public class FunctionCatalog
extends Object
implements FunctionLookup

Simple function catalog to store FunctionDefinitions in catalogs.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.flink.table.catalog.FunctionLookup

FunctionLookup.Result

Constructor Summary

Constructors

Constructor and Description
FunctionCatalog(TableConfig config, CatalogManager catalogManager, ModuleManager moduleManager)

Method Summary

Modifier and Type	Method and Description
void	dropTempCatalogFunction(org.apache.flink.table.catalog.ObjectIdentifier identifier, boolean ignoreIfNotExist) Drop a temporary catalog function.
void	dropTempSystemFunction(String funcName, boolean ignoreIfNotExist) Drop a temporary system function.
String[]	getFunctions() Get names of all functions, including temp system functions, system functions, temp catalog functions and catalog functions in the current catalog and current database.
PlannerTypeInferenceUtil	getPlannerTypeInferenceUtil() Temporary utility until the new type inference is fully functional.
String[]	getUserDefinedFunctions() Get names of all user defined functions, including temp system functions, temp catalog functions and catalog functions in the current catalog and current database.
boolean	hasTemporaryCatalogFunction(org.apache.flink.table.catalog.ObjectIdentifier functionIdentifier) Check whether a temporary catalog function is already registered.
boolean	hasTemporarySystemFunction(String functionName) Check whether a temporary system function is already registered.
Optional<FunctionLookup.Result>	lookupFunction(org.apache.flink.table.catalog.UnresolvedIdentifier identifier) Lookup a function by function identifier.
<T,ACC> void	registerTempCatalogAggregateFunction(org.apache.flink.table.catalog.ObjectIdentifier oi, org.apache.flink.table.functions.UserDefinedAggregateFunction<T,ACC> function, org.apache.flink.api.common.typeinfo.TypeInformation<T> resultType, org.apache.flink.api.common.typeinfo.TypeInformation<ACC> accType)
void	registerTempCatalogScalarFunction(org.apache.flink.table.catalog.ObjectIdentifier oi, org.apache.flink.table.functions.ScalarFunction function)
<T> void	registerTempCatalogTableFunction(org.apache.flink.table.catalog.ObjectIdentifier oi, org.apache.flink.table.functions.TableFunction<T> function, org.apache.flink.api.common.typeinfo.TypeInformation<T> resultType)
<T,ACC> void	registerTempSystemAggregateFunction(String name, org.apache.flink.table.functions.UserDefinedAggregateFunction<T,ACC> function, org.apache.flink.api.common.typeinfo.TypeInformation<T> resultType, org.apache.flink.api.common.typeinfo.TypeInformation<ACC> accType)
void	registerTempSystemScalarFunction(String name, org.apache.flink.table.functions.ScalarFunction function)
<T> void	registerTempSystemTableFunction(String name, org.apache.flink.table.functions.TableFunction<T> function, org.apache.flink.api.common.typeinfo.TypeInformation<T> resultType)
void	setPlannerTypeInferenceUtil(PlannerTypeInferenceUtil plannerTypeInferenceUtil)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.flink.table.catalog.FunctionLookup

lookupBuiltInFunction

Constructor Detail

FunctionCatalog

public FunctionCatalog(TableConfig config,
                       CatalogManager catalogManager,
                       ModuleManager moduleManager)

Method Detail

setPlannerTypeInferenceUtil

public void setPlannerTypeInferenceUtil(PlannerTypeInferenceUtil plannerTypeInferenceUtil)

registerTempSystemScalarFunction

public void registerTempSystemScalarFunction(String name,
                                             org.apache.flink.table.functions.ScalarFunction function)

registerTempSystemTableFunction

public <T> void registerTempSystemTableFunction(String name,
                                                org.apache.flink.table.functions.TableFunction<T> function,
                                                org.apache.flink.api.common.typeinfo.TypeInformation<T> resultType)

registerTempSystemAggregateFunction

public <T,ACC> void registerTempSystemAggregateFunction(String name,
                                                        org.apache.flink.table.functions.UserDefinedAggregateFunction<T,ACC> function,
                                                        org.apache.flink.api.common.typeinfo.TypeInformation<T> resultType,
                                                        org.apache.flink.api.common.typeinfo.TypeInformation<ACC> accType)

registerTempCatalogScalarFunction

public void registerTempCatalogScalarFunction(org.apache.flink.table.catalog.ObjectIdentifier oi,
                                              org.apache.flink.table.functions.ScalarFunction function)

registerTempCatalogTableFunction

public <T> void registerTempCatalogTableFunction(org.apache.flink.table.catalog.ObjectIdentifier oi,
                                                 org.apache.flink.table.functions.TableFunction<T> function,
                                                 org.apache.flink.api.common.typeinfo.TypeInformation<T> resultType)

registerTempCatalogAggregateFunction

public <T,ACC> void registerTempCatalogAggregateFunction(org.apache.flink.table.catalog.ObjectIdentifier oi,
                                                         org.apache.flink.table.functions.UserDefinedAggregateFunction<T,ACC> function,
                                                         org.apache.flink.api.common.typeinfo.TypeInformation<T> resultType,
                                                         org.apache.flink.api.common.typeinfo.TypeInformation<ACC> accType)

hasTemporaryCatalogFunction

public boolean hasTemporaryCatalogFunction(org.apache.flink.table.catalog.ObjectIdentifier functionIdentifier)

Check whether a temporary catalog function is already registered.

Parameters:

functionIdentifier - the object identifier of function

Returns:

whether the temporary catalog function exists in the function catalog

hasTemporarySystemFunction

public boolean hasTemporarySystemFunction(String functionName)

Check whether a temporary system function is already registered.

Parameters:

functionName - the name of the function

Returns:

whether the temporary system function exists in the function catalog

dropTempSystemFunction

public void dropTempSystemFunction(String funcName,
                                   boolean ignoreIfNotExist)

Drop a temporary system function.

Parameters:

funcName - name of the function

ignoreIfNotExist - Flag to specify behavior when the function does not exist: if set to false, throw an exception, if set to true, do nothing.

dropTempCatalogFunction

public void dropTempCatalogFunction(org.apache.flink.table.catalog.ObjectIdentifier identifier,
                                    boolean ignoreIfNotExist)

Drop a temporary catalog function.

Parameters:

identifier - identifier of the function

ignoreIfNotExist - Flag to specify behavior when the function does not exist: if set to false, throw an exception, if set to true, do nothing.

getUserDefinedFunctions

public String[] getUserDefinedFunctions()

Get names of all user defined functions, including temp system functions, temp catalog functions and catalog functions in the current catalog and current database.

getFunctions

public String[] getFunctions()

Get names of all functions, including temp system functions, system functions, temp catalog functions and catalog functions in the current catalog and current database.

lookupFunction

public Optional<FunctionLookup.Result> lookupFunction(org.apache.flink.table.catalog.UnresolvedIdentifier identifier)

Description copied from interface: FunctionLookup

Lookup a function by function identifier. The lookup is case insensitive.

Specified by:

lookupFunction in interface FunctionLookup

getPlannerTypeInferenceUtil

public PlannerTypeInferenceUtil getPlannerTypeInferenceUtil()

Description copied from interface: FunctionLookup

Temporary utility until the new type inference is fully functional.

Specified by:

getPlannerTypeInferenceUtil in interface FunctionLookup