org.apache.flink.formats.raw

Class RawFormatFactory

java.lang.Object

org.apache.flink.formats.raw.RawFormatFactory

All Implemented Interfaces:

DecodingFormatFactory<DeserializationSchema<RowData>>, DeserializationFormatFactory, EncodingFormatFactory<SerializationSchema<RowData>>, Factory, FormatFactory, SerializationFormatFactory

@Internal
public class RawFormatFactory
extends Object
implements DeserializationFormatFactory, SerializationFormatFactory

Format factory for raw format which allows to read and write raw (byte based) values as a single column.

Field Summary

Fields

Modifier and Type	Field and Description
static String	IDENTIFIER

Constructor Summary

Constructors

Constructor and Description
RawFormatFactory()

Method Summary

Modifier and Type	Method and Description
DecodingFormat<DeserializationSchema<RowData>>	createDecodingFormat(DynamicTableFactory.Context context, ReadableConfig formatOptions) Creates a format from the given context and format options.
EncodingFormat<SerializationSchema<RowData>>	createEncodingFormat(DynamicTableFactory.Context context, ReadableConfig formatOptions) Creates a format from the given context and format options.
String	factoryIdentifier() Returns a unique identifier among same factory interfaces.
Set<ConfigOption<?>>	optionalOptions() Returns a set of ConfigOption that an implementation of this factory consumes in addition to Factory.requiredOptions().
Set<ConfigOption<?>>	requiredOptions() Returns a set of ConfigOption that an implementation of this factory requires in addition to Factory.optionalOptions().

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

forwardOptions

Field Detail

IDENTIFIER

public static final String IDENTIFIER

See Also:

Constant Field Values

Constructor Detail

RawFormatFactory

public RawFormatFactory()

Method Detail

factoryIdentifier

public String factoryIdentifier()

Description copied from interface: Factory

Returns a unique identifier among same factory interfaces.

For consistency, an identifier should be declared as one lower case word (e.g. kafka). If multiple factories exist for different versions, a version should be appended using "-" (e.g. elasticsearch-7).

Specified by:

factoryIdentifier in interface Factory

requiredOptions

public Set<ConfigOption<?>> requiredOptions()

Description copied from interface: Factory

Returns a set of ConfigOption that an implementation of this factory requires in addition to Factory.optionalOptions().

See the documentation of Factory for more information.

Specified by:

requiredOptions in interface Factory

optionalOptions

public Set<ConfigOption<?>> optionalOptions()

Description copied from interface: Factory

Returns a set of ConfigOption that an implementation of this factory consumes in addition to Factory.requiredOptions().

See the documentation of Factory for more information.

Specified by:

optionalOptions in interface Factory

createDecodingFormat

public DecodingFormat<DeserializationSchema<RowData>> createDecodingFormat(DynamicTableFactory.Context context,
                                                                           ReadableConfig formatOptions)

Description copied from interface: DecodingFormatFactory

Creates a format from the given context and format options.

The format options have been projected to top-level options (e.g. from format.ignore-errors to ignore-errors).

Specified by:

createDecodingFormat in interface DecodingFormatFactory<DeserializationSchema<RowData>>

createEncodingFormat

public EncodingFormat<SerializationSchema<RowData>> createEncodingFormat(DynamicTableFactory.Context context,
                                                                         ReadableConfig formatOptions)

Description copied from interface: EncodingFormatFactory

Creates a format from the given context and format options.

The format options have been projected to top-level options (e.g. from format.ignore-errors to ignore-errors).

Specified by:

createEncodingFormat in interface EncodingFormatFactory<SerializationSchema<RowData>>