io.debezium.connector.postgresql.connection

Interface ReplicationMessage

All Known Implementing Classes:

PgOutputReplicationMessage, PgOutputTruncateReplicationMessage, PgProtoReplicationMessage, ReplicationMessage.NoopMessage, ReplicationMessage.TransactionMessage, TransactionMessage, Wal2JsonReplicationMessage

public interface ReplicationMessage

An abstract representation of a replication message that is sent by a PostgreSQL logical decoding plugin and is processed by the Debezium PostgreSQL connector.

Author:

Jiri Pechanec

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	ReplicationMessage.Column A representation of column value delivered as a part of replication message
static interface	ReplicationMessage.ColumnTypeMetadata
static interface	ReplicationMessage.ColumnValue<T>
static class	ReplicationMessage.NoopMessage A special message type that is used to replace event filtered already at MessageDecoder.
static class	ReplicationMessage.Operation Data modification operation executed
static class	ReplicationMessage.TransactionMessage

Method Summary

Modifier and Type	Method and Description
Instant	getCommitTime()
List<ReplicationMessage.Column>	getNewTupleList()
List<ReplicationMessage.Column>	getOldTupleList()
ReplicationMessage.Operation	getOperation()
String	getTable()
long	getTransactionId()
boolean	hasTypeMetadata()
boolean	isLastEventForLsn()
default boolean	isTransactionalMessage() Whether this message represents the begin or end of a transaction.
default boolean	shouldSchemaBeSynchronized()

Method Detail

getOperation

ReplicationMessage.Operation getOperation()

Returns:

A data operation executed

getCommitTime

Instant getCommitTime()

Returns:

Transaction commit time for this change

getTransactionId

long getTransactionId()

Returns:

An id of transaction to which this change belongs

getTable

String getTable()

Returns:

Table changed

getOldTupleList

List<ReplicationMessage.Column> getOldTupleList()

Returns:

Set of original values of table columns, null for INSERT

getNewTupleList

List<ReplicationMessage.Column> getNewTupleList()

Returns:

Set of new values of table columns, null for DELETE

hasTypeMetadata

boolean hasTypeMetadata()

Returns:

true if type metadata are passed as a part of message

isLastEventForLsn

boolean isLastEventForLsn()

Returns:

true if this is the last message in the batch of messages with same LSN

shouldSchemaBeSynchronized

default boolean shouldSchemaBeSynchronized()

Returns:

true if the stream producer should synchronize the schema when processing messages, false otherwise

isTransactionalMessage

default boolean isTransactionalMessage()

Whether this message represents the begin or end of a transaction.