org.apache.paimon.flink.action.cdc.format.canal

Class CanalRecordParser

java.lang.Object

org.apache.paimon.flink.action.cdc.format.AbstractRecordParser

org.apache.paimon.flink.action.cdc.format.AbstractJsonRecordParser

org.apache.paimon.flink.action.cdc.format.canal.CanalRecordParser

All Implemented Interfaces:

Serializable, org.apache.flink.api.common.functions.FlatMapFunction<CdcSourceRecord,RichCdcMultiplexRecord>, org.apache.flink.api.common.functions.Function

public class CanalRecordParser
extends AbstractJsonRecordParser

The CanalRecordParser class is responsible for parsing records from the Canal-JSON format. Canal is a database binlog multi-platform consumer, which is used to synchronize data across databases. This parser extracts relevant information from the Canal-JSON format and transforms it into a list of RichCdcMultiplexRecord objects, which represent the changes captured in the database.

The class handles different types of database operations such as INSERT, UPDATE, and DELETE, and generates corresponding RichCdcMultiplexRecord objects for each operation.

Additionally, the parser supports schema extraction, which can be used to understand the structure of the incoming data and its corresponding field types.

See Also:

Serialized Form

Field Summary

Fields inherited from class org.apache.paimon.flink.action.cdc.format.AbstractJsonRecordParser

root

Fields inherited from class org.apache.paimon.flink.action.cdc.format.AbstractRecordParser

computedColumns, FIELD_DATABASE, FIELD_TABLE, typeMapping

Constructor Summary

Constructors

Constructor and Description
CanalRecordParser(TypeMapping typeMapping, List<ComputedColumn> computedColumns)

Method Summary

Modifier and Type	Method and Description
protected String	dataField()
List<RichCdcMultiplexRecord>	extractRecords()
protected Map<String,String>	extractRowData(org.apache.paimon.shade.jackson2.com.fasterxml.jackson.databind.JsonNode record, RowType.Builder rowTypeBuilder)
protected String	format()
protected boolean	isDDL()
protected String	primaryField()

Methods inherited from class org.apache.paimon.flink.action.cdc.format.AbstractJsonRecordParser

checkNotNull, checkNotNull, extractPrimaryKeys, fillDefaultTypes, getAndCheck, getAndCheck, getDatabaseName, getTableName, mergeOldRecord, processRecord, setRoot

Methods inherited from class org.apache.paimon.flink.action.cdc.format.AbstractRecordParser

buildSchema, createRecord, evalComputedColumns, flatMap

Methods inherited from class java.lang.Object

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

Constructor Detail

CanalRecordParser

public CanalRecordParser(TypeMapping typeMapping,
                         List<ComputedColumn> computedColumns)

Method Detail

isDDL

protected boolean isDDL()

Overrides:

isDDL in class AbstractRecordParser

extractRecords

public List<RichCdcMultiplexRecord> extractRecords()

Specified by:

extractRecords in class AbstractRecordParser

primaryField

protected String primaryField()

Specified by:

primaryField in class AbstractJsonRecordParser

dataField

protected String dataField()

Specified by:

dataField in class AbstractJsonRecordParser

extractRowData

protected Map<String,String> extractRowData(org.apache.paimon.shade.jackson2.com.fasterxml.jackson.databind.JsonNode record,
                                            RowType.Builder rowTypeBuilder)

Overrides:

extractRowData in class AbstractJsonRecordParser

format

protected String format()

Specified by:

format in class AbstractRecordParser