org.apache.flink.table.module

Class ModuleManager

java.lang.Object

org.apache.flink.table.module.ModuleManager

public class ModuleManager
extends Object

Responsible for loading/unloading modules, managing their life cycles, and resolving module objects.

Constructor Summary

Constructors

Constructor and Description
ModuleManager()

Method Summary

Modifier and Type	Method and Description
Optional<org.apache.flink.table.functions.FunctionDefinition>	getFunctionDefinition(String name) Get an optional of FunctionDefinition by a given name.
Set<String>	listFunctions() Get names of all functions from all modules.
List<String>	listModules() Get names of all modules loaded.
void	loadModule(String name, org.apache.flink.table.module.Module module) Load a module under a unique name.
void	unloadModule(String name) Unload a module with given name.

Methods inherited from class java.lang.Object

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

Constructor Detail

ModuleManager

public ModuleManager()

Method Detail

loadModule

public void loadModule(String name,
                       org.apache.flink.table.module.Module module)

Load a module under a unique name. Modules will be kept in the loaded order, and new module will be added to the end. ValidationException is thrown when there is already a module with the same name.

Parameters:

name - name of the module

module - the module instance

unloadModule

public void unloadModule(String name)

Unload a module with given name. ValidationException is thrown when there is no module with the given name.

Parameters:

name - name of the module

listModules

public List<String> listModules()

Get names of all modules loaded.

Returns:

a list of names of modules loaded

listFunctions

public Set<String> listFunctions()

Get names of all functions from all modules.

Returns:

a set of names of registered modules.

getFunctionDefinition

public Optional<org.apache.flink.table.functions.FunctionDefinition> getFunctionDefinition(String name)

Get an optional of FunctionDefinition by a given name. Function will be resolved to modules in the loaded order, and the first match will be returned. If no match is found in all modules, return an optional.

Parameters:

name - name of the function

Returns:

an optional of FunctionDefinition