org.apache.flink.connector.pulsar.table.sink

Class PulsarTableSerializationSchema

java.lang.Object

org.apache.flink.connector.pulsar.table.sink.PulsarTableSerializationSchema

All Implemented Interfaces:

Serializable, PulsarSerializationSchema<org.apache.flink.table.data.RowData>

public class PulsarTableSerializationSchema
extends Object
implements PulsarSerializationSchema<org.apache.flink.table.data.RowData>

A PulsarSerializationSchema implementation for Pulsar SQL sink connector. It is responsible for retrieving fields from Flink row and serialize into Pulsar message key or body, and set necessary metadata fields as required.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	PulsarTableSerializationSchema.MetadataConverter A class to read fields from Flink row and map to a Pulsar metadata.

Constructor Summary

Constructors

Constructor and Description

PulsarTableSerializationSchema(org.apache.flink.api.common.serialization.SerializationSchema<org.apache.flink.table.data.RowData> keySerialization, org.apache.flink.table.data.RowData.FieldGetter[] keyFieldGetters, org.apache.flink.api.common.serialization.SerializationSchema<org.apache.flink.table.data.RowData> valueSerialization, org.apache.flink.table.data.RowData.FieldGetter[] valueFieldGetters, PulsarWritableMetadata writableMetadata)

Method Summary

Modifier and Type	Method and Description
void	open(org.apache.flink.api.common.serialization.SerializationSchema.InitializationContext initializationContext, PulsarSinkContext sinkContext, SinkConfiguration sinkConfiguration) Initialization method for the schema.
PulsarMessage<?>	serialize(org.apache.flink.table.data.RowData consumedRow, PulsarSinkContext sinkContext) Serializes the given element into bytes and Schema.BYTES.

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.connector.pulsar.sink.writer.serializer.PulsarSerializationSchema

flinkSchema, pulsarSchema, pulsarSchema, pulsarSchema

Constructor Detail

PulsarTableSerializationSchema

public PulsarTableSerializationSchema(@Nullable
                                      org.apache.flink.api.common.serialization.SerializationSchema<org.apache.flink.table.data.RowData> keySerialization,
                                      org.apache.flink.table.data.RowData.FieldGetter[] keyFieldGetters,
                                      org.apache.flink.api.common.serialization.SerializationSchema<org.apache.flink.table.data.RowData> valueSerialization,
                                      org.apache.flink.table.data.RowData.FieldGetter[] valueFieldGetters,
                                      PulsarWritableMetadata writableMetadata)

Method Detail

open

public void open(org.apache.flink.api.common.serialization.SerializationSchema.InitializationContext initializationContext,
                 PulsarSinkContext sinkContext,
                 SinkConfiguration sinkConfiguration)
          throws Exception

Description copied from interface: PulsarSerializationSchema

Initialization method for the schema. It is called before the actual working methods PulsarSerializationSchema.serialize(Object, PulsarSinkContext) and thus suitable for one-time setup work.

The provided SerializationSchema.InitializationContext can be used to access additional features such as registering user metrics.

Specified by:

open in interface PulsarSerializationSchema<org.apache.flink.table.data.RowData>

Parameters:

initializationContext - Contextual information that can be used during initialization.

sinkContext - Runtime information i.e. partitions, subtaskId.

sinkConfiguration - All the configure options for the Pulsar sink. You can add custom options.

Throws:

Exception

serialize

public PulsarMessage<?> serialize(org.apache.flink.table.data.RowData consumedRow,
                                  PulsarSinkContext sinkContext)

Description copied from interface: PulsarSerializationSchema

Serializes the given element into bytes and Schema.BYTES. Or you can convert it to a new type of instance with a Schema. The return value PulsarMessage can be built by PulsarMessageBuilder. All the methods provided in the PulsarMessageBuilder is just equals to the TypedMessageBuilder.

Specified by:

serialize in interface PulsarSerializationSchema<org.apache.flink.table.data.RowData>

Parameters:

consumedRow - Element to be serialized.

sinkContext - Context to provide extra information.