org.apache.flink.table.connector.format

接口 DecodingFormat<I>

类型参数:

I - runtime interface needed by the table source

所有超级接口:

Format

所有已知子接口:

BulkDecodingFormat<T>

@PublicEvolving
public interface DecodingFormat<I>
extends Format

A Format for a DynamicTableSource for reading rows.

方法概要

限定符和类型	方法和说明
default void	applyReadableMetadata(List<String> metadataKeys) Provides a list of metadata keys that the produced row must contain as appended metadata columns.
I	createRuntimeDecoder(DynamicTableSource.Context context, DataType physicalDataType) Creates runtime decoder implementation that is configured to produce data of the given data type.
default Map<String,DataType>	listReadableMetadata() Returns the map of metadata keys and their corresponding data types that can be produced by this format for reading.

从接口继承的方法 org.apache.flink.table.connector.format.Format

getChangelogMode

方法详细资料

createRuntimeDecoder

I createRuntimeDecoder(DynamicTableSource.Context context,
                       DataType physicalDataType)

Creates runtime decoder implementation that is configured to produce data of the given data type.

listReadableMetadata

default Map<String,DataType> listReadableMetadata()

Returns the map of metadata keys and their corresponding data types that can be produced by this format for reading. By default, this method returns an empty map.

Metadata columns add additional columns to the table's schema. A decoding format is responsible to add requested metadata columns at the end of produced rows.

See SupportsReadingMetadata for more information.

Note: This method is only used if the outer DynamicTableSource implements SupportsReadingMetadata and calls this method in SupportsReadingMetadata.listReadableMetadata().

applyReadableMetadata

default void applyReadableMetadata(List<String> metadataKeys)

Provides a list of metadata keys that the produced row must contain as appended metadata columns. By default, this method throws an exception if metadata keys are defined.

See SupportsReadingMetadata for more information.

Note: This method is only used if the outer DynamicTableSource implements SupportsReadingMetadata and calls this method in SupportsReadingMetadata.applyReadableMetadata(List, DataType).