org.apache.flink.table.factories

类 TableFormatFactoryBase<T>

java.lang.Object

org.apache.flink.table.factories.TableFormatFactoryBase<T>

类型参数:

T - record type that the format produces or consumes.

所有已实现的接口:

TableFactory, TableFormatFactory<T>

@PublicEvolving
public abstract class TableFormatFactoryBase<T>
extends Object
implements TableFormatFactory<T>

Base class for TableFormatFactorys.

构造器概要

构造器

构造器和说明
TableFormatFactoryBase(String type, int version, boolean supportsSchemaDerivation)

方法概要

限定符和类型	方法和说明
static TableSchema	deriveSchema(Map<String,String> properties) Finds the table schema that can be used for a format schema (without time attributes and generated columns).
Map<String,String>	requiredContext() Specifies the context that this factory has been implemented for.
protected Map<String,String>	requiredFormatContext() Format specific context.
protected List<String>	supportedFormatProperties() Format specific supported properties.
List<String>	supportedProperties() List of format property keys that this factory can handle.
boolean	supportsSchemaDerivation() Flag to indicate if the given format supports deriving information from a schema.

从类继承的方法 java.lang.Object

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

构造器详细资料

TableFormatFactoryBase

public TableFormatFactoryBase(String type,
                              int version,
                              boolean supportsSchemaDerivation)

方法详细资料

requiredContext

public final Map<String,String> requiredContext()

从接口复制的说明: 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.

指定者:

requiredContext 在接口中 TableFactory

supportsSchemaDerivation

public final boolean supportsSchemaDerivation()

从接口复制的说明: TableFormatFactory

Flag to indicate if the given format supports deriving information from a schema. If the format can handle schema information, those properties must be added to the list of supported properties.

指定者:

supportsSchemaDerivation 在接口中 TableFormatFactory<T>

supportedProperties

public final List<String> supportedProperties()

从接口复制的说明: TableFormatFactory

List of format 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 format properties might be: - format.line-delimiter - format.ignore-parse-errors - format.fields.#.type - format.fields.#.name

If schema derivation is enabled, the list must include schema properties: - schema.#.name - schema.#.type

Note: All supported format properties must be prefixed with "format.". If schema derivation is enabled, also properties with "schema." prefix can be used.

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.

See also TableFactory.supportedProperties() for more information.

指定者:

supportedProperties 在接口中 TableFactory

指定者:

supportedProperties 在接口中 TableFormatFactory<T>

requiredFormatContext

protected Map<String,String> requiredFormatContext()

Format specific context.

This method can be used if format type and a property version is not enough.

supportedFormatProperties

protected List<String> supportedFormatProperties()

Format specific supported properties.

This method can be used if schema derivation is not enough.

deriveSchema

public static TableSchema deriveSchema(Map<String,String> properties)

Finds the table schema that can be used for a format schema (without time attributes and generated columns).