org.apache.flink.table.factories

Class TableFactoryService

java.lang.Object

org.apache.flink.table.factories.TableFactoryService

@Internal
public class TableFactoryService
extends Object

Unified class to search for a TableFactory of provided type and properties.

Field Summary

Fields

Modifier and Type	Field and Description
static String	FORMAT Prefix for format-related properties.
static String	FORMAT_DERIVE_SCHEMA Key for deriving the schema of the format from the table's schema.
static String	FORMAT_PROPERTY_VERSION Key for describing the property version.
static String	FORMAT_TYPE Key for describing the type of the format.

Constructor Summary

Constructors

Constructor and Description
TableFactoryService()

Method Summary

Modifier and Type	Method and Description
static <T extends TableFactory> T	find(Class<T> factoryClass, Descriptor descriptor) Finds a table factory of the given class and descriptor.
static <T extends TableFactory> T	find(Class<T> factoryClass, Descriptor descriptor, ClassLoader classLoader) Finds a table factory of the given class, descriptor, and classloader.
static <T extends TableFactory> T	find(Class<T> factoryClass, Map<String,String> propertyMap) Finds a table factory of the given class and property map.
static <T extends TableFactory> T	find(Class<T> factoryClass, Map<String,String> propertyMap, ClassLoader classLoader) Finds a table factory of the given class, property map, and classloader.
static <T extends TableFactory> List<T>	findAll(Class<T> factoryClass, Map<String,String> propertyMap) Finds all table factories of the given class and property map.

Methods inherited from class java.lang.Object

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

Field Detail

FORMAT

public static final String FORMAT

Prefix for format-related properties.

See Also:

Constant Field Values

FORMAT_TYPE

public static final String FORMAT_TYPE

Key for describing the type of the format. Usually used for factory discovery.

See Also:

Constant Field Values

FORMAT_PROPERTY_VERSION

public static final String FORMAT_PROPERTY_VERSION

Key for describing the property version. This property can be used for backwards compatibility in case the property format changes.

See Also:

Constant Field Values

FORMAT_DERIVE_SCHEMA

public static final String FORMAT_DERIVE_SCHEMA

Key for deriving the schema of the format from the table's schema.

See Also:

Constant Field Values

Constructor Detail

TableFactoryService

public TableFactoryService()

Method Detail

find

public static <T extends TableFactory> T find(Class<T> factoryClass,
                                              Descriptor descriptor)

Finds a table factory of the given class and descriptor.

Type Parameters:

T - factory class type

Parameters:

factoryClass - desired factory class

descriptor - descriptor describing the factory configuration

Returns:

the matching factory

find

public static <T extends TableFactory> T find(Class<T> factoryClass,
                                              Descriptor descriptor,
                                              ClassLoader classLoader)

Finds a table factory of the given class, descriptor, and classloader.

Type Parameters:

T - factory class type

Parameters:

factoryClass - desired factory class

descriptor - descriptor describing the factory configuration

classLoader - classloader for service loading

Returns:

the matching factory

find

public static <T extends TableFactory> T find(Class<T> factoryClass,
                                              Map<String,String> propertyMap)

Finds a table factory of the given class and property map.

Type Parameters:

T - factory class type

Parameters:

factoryClass - desired factory class

propertyMap - properties that describe the factory configuration

Returns:

the matching factory

find

public static <T extends TableFactory> T find(Class<T> factoryClass,
                                              Map<String,String> propertyMap,
                                              ClassLoader classLoader)

Finds a table factory of the given class, property map, and classloader.

Type Parameters:

T - factory class type

Parameters:

factoryClass - desired factory class

propertyMap - properties that describe the factory configuration

classLoader - classloader for service loading

Returns:

the matching factory

findAll

public static <T extends TableFactory> List<T> findAll(Class<T> factoryClass,
                                                       Map<String,String> propertyMap)

Finds all table factories of the given class and property map.

Type Parameters:

T - factory class type

Parameters:

factoryClass - desired factory class

propertyMap - properties that describe the factory configuration

Returns:

all the matching factories