org.apache.flink.formats.json.ogg

Class OggJsonDecodingFormat

java.lang.Object

org.apache.flink.formats.json.ogg.OggJsonDecodingFormat

All Implemented Interfaces:

DecodingFormat<DeserializationSchema<RowData>>, Format

public class OggJsonDecodingFormat
extends Object
implements DecodingFormat<DeserializationSchema<RowData>>

DecodingFormat for Ogg using JSON encoding.

Constructor Summary

Constructors

Constructor and Description
OggJsonDecodingFormat(boolean ignoreParseErrors, TimestampFormat timestampFormat)

Method Summary

Modifier and Type	Method and Description
void	applyReadableMetadata(List<String> metadataKeys) Provides a list of metadata keys that the produced row must contain as appended metadata columns.
DeserializationSchema<RowData>	createRuntimeDecoder(DynamicTableSource.Context context, DataType physicalDataType) Creates runtime decoder implementation that is configured to produce data of the given data type.
ChangelogMode	getChangelogMode() Returns the set of changes that a connector (and transitively the planner) can expect during runtime.
Map<String,DataType>	listReadableMetadata() Returns the map of metadata keys and their corresponding data types that can be produced by this format for reading.

Methods inherited from class java.lang.Object

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

Constructor Detail

OggJsonDecodingFormat

public OggJsonDecodingFormat(boolean ignoreParseErrors,
                             TimestampFormat timestampFormat)

Method Detail

createRuntimeDecoder

public DeserializationSchema<RowData> createRuntimeDecoder(DynamicTableSource.Context context,
                                                           DataType physicalDataType)

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<DeserializationSchema<RowData>>

Parameters:

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

physicalDataType - For more details check the documentation of DecodingFormat.

listReadableMetadata

public Map<String,DataType> listReadableMetadata()

Description copied from interface: DecodingFormat

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().

Specified by:

listReadableMetadata in interface DecodingFormat<DeserializationSchema<RowData>>

applyReadableMetadata

public void applyReadableMetadata(List<String> metadataKeys)

Description copied from interface: DecodingFormat

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).

Specified by:

applyReadableMetadata in interface DecodingFormat<DeserializationSchema<RowData>>

getChangelogMode

public ChangelogMode getChangelogMode()

Description copied from interface: Format

Returns the set of changes that a connector (and transitively the planner) can expect during runtime.

Specified by:

getChangelogMode in interface Format