org.apache.flink.connector.pulsar.table.source

Class PulsarTableDeserializationSchema

java.lang.Object

org.apache.flink.connector.pulsar.table.source.PulsarTableDeserializationSchema

All Implemented Interfaces:

Serializable, org.apache.flink.api.java.typeutils.ResultTypeQueryable<org.apache.flink.table.data.RowData>, PulsarDeserializationSchema<org.apache.flink.table.data.RowData>

public class PulsarTableDeserializationSchema
extends Object
implements PulsarDeserializationSchema<org.apache.flink.table.data.RowData>

A specific PulsarDeserializationSchema for PulsarTableSource.

Both Flink's key decoding format and value decoding format are wrapped in this class. It is responsible for getting metadata fields from a physical pulsar message body, and the final projection mapping from Pulsar message fields to Flink row.

After retrieving key and value bytes and convert them into a list of RowData, it then delegates metadata appending, key and value RowData combining to a PulsarRowDataConverter instance.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description

PulsarTableDeserializationSchema(org.apache.flink.api.common.serialization.DeserializationSchema<org.apache.flink.table.data.RowData> keyDeserialization, org.apache.flink.api.common.serialization.DeserializationSchema<org.apache.flink.table.data.RowData> valueDeserialization, org.apache.flink.api.common.typeinfo.TypeInformation<org.apache.flink.table.data.RowData> producedTypeInfo, PulsarRowDataConverter rowDataConverter)

Method Summary

Modifier and Type	Method and Description
void	deserialize(org.apache.pulsar.client.api.Message<?> message, org.apache.flink.util.Collector<org.apache.flink.table.data.RowData> collector) Deserializes the pulsar message.
org.apache.flink.api.common.typeinfo.TypeInformation<org.apache.flink.table.data.RowData>	getProducedType()
void	open(org.apache.flink.api.common.serialization.DeserializationSchema.InitializationContext context, SourceConfiguration configuration) Initialization method for the schema.
org.apache.pulsar.client.api.Schema<?>	schema() By default, deserializers will decode bytes array message.

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.source.reader.deserializer.PulsarDeserializationSchema

flinkSchema, flinkTypeInfo, open, pulsarSchema, pulsarSchema, pulsarSchema

Constructor Detail

PulsarTableDeserializationSchema

public PulsarTableDeserializationSchema(@Nullable
                                        org.apache.flink.api.common.serialization.DeserializationSchema<org.apache.flink.table.data.RowData> keyDeserialization,
                                        org.apache.flink.api.common.serialization.DeserializationSchema<org.apache.flink.table.data.RowData> valueDeserialization,
                                        org.apache.flink.api.common.typeinfo.TypeInformation<org.apache.flink.table.data.RowData> producedTypeInfo,
                                        PulsarRowDataConverter rowDataConverter)

Method Detail

open

public void open(org.apache.flink.api.common.serialization.DeserializationSchema.InitializationContext context,
                 SourceConfiguration configuration)
          throws Exception

Description copied from interface: PulsarDeserializationSchema

Initialization method for the schema. It is called before the actual working methods PulsarDeserializationSchema.deserialize(org.apache.pulsar.client.api.Message<?>, org.apache.flink.util.Collector<T>) and thus suitable for one time setup work.

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

Specified by:

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

Parameters:

context - Contextual information that can be used during initialization.

configuration - The Pulsar related source configuration.

Throws:

Exception

deserialize

public void deserialize(org.apache.pulsar.client.api.Message<?> message,
                        org.apache.flink.util.Collector<org.apache.flink.table.data.RowData> collector)
                 throws IOException

Description copied from interface: PulsarDeserializationSchema

Deserializes the pulsar message. This message could be a raw byte message or some parsed message which decoded by pulsar schema.

You can output multiple message by using the Collector. Note that number and size of the produced records should be relatively small. Depending on the source implementation records can be buffered in memory or collecting records might delay emitting checkpoint barrier.

Specified by:

deserialize in interface PulsarDeserializationSchema<org.apache.flink.table.data.RowData>

Parameters:

message - The message decoded by pulsar.

collector - The collector to put the resulting messages.

Throws:

IOException

getProducedType

public org.apache.flink.api.common.typeinfo.TypeInformation<org.apache.flink.table.data.RowData> getProducedType()

Specified by:

getProducedType in interface org.apache.flink.api.java.typeutils.ResultTypeQueryable<org.apache.flink.table.data.RowData>

schema

public org.apache.pulsar.client.api.Schema<?> schema()

Description copied from interface: PulsarDeserializationSchema

By default, deserializers will decode bytes array message.

Specified by:

schema in interface PulsarDeserializationSchema<org.apache.flink.table.data.RowData>

Returns:

The related Pulsar Schema for this serializer.