io.debezium.connector.postgresql

Class SourceInfo

java.lang.Object

io.debezium.connector.AbstractSourceInfo

io.debezium.connector.common.BaseSourceInfo

io.debezium.connector.postgresql.SourceInfo

@NotThreadSafe
public final class SourceInfo
extends BaseSourceInfo

Information about the source of information, which for normal events contains information about the transaction id and the LSN position in the server WAL.

The source partition information describes the database server for which we're streaming changes. Typically, the server is identified by the host address port number and the name of the database. Here's a JSON-like representation of an example database:

 {
     "server" : "production-server"
 }
 

The source offset information describes a structure containing the position in the server's WAL for any particular event, transaction id and the server timestamp at which the transaction that generated that particular event has been committed. When performing snapshots, it may also contain a snapshot field which indicates that a particular record is created while a snapshot it taking place. Here's a JSON-like representation of an example:

 {
     "ts_usec": 1465937,
     "lsn" : 99490,
     "txId" : 123,
     "snapshot": true
 }
 

The "ts_usec" field contains the microseconds since Unix epoch (since Jan 1, 1970) representing the time at which the transaction that generated the event was committed while the "txId" represents the server's unique transaction identifier. The "lsn" field represent a numerical (long) value corresponding to the server's LSN for that particular event and can be used to uniquely identify an event within the WAL. The source struct appears in each message envelope and contains information about the event. It is a mixture the fields from the partition and offset. Like with the offset, the "snapshot" field only appears for events produced when the connector is in the middle of a snapshot. Here's a JSON-like representation of the source for an event that corresponds to the above partition and offset:

 {
     "name": "production-server",
     "ts_usec": 1465937,
     "lsn" : 99490,
     "txId" : 123,
     "snapshot": true
 }
 

Author:

Horia Chiorean

Field Summary

Fields

Modifier and Type	Field and Description
private String	dbName
static String	LAST_SNAPSHOT_RECORD_KEY
private Long	lsn
static String	LSN_KEY
private String	schemaName
private String	tableName
private Instant	timestamp
static String	TIMESTAMP_USEC_KEY
private Long	txId
static String	TXID_KEY
private Long	xmin
static String	XMIN_KEY

Fields inherited from class io.debezium.connector.common.BaseSourceInfo

snapshotRecord

Fields inherited from class io.debezium.connector.AbstractSourceInfo

COLLECTION_NAME_KEY, DATABASE_NAME_KEY, DEBEZIUM_CONNECTOR_KEY, DEBEZIUM_VERSION_KEY, SCHEMA_NAME_KEY, SERVER_NAME_KEY, SNAPSHOT_KEY, TABLE_NAME_KEY, TIMESTAMP_KEY

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SourceInfo(PostgresConnectorConfig connectorConfig)

Method Summary

Modifier and Type	Method and Description
protected String	database()
Long	lsn()
(package private) String	schemaName()
SnapshotRecord	snapshot()
(package private) String	tableName()
protected Instant	timestamp()
String	toString()
protected Long	txId()
protected SourceInfo	update(Instant timestamp, TableId tableId)
protected SourceInfo	update(Long lsn, Instant commitTime, Long txId, TableId tableId, Long xmin) Updates the source with information about a particular received or read event.
Long	xmin()

Methods inherited from class io.debezium.connector.common.BaseSourceInfo

isSnapshot, setSnapshot

Methods inherited from class io.debezium.connector.AbstractSourceInfo

schema, serverName, struct, structMaker

Methods inherited from class java.lang.Object

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

Field Detail

TIMESTAMP_USEC_KEY

public static final String TIMESTAMP_USEC_KEY

See Also:

Constant Field Values

TXID_KEY

public static final String TXID_KEY

See Also:

Constant Field Values

XMIN_KEY

public static final String XMIN_KEY

See Also:

Constant Field Values

LSN_KEY

public static final String LSN_KEY

See Also:

Constant Field Values

LAST_SNAPSHOT_RECORD_KEY

public static final String LAST_SNAPSHOT_RECORD_KEY

See Also:

Constant Field Values

dbName

private final String dbName

lsn

private Long lsn

txId

private Long txId

xmin

private Long xmin

timestamp

private Instant timestamp

schemaName

private String schemaName

tableName

private String tableName

Constructor Detail

SourceInfo

protected SourceInfo(PostgresConnectorConfig connectorConfig)

Method Detail

update

protected SourceInfo update(Long lsn,
                            Instant commitTime,
                            Long txId,
                            TableId tableId,
                            Long xmin)

Updates the source with information about a particular received or read event.

Parameters:

lsn - the position in the server WAL for a particular event; may be null indicating that this information is not available

commitTime - the commit time of the transaction that generated the event; may be null indicating that this information is not available

txId - the ID of the transaction that generated the transaction; may be null if this information is not available

tableId - the table that should be included in the source info; may be null

xmin - the xmin of the slot, may be null

Returns:

this instance

update

protected SourceInfo update(Instant timestamp,
                            TableId tableId)

lsn

public Long lsn()

xmin

public Long xmin()

database

protected String database()

Specified by:

database in class AbstractSourceInfo

schemaName

String schemaName()

tableName

String tableName()

timestamp

protected Instant timestamp()

Specified by:

timestamp in class AbstractSourceInfo

txId

protected Long txId()

snapshot

public SnapshotRecord snapshot()

Overrides:

snapshot in class BaseSourceInfo

toString

public String toString()

Overrides:

toString in class Object