org.apache.flink.connector.pulsar.table

Class PulsarDynamicTableSink

java.lang.Object

org.apache.flink.connector.pulsar.table.PulsarDynamicTableSink

All Implemented Interfaces:

SupportsWritingMetadata, org.apache.flink.table.connector.sink.DynamicTableSink

public class PulsarDynamicTableSink
extends Object
implements org.apache.flink.table.connector.sink.DynamicTableSink, SupportsWritingMetadata

pulsar dynamic table sink.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.flink.table.connector.sink.DynamicTableSink

org.apache.flink.table.connector.sink.DynamicTableSink.Context, org.apache.flink.table.connector.sink.DynamicTableSink.DataStructureConverter, org.apache.flink.table.connector.sink.DynamicTableSink.SinkRuntimeProvider

Field Summary

Fields

Modifier and Type	Field and Description
protected String	adminUrl
protected org.apache.flink.table.connector.format.EncodingFormat<org.apache.flink.api.common.serialization.SerializationSchema<org.apache.flink.table.data.RowData>>	encodingFormat Sink format for encoding records to pulsar.
protected List<String>	metadataKeys Metadata that is appended at the end of a physical sink row.
protected org.apache.flink.table.types.DataType	physicalDataType Data type to configure the format.
protected Properties	properties Properties for the pulsar producer.
protected String	serviceUrl
protected String	topic The pulsar topic to write to.
protected boolean	useExtendField

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	PulsarDynamicTableSink(String serviceUrl, String adminUrl, String topic, org.apache.flink.table.types.DataType physicalDataType, Properties properties, org.apache.flink.table.connector.format.EncodingFormat<org.apache.flink.api.common.serialization.SerializationSchema<org.apache.flink.table.data.RowData>> encodingFormat)

Method Summary

Modifier and Type	Method and Description
void	applyWritableMetadata(List<String> metadataKeys, org.apache.flink.table.types.DataType consumedDataType) Provides a list of metadata keys that the consumed RowData will contain as appended metadata columns which must be persisted.
String	asSummaryString()
org.apache.flink.table.connector.sink.DynamicTableSink	copy()
boolean	equals(Object o)
org.apache.flink.table.connector.ChangelogMode	getChangelogMode(org.apache.flink.table.connector.ChangelogMode requestedMode)
org.apache.flink.table.connector.sink.DynamicTableSink.SinkRuntimeProvider	getSinkRuntimeProvider(org.apache.flink.table.connector.sink.DynamicTableSink.Context context)
int	hashCode()
Map<String,org.apache.flink.table.types.DataType>	listWritableMetadata() Returns the map of metadata keys and their corresponding data types that can be consumed by this table sink for writing.

Methods inherited from class java.lang.Object

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

Field Detail

metadataKeys

protected List<String> metadataKeys

Metadata that is appended at the end of a physical sink row.

physicalDataType

protected org.apache.flink.table.types.DataType physicalDataType

Data type to configure the format.

topic

protected final String topic

The pulsar topic to write to.

serviceUrl

protected final String serviceUrl

adminUrl

protected final String adminUrl

properties

protected final Properties properties

Properties for the pulsar producer.

useExtendField

protected final boolean useExtendField

encodingFormat

protected final org.apache.flink.table.connector.format.EncodingFormat<org.apache.flink.api.common.serialization.SerializationSchema<org.apache.flink.table.data.RowData>> encodingFormat

Sink format for encoding records to pulsar.

Constructor Detail

PulsarDynamicTableSink

protected PulsarDynamicTableSink(String serviceUrl,
                                 String adminUrl,
                                 String topic,
                                 org.apache.flink.table.types.DataType physicalDataType,
                                 Properties properties,
                                 org.apache.flink.table.connector.format.EncodingFormat<org.apache.flink.api.common.serialization.SerializationSchema<org.apache.flink.table.data.RowData>> encodingFormat)

Method Detail

getChangelogMode

public org.apache.flink.table.connector.ChangelogMode getChangelogMode(org.apache.flink.table.connector.ChangelogMode requestedMode)

Specified by:

getChangelogMode in interface org.apache.flink.table.connector.sink.DynamicTableSink

getSinkRuntimeProvider

public org.apache.flink.table.connector.sink.DynamicTableSink.SinkRuntimeProvider getSinkRuntimeProvider(org.apache.flink.table.connector.sink.DynamicTableSink.Context context)

Specified by:

getSinkRuntimeProvider in interface org.apache.flink.table.connector.sink.DynamicTableSink

copy

public org.apache.flink.table.connector.sink.DynamicTableSink copy()

Specified by:

copy in interface org.apache.flink.table.connector.sink.DynamicTableSink

asSummaryString

public String asSummaryString()

Specified by:

asSummaryString in interface org.apache.flink.table.connector.sink.DynamicTableSink

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

listWritableMetadata

public Map<String,org.apache.flink.table.types.DataType> listWritableMetadata()

Description copied from interface: SupportsWritingMetadata

Returns the map of metadata keys and their corresponding data types that can be consumed by this table sink for writing.

The returned map will be used by the planner for validation and insertion of explicit casts (see LogicalTypeCasts.supportsExplicitCast(LogicalType, LogicalType)) if necessary.

The iteration order of the returned map determines the order of metadata keys in the list passed in SupportsWritingMetadata.applyWritableMetadata(List, DataType). Therefore, it might be beneficial to return a LinkedHashMap if a strict metadata column order is required.

If a sink forwards metadata to one or more formats, we recommend the following column order for consistency:

   KEY FORMAT METADATA COLUMNS + VALUE FORMAT METADATA COLUMNS + SINK METADATA COLUMNS
 

Metadata key names follow the same pattern as mentioned in Factory. In case of duplicate names in format and sink keys, format keys shall have higher precedence.

Regardless of the returned DataTypes, a metadata column is always represented using internal data structures (see RowData).

Specified by:

listWritableMetadata in interface SupportsWritingMetadata

applyWritableMetadata

public void applyWritableMetadata(List<String> metadataKeys,
                                  org.apache.flink.table.types.DataType consumedDataType)

Description copied from interface: SupportsWritingMetadata

Provides a list of metadata keys that the consumed RowData will contain as appended metadata columns which must be persisted.

Specified by:

applyWritableMetadata in interface SupportsWritingMetadata

Parameters:

metadataKeys - a subset of the keys returned by SupportsWritingMetadata.listWritableMetadata(), ordered by the iteration order of returned map

consumedDataType - the final input type of the sink