Package org.apache.flink.cdc.common.event

Class DataChangeEvent

java.lang.Object

org.apache.flink.cdc.common.event.DataChangeEvent

All Implemented Interfaces:

Serializable, ChangeEvent, Event

@PublicEvolving
public class DataChangeEvent
extends Object
implements ChangeEvent, Serializable

Class DataChangeEvent represents the data change events of external systems, such as INSERT, UPDATE, DELETE and so on.

See Also:

Serialized Form

Method Summary

Modifier and Type	Method	Description
RecordData	after()
RecordData	before()
static DataChangeEvent	deleteEvent(TableId tableId, RecordData before)	Creates a DataChangeEvent instance that describes the delete event.
static DataChangeEvent	deleteEvent(TableId tableId, RecordData before, Map<String,String> meta)	Creates a DataChangeEvent instance that describes the delete event with meta info.
String	describeMeta()	Creates a string to describe the information of meta.
boolean	equals(Object o)
int	hashCode()
static DataChangeEvent	insertEvent(TableId tableId, RecordData after)	Creates a DataChangeEvent instance that describes the insert event.
static DataChangeEvent	insertEvent(TableId tableId, RecordData after, Map<String,String> meta)	Creates a DataChangeEvent instance that describes the insert event with meta info.
Map<String,String>	meta()
OperationType	op()
String	opTypeString(boolean isAfter)
static DataChangeEvent	projectAfter(DataChangeEvent dataChangeEvent, RecordData projectedAfter)	Updates the after of a DataChangeEvent instance that describes the event with meta info.
static DataChangeEvent	projectBefore(DataChangeEvent dataChangeEvent, RecordData projectedBefore)	Updates the before of a DataChangeEvent instance that describes the event with meta info.
static DataChangeEvent	projectRecords(DataChangeEvent dataChangeEvent, RecordData projectedBefore, RecordData projectedAfter)	Updates the after of a DataChangeEvent instance that describes the event with meta info.
static DataChangeEvent	replaceEvent(TableId tableId, RecordData after)	Creates a DataChangeEvent instance that describes the replace event.
static DataChangeEvent	replaceEvent(TableId tableId, RecordData after, Map<String,String> meta)	Creates a DataChangeEvent instance that describes the replace event with meta info.
static DataChangeEvent	route(DataChangeEvent dataChangeEvent, TableId tableId)	Updates the TableId info of current data change event.
TableId	tableId()	Describes the database table corresponding to the occurrence of a change event.
String	toReadableString(java.util.function.Function<RecordData,?> extractor)
String	toString()
static DataChangeEvent	updateEvent(TableId tableId, RecordData before, RecordData after)	Creates a DataChangeEvent instance that describes the update event.
static DataChangeEvent	updateEvent(TableId tableId, RecordData before, RecordData after, Map<String,String> meta)	Creates a DataChangeEvent instance that describes the update event with meta info.

Methods inherited from class java.lang.Object

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

Method Detail

tableId

public TableId tableId()

Description copied from interface: ChangeEvent

Describes the database table corresponding to the occurrence of a change event.

Specified by:

tableId in interface ChangeEvent

before

public RecordData before()

after

public RecordData after()

op

public OperationType op()

opTypeString

public String opTypeString(boolean isAfter)

meta

public Map<String,String> meta()

insertEvent

public static DataChangeEvent insertEvent(TableId tableId,
                                          RecordData after)

Creates a DataChangeEvent instance that describes the insert event.

insertEvent

public static DataChangeEvent insertEvent(TableId tableId,
                                          RecordData after,
                                          Map<String,String> meta)

Creates a DataChangeEvent instance that describes the insert event with meta info.

deleteEvent

public static DataChangeEvent deleteEvent(TableId tableId,
                                          RecordData before)

Creates a DataChangeEvent instance that describes the delete event.

deleteEvent

public static DataChangeEvent deleteEvent(TableId tableId,
                                          RecordData before,
                                          Map<String,String> meta)

Creates a DataChangeEvent instance that describes the delete event with meta info.

updateEvent

public static DataChangeEvent updateEvent(TableId tableId,
                                          RecordData before,
                                          RecordData after)

Creates a DataChangeEvent instance that describes the update event.

updateEvent

public static DataChangeEvent updateEvent(TableId tableId,
                                          RecordData before,
                                          RecordData after,
                                          Map<String,String> meta)

Creates a DataChangeEvent instance that describes the update event with meta info.

replaceEvent

public static DataChangeEvent replaceEvent(TableId tableId,
                                           RecordData after)

Creates a DataChangeEvent instance that describes the replace event.

replaceEvent

public static DataChangeEvent replaceEvent(TableId tableId,
                                           RecordData after,
                                           Map<String,String> meta)

Creates a DataChangeEvent instance that describes the replace event with meta info.

projectBefore

public static DataChangeEvent projectBefore(DataChangeEvent dataChangeEvent,
                                            RecordData projectedBefore)

Updates the before of a DataChangeEvent instance that describes the event with meta info.

projectAfter

public static DataChangeEvent projectAfter(DataChangeEvent dataChangeEvent,
                                           RecordData projectedAfter)

Updates the after of a DataChangeEvent instance that describes the event with meta info.

projectRecords

public static DataChangeEvent projectRecords(DataChangeEvent dataChangeEvent,
                                             RecordData projectedBefore,
                                             RecordData projectedAfter)

Updates the after of a DataChangeEvent instance that describes the event with meta info.

route

public static DataChangeEvent route(DataChangeEvent dataChangeEvent,
                                    TableId tableId)

Updates the TableId info of current data change event.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

describeMeta

public String describeMeta()

Creates a string to describe the information of meta.

toReadableString

public String toReadableString(java.util.function.Function<RecordData,?> extractor)

toString

public String toString()

Overrides:

toString in class Object