org.apache.flink.connectors.hive

Class HiveTableFactory

java.lang.Object

org.apache.flink.connectors.hive.HiveTableFactory

All Implemented Interfaces:

TableFactory, TableSinkFactory, TableSourceFactory

public class HiveTableFactory
extends Object
implements TableSourceFactory, TableSinkFactory

A table factory implementation for Hive catalog.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.flink.table.factories.TableSourceFactory

TableSourceFactory.Context

Nested classes/interfaces inherited from interface org.apache.flink.table.factories.TableSinkFactory

TableSinkFactory.Context

Constructor Summary

Constructors

Constructor and Description
HiveTableFactory()

Method Summary

Modifier and Type	Method and Description
TableSink	createTableSink(TableSinkFactory.Context context) Creates and configures a TableSink based on the given TableSinkFactory.Context.
TableSource	createTableSource(TableSourceFactory.Context context) Creates and configures a TableSource based on the given TableSourceFactory.Context.
Map<String,String>	requiredContext() Specifies the context that this factory has been implemented for.
List<String>	supportedProperties() List of property keys that this factory can handle.

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.factories.TableSourceFactory

createTableSource, createTableSource

Methods inherited from interface org.apache.flink.table.factories.TableSinkFactory

createTableSink, createTableSink

Constructor Detail

HiveTableFactory

public HiveTableFactory()

Method Detail

requiredContext

public Map<String,String> requiredContext()

Description copied from interface: TableFactory

Specifies the context that this factory has been implemented for. The framework guarantees to only match for this factory if the specified set of properties and values are met.

Typical properties might be: - connector.type - format.type

Specified property versions allow the framework to provide backwards compatible properties in case of string format changes: - connector.property-version - format.property-version

An empty context means that the factory matches for all requests.

Specified by:

requiredContext in interface TableFactory

supportedProperties

public List<String> supportedProperties()

Description copied from interface: TableFactory

List of property keys that this factory can handle. This method will be used for validation. If a property is passed that this factory cannot handle, an exception will be thrown. The list must not contain the keys that are specified by the context.

Example properties might be: - schema.#.type - schema.#.name - connector.topic - format.line-delimiter - format.ignore-parse-errors - format.fields.#.type - format.fields.#.name

Note: Use "#" to denote an array of values where "#" represents one or more digits. Property versions like "format.property-version" must not be part of the supported properties.

In some cases it might be useful to declare wildcards "*". Wildcards can only be declared at the end of a property key.

For example, if an arbitrary format should be supported: - format.*

Note: Wildcards should be used with caution as they might swallow unsupported properties and thus might lead to undesired behavior.

Specified by:

supportedProperties in interface TableFactory

createTableSource

public TableSource createTableSource(TableSourceFactory.Context context)

Description copied from interface: TableSourceFactory

Creates and configures a TableSource based on the given TableSourceFactory.Context.

Specified by:

createTableSource in interface TableSourceFactory

Parameters:

context - context of this table source.

Returns:

the configured table source.

createTableSink

public TableSink createTableSink(TableSinkFactory.Context context)

Description copied from interface: TableSinkFactory

Creates and configures a TableSink based on the given TableSinkFactory.Context.

Specified by:

createTableSink in interface TableSinkFactory

Parameters:

context - context of this table sink.

Returns:

the configured table sink.