Package org.apache.flink.table.module

Class CoreModule

java.lang.Object

org.apache.flink.table.module.CoreModule

All Implemented Interfaces:

Module

@PublicEvolving
public class CoreModule
extends Object
implements Module

Module of default core metadata in Flink.

Field Summary

Fields

Modifier and Type	Field	Description
static CoreModule	INSTANCE

Method Summary

Modifier and Type	Method	Description
Optional<FunctionDefinition>	getFunctionDefinition(String name)	Get an optional of FunctionDefinition by a given name.
Set<String>	listFunctions()	List names of all functions in this module.
Set<String>	listFunctions(boolean includeHiddenFunctions)	List names of all functions in this module.

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.module.Module

getTableSinkFactory, getTableSourceFactory

Field Detail

INSTANCE

public static final CoreModule INSTANCE

Method Detail

listFunctions

public Set<String> listFunctions()

Description copied from interface: Module

List names of all functions in this module. It excludes internal functions.

Specified by:

listFunctions in interface Module

Returns:

a set of function names

listFunctions

public Set<String> listFunctions(boolean includeHiddenFunctions)

Description copied from interface: Module

List names of all functions in this module.

A module can decide to hide certain functions. For example, internal functions that can be resolved via Module.getFunctionDefinition(String) but should not be listed by default.

Specified by:

listFunctions in interface Module

Parameters:

includeHiddenFunctions - whether to list hidden functions or not

Returns:

a set of function names

getFunctionDefinition

public Optional<FunctionDefinition> getFunctionDefinition(String name)

Description copied from interface: Module

Get an optional of FunctionDefinition by a given name.

It includes hidden functions even though not listed in Module.listFunctions().

Specified by:

getFunctionDefinition in interface Module

Parameters:

name - name of the FunctionDefinition.

Returns:

an optional function definition