Package org.apache.flink.cdc.connectors.paimon.sink

Class PaimonMetadataApplier

java.lang.Object

org.apache.flink.cdc.connectors.paimon.sink.PaimonMetadataApplier

All Implemented Interfaces:

Serializable, AutoCloseable, ExistingTableSchemaExpansionSupport, MetadataApplier

public class PaimonMetadataApplier
extends Object
implements MetadataApplier, ExistingTableSchemaExpansionSupport

A MetadataApplier that applies metadata changes to Paimon. Support primary key table only.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
PaimonMetadataApplier(org.apache.paimon.options.Options catalogOptions)
PaimonMetadataApplier(org.apache.paimon.options.Options catalogOptions, Map<String,String> tableOptions, Map<TableId,List<String>> partitionMaps)

Method Summary

Modifier and Type	Method	Description
boolean	acceptsSchemaEvolutionType(SchemaChangeEventType schemaChangeEventType)	Checks if this metadata applier should this event type.
void	applySchemaChange(SchemaChangeEvent schemaChangeEvent)	Apply the given SchemaChangeEvent to external systems.
void	close()	Closes the metadata applier and its underlying resources.
Optional<Schema>	getExistingTableSchema(TableId tableId)	Returns the current schema of the target table, or Optional.empty() if the table does not exist.
Optional<ExistingTableSchemaExpansionSupport>	getExistingTableSchemaExpansionSupport()	Returns optional support for safely expanding an existing target table schema.
Set<SchemaChangeEventType>	getSupportedSchemaEvolutionTypes()	Checks what kind of schema change events downstream can handle.
boolean	isColumnNameCaseSensitive()	Returns whether target column names are matched case-sensitively.
DataType	normalizeToTargetDataType(TableId tableId, String columnName, DataType pipelineDataType, Schema existingTargetSchema)	Converts a pipeline type to the canonical CDC representation of the physical type that this applier will create in the existing target table.
MetadataApplier	setAcceptedSchemaEvolutionTypes(Set<SchemaChangeEventType> schemaEvolutionTypes)	Sets enabled schema evolution event types of current metadata applier.

Methods inherited from class java.lang.Object

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

Constructor Detail

PaimonMetadataApplier

public PaimonMetadataApplier(org.apache.paimon.options.Options catalogOptions)

PaimonMetadataApplier

public PaimonMetadataApplier(org.apache.paimon.options.Options catalogOptions,
                             Map<String,String> tableOptions,
                             Map<TableId,List<String>> partitionMaps)

Method Detail

setAcceptedSchemaEvolutionTypes

public MetadataApplier setAcceptedSchemaEvolutionTypes(Set<SchemaChangeEventType> schemaEvolutionTypes)

Description copied from interface: MetadataApplier

Sets enabled schema evolution event types of current metadata applier.

Specified by:

setAcceptedSchemaEvolutionTypes in interface MetadataApplier

acceptsSchemaEvolutionType

public boolean acceptsSchemaEvolutionType(SchemaChangeEventType schemaChangeEventType)

Description copied from interface: MetadataApplier

Checks if this metadata applier should this event type.

Specified by:

acceptsSchemaEvolutionType in interface MetadataApplier

getSupportedSchemaEvolutionTypes

public Set<SchemaChangeEventType> getSupportedSchemaEvolutionTypes()

Description copied from interface: MetadataApplier

Checks what kind of schema change events downstream can handle.

Specified by:

getSupportedSchemaEvolutionTypes in interface MetadataApplier

getExistingTableSchemaExpansionSupport

public Optional<ExistingTableSchemaExpansionSupport> getExistingTableSchemaExpansionSupport()

Description copied from interface: MetadataApplier

Returns optional support for safely expanding an existing target table schema.

Specified by:

getExistingTableSchemaExpansionSupport in interface MetadataApplier

getExistingTableSchema

public Optional<Schema> getExistingTableSchema(TableId tableId)

Description copied from interface: ExistingTableSchemaExpansionSupport

Returns the current schema of the target table, or Optional.empty() if the table does not exist. Target physical types must be converted to the same canonical CDC representation produced by ExistingTableSchemaExpansionSupport.normalizeToTargetDataType(TableId, String, DataType, Schema). The returned schema should include any table options that affect physical type mapping.

Specified by:

getExistingTableSchema in interface ExistingTableSchemaExpansionSupport

normalizeToTargetDataType

public DataType normalizeToTargetDataType(TableId tableId,
                                          String columnName,
                                          DataType pipelineDataType,
                                          Schema existingTargetSchema)

Description copied from interface: ExistingTableSchemaExpansionSupport

Converts a pipeline type to the canonical CDC representation of the physical type that this applier will create in the existing target table. For example, if both CHAR(n) and VARCHAR(n) map to target VARCHAR(n), this method should return the same VARCHAR(n) representation for both input types. The existing target schema provides table options needed by sinks whose type mapping depends on table properties.

This method must not query or modify the target table.

Specified by:

normalizeToTargetDataType in interface ExistingTableSchemaExpansionSupport

isColumnNameCaseSensitive

public boolean isColumnNameCaseSensitive()

Description copied from interface: ExistingTableSchemaExpansionSupport

Returns whether target column names are matched case-sensitively.

Specified by:

isColumnNameCaseSensitive in interface ExistingTableSchemaExpansionSupport

applySchemaChange

public void applySchemaChange(SchemaChangeEvent schemaChangeEvent)
                       throws SchemaEvolveException

Description copied from interface: MetadataApplier

Apply the given SchemaChangeEvent to external systems.

Specified by:

applySchemaChange in interface MetadataApplier

Throws:

SchemaEvolveException

close

public void close()
           throws Exception

Description copied from interface: MetadataApplier

Closes the metadata applier and its underlying resources.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface MetadataApplier

Throws:

Exception