org.apache.hudi.common.model.debezium

Class AbstractDebeziumAvroPayload

java.lang.Object

org.apache.hudi.common.model.BaseAvroPayload

org.apache.hudi.common.model.OverwriteWithLatestAvroPayload

org.apache.hudi.common.model.debezium.AbstractDebeziumAvroPayload

All Implemented Interfaces:

Serializable, HoodieRecordPayload<OverwriteWithLatestAvroPayload>

Direct Known Subclasses:

MySqlDebeziumAvroPayload, PostgresDebeziumAvroPayload

public abstract class AbstractDebeziumAvroPayload
extends OverwriteWithLatestAvroPayload

Base class that provides support for seamlessly applying changes captured via Debezium.

Debezium change event types are determined for the op field in the payload

- For inserts, op=i - For deletes, op=d - For updates, op=u - For snapshot inserts, op=r

This payload implementation will issue matching insert, delete, updates against the hudi table

See Also:

Serialized Form

Field Summary

Fields inherited from class org.apache.hudi.common.model.BaseAvroPayload

isDeletedRecord, orderingVal, recordBytes

Constructor Summary

Constructors

Constructor and Description
AbstractDebeziumAvroPayload(org.apache.avro.generic.GenericRecord record, Comparable orderingVal)
AbstractDebeziumAvroPayload(Option<org.apache.avro.generic.GenericRecord> record)

Method Summary

Modifier and Type	Method and Description
Option<org.apache.avro.generic.IndexedRecord>	combineAndGetUpdateValue(org.apache.avro.generic.IndexedRecord currentValue, org.apache.avro.Schema schema) This methods is deprecated.
Option<org.apache.avro.generic.IndexedRecord>	getInsertValue(org.apache.avro.Schema schema) This method is deprecated.
protected boolean	isDeleteRecord(org.apache.avro.generic.GenericRecord record)
protected abstract boolean	shouldPickCurrentRecord(org.apache.avro.generic.IndexedRecord currentRecord, org.apache.avro.generic.IndexedRecord insertRecord, org.apache.avro.Schema schema)

Methods inherited from class org.apache.hudi.common.model.OverwriteWithLatestAvroPayload

getOrderingValue, overwriteField, preCombine

Methods inherited from class org.apache.hudi.common.model.BaseAvroPayload

canProduceSentinel, getOrderingVal, isDeleted

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.hudi.common.model.HoodieRecordPayload

combineAndGetUpdateValue, getInsertValue, getMetadata, preCombine, preCombine

Constructor Detail

AbstractDebeziumAvroPayload

public AbstractDebeziumAvroPayload(org.apache.avro.generic.GenericRecord record,
                                   Comparable orderingVal)

AbstractDebeziumAvroPayload

public AbstractDebeziumAvroPayload(Option<org.apache.avro.generic.GenericRecord> record)

Method Detail

getInsertValue

public Option<org.apache.avro.generic.IndexedRecord> getInsertValue(org.apache.avro.Schema schema)
                                                             throws IOException

Description copied from interface: HoodieRecordPayload

This method is deprecated. Refer to HoodieRecordPayload.getInsertValue(Schema, Properties) for java docs.

Specified by:

getInsertValue in interface HoodieRecordPayload<OverwriteWithLatestAvroPayload>

Overrides:

getInsertValue in class OverwriteWithLatestAvroPayload

Parameters:

schema - Schema used for record

Returns:

the IndexedRecord to be inserted.

Throws:

IOException

combineAndGetUpdateValue

public Option<org.apache.avro.generic.IndexedRecord> combineAndGetUpdateValue(org.apache.avro.generic.IndexedRecord currentValue,
                                                                              org.apache.avro.Schema schema)
                                                                       throws IOException

Description copied from interface: HoodieRecordPayload

This methods is deprecated. Please refer to HoodieRecordPayload.combineAndGetUpdateValue(IndexedRecord, Schema, Properties) for java docs.

Specified by:

combineAndGetUpdateValue in interface HoodieRecordPayload<OverwriteWithLatestAvroPayload>

Overrides:

combineAndGetUpdateValue in class OverwriteWithLatestAvroPayload

Throws:

IOException

shouldPickCurrentRecord

protected abstract boolean shouldPickCurrentRecord(org.apache.avro.generic.IndexedRecord currentRecord,
                                                   org.apache.avro.generic.IndexedRecord insertRecord,
                                                   org.apache.avro.Schema schema)
                                            throws IOException

Throws:

IOException

isDeleteRecord

protected boolean isDeleteRecord(org.apache.avro.generic.GenericRecord record)

Overrides:

isDeleteRecord in class BaseAvroPayload

Parameters:

record - instance of GenericRecord of interest.