org.apache.flink.table.connector.format

Interface ProjectableDecodingFormat<I>

All Superinterfaces:

DecodingFormat<I>, Format

All Known Implementing Classes:

CanalJsonDecodingFormat, CsvFileFormatFactory.CsvBulkDecodingFormat, DebeziumJsonDecodingFormat, MaxwellJsonDecodingFormat, OrcFileFormatFactory.OrcBulkDecodingFormat, ParquetFileFormatFactory.ParquetBulkDecodingFormat

@PublicEvolving
public interface ProjectableDecodingFormat<I>
extends DecodingFormat<I>

Extension of DecodingFormat which is able to produce projected rows.

For more details on usage and differences between DecodingFormat and ProjectableDecodingFormat, check the documentation of DecodingFormat.

See Also:

Projection, ProjectedRowData

Method Summary

Modifier and Type	Method and Description
default I	createRuntimeDecoder(DynamicTableSource.Context context, DataType projectedPhysicalDataType) Creates runtime decoder implementation that is configured to produce data of the given data type.
I	createRuntimeDecoder(DynamicTableSource.Context context, DataType physicalDataType, int[][] projections) Creates runtime decoder implementation that is configured to produce data of type Projection.of(projections).project(physicalDataType).
default boolean	supportsNestedProjection() Returns whether this format supports nested projection.

Methods inherited from interface org.apache.flink.table.connector.format.DecodingFormat

applyReadableMetadata, listReadableMetadata

Methods inherited from interface org.apache.flink.table.connector.format.Format

getChangelogMode

Method Detail

supportsNestedProjection

default boolean supportsNestedProjection()

Returns whether this format supports nested projection.

createRuntimeDecoder

I createRuntimeDecoder(DynamicTableSource.Context context,
                       DataType physicalDataType,
                       int[][] projections)

Creates runtime decoder implementation that is configured to produce data of type Projection.of(projections).project(physicalDataType). For more details on the usage, check DecodingFormat documentation.

Parameters:

context - the context provides several utilities required to instantiate the runtime decoder implementation of the format

physicalDataType - For more details check DecodingFormat

projections - the projections array. The array represents the mapping of the fields of the original DataType, including nested rows. For example, [[0, 2, 1], ...] specifies to include the 2nd field of the 3rd field of the 1st field in the top-level row. It's guaranteed that this array won't contain nested projections if supportsNestedProjection() returns false. For more details, check Projection as well.

Returns:

the runtime decoder

See Also:

DecodingFormat

createRuntimeDecoder

default I createRuntimeDecoder(DynamicTableSource.Context context,
                               DataType projectedPhysicalDataType)

Description copied from interface: DecodingFormat

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

Specified by:

createRuntimeDecoder in interface DecodingFormat<I>

Parameters:

context - the context provides several utilities required to instantiate the runtime decoder implementation of the format

projectedPhysicalDataType - For more details check the documentation of DecodingFormat.