org.apache.flink.table.catalog

Interface CatalogFunction

@PublicEvolving
public interface CatalogFunction

Interface for a function in a catalog.

Method Summary

Modifier and Type	Method and Description
CatalogFunction	copy() Create a deep copy of the function.
String	getClassName() Get the full name of the class backing the function.
Optional<String>	getDescription() Get a brief description of the function.
Optional<String>	getDetailedDescription() Get a detailed description of the function.
FunctionLanguage	getFunctionLanguage() Get the language used for the definition of function.
boolean	isGeneric() Distinguish if the function is a generic function.

Method Detail

getClassName

String getClassName()

Get the full name of the class backing the function.

Returns:

the full name of the class

copy

CatalogFunction copy()

Create a deep copy of the function.

Returns:

a deep copy of "this" instance

getDescription

Optional<String> getDescription()

Get a brief description of the function.

Returns:

an optional short description of the function

getDetailedDescription

Optional<String> getDetailedDescription()

Get a detailed description of the function.

Returns:

an optional long description of the function

isGeneric

boolean isGeneric()

Distinguish if the function is a generic function.

Returns:

whether the function is a generic function

getFunctionLanguage

FunctionLanguage getFunctionLanguage()

Get the language used for the definition of function.

Returns:

the language type of the function definition