SourceInfo (Debezium Connector for PostgreSQL 0.5.1 API)

java.lang.Object
- io.debezium.connector.postgresql.SourceInfo

```
@NotThreadSafe
final class SourceInfo
extends Object
```
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
`static String`	`LAST_SNAPSHOT_RECORD_KEY`
`private Boolean`	`lastSnapshotRecord`
`private Long`	`lsn`
`static String`	`LSN_KEY`
`static org.apache.kafka.connect.data.Schema`	`SCHEMA` A `Schema` definition for a `Struct` used to store the `partition()` and `offset()` information.
`static String`	`SERVER_NAME_KEY`
`static String`	`SERVER_PARTITION_KEY`
`private String`	`serverName`
`private boolean`	`snapshot`
`static String`	`SNAPSHOT_KEY`
`private Map<String,String>`	`sourcePartition`
`static String`	`TIMESTAMP_KEY`
`private Integer`	`txId`
`static String`	`TXID_KEY`
`private Long`	`useconds`

Constructor Summary

Constructors
Modifier Constructor and Description

protected SourceInfo(String serverName)

Constructors
Modifier	Constructor and Description
`protected`	`SourceInfo(String serverName)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`completeSnapshot()` Denote that a snapshot has completed successfully.
`protected boolean`	`hasLastKnownPosition()`
`protected boolean`	`isSnapshotInEffect()` Determine whether a snapshot is currently in effect, meaning it was started and has not completed.
`protected void`	`load(Map<String,Object> lastStoredOffset)`
`protected Long`	`lsn()`
`protected SourceInfo`	`markLastSnapshotRecord()`
`Map<String,?>`	`offset()` Get the Kafka Connect detail about the source "offset", which describes the position within the source where we last have last read.
`Map<String,String>`	`partition()` Get the Kafka Connect detail about the source "partition", which describes the portion of the source that we are consuming.
`protected org.apache.kafka.connect.data.Schema`	`schema()` Get a `Schema` representation of the source `partition()` and `offset()` information.
`protected org.apache.kafka.connect.data.Struct`	`source()` Get a `Struct` representation of the source `partition()` and `offset()` information.
`protected void`	`startSnapshot()` Denote that a snapshot is being (or has been) started.
`String`	`toString()`
`protected SourceInfo`	`update(Long useconds)`
`protected SourceInfo`	`update(Long lsn, Long useconds, Integer txId)` Updates the source with information about a particular received or read event.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - SERVER_NAME_KEY
```
public static final String SERVER_NAME_KEY
```
    See Also:
    
    Constant Field Values
  - SERVER_PARTITION_KEY
```
public static final String SERVER_PARTITION_KEY
```
    See Also:
    
    Constant Field Values
  - TIMESTAMP_KEY
```
public static final String TIMESTAMP_KEY
```
    See Also:
    
    Constant Field Values
  - TXID_KEY
```
public static final String TXID_KEY
```
    See Also:
    
    Constant Field Values
  - LSN_KEY
```
public static final String LSN_KEY
```
    See Also:
    
    Constant Field Values
  - SNAPSHOT_KEY
```
public static final String SNAPSHOT_KEY
```
    See Also:
    
    Constant Field Values
  - LAST_SNAPSHOT_RECORD_KEY
```
public static final String LAST_SNAPSHOT_RECORD_KEY
```
    See Also:
    
    Constant Field Values
  - SCHEMA
```
public static final org.apache.kafka.connect.data.Schema SCHEMA
```
    A Schema definition for a Struct used to store the partition() and offset() information.
  - serverName
```
private final String serverName
```
  - sourcePartition
```
private final Map<String,String> sourcePartition
```
  - lsn
```
private Long lsn
```
  - txId
```
private Integer txId
```
  - useconds
```
private Long useconds
```
  - snapshot
```
private boolean snapshot
```
  - lastSnapshotRecord
```
private Boolean lastSnapshotRecord
```
- Constructor Detail
  - SourceInfo
```
protected SourceInfo(String serverName)
```
- Method Detail
  - load
```
protected void load(Map<String,Object> lastStoredOffset)
```
  - partition
```
public Map<String,String> partition()
```
    Get the Kafka Connect detail about the source "partition", which describes the portion of the source that we are consuming. Since we're streaming changes for a single database, the source partition specifies only the serverName as the value for the partition.
    
    Returns:
    
    the source partition information; never null
  - offset
```
public Map<String,?> offset()
```
    Get the Kafka Connect detail about the source "offset", which describes the position within the source where we last have last read.
    
    Returns:
    
    a copy of the current offset; never null
  - update
```
protected SourceInfo update(Long lsn,
                            Long useconds,
                            Integer txId)
```
    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
    
    useconds - the commit time (in microseconds since epoch) 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 nis not available
    
    Returns:
    
    this instance
  - update
```
protected SourceInfo update(Long useconds)
```
  - markLastSnapshotRecord
```
protected SourceInfo markLastSnapshotRecord()
```
  - schema
```
protected org.apache.kafka.connect.data.Schema schema()
```
    Get a Schema representation of the source partition() and offset() information.
    
    Returns:
    
    the source partition and offset Schema; never null
    
    See Also:
    
    source()
  - source
```
protected org.apache.kafka.connect.data.Struct source()
```
    Get a Struct representation of the source partition() and offset() information. The Struct complies with the SCHEMA for the Postgres connector.
    This method should always be called after update(Long, Long, Integer).
    
    Returns:
    
    the source partition and offset Struct; never null
    
    See Also:
    
    schema()
  - isSnapshotInEffect
```
protected boolean isSnapshotInEffect()
```
    Determine whether a snapshot is currently in effect, meaning it was started and has not completed.
    
    Returns:
    
    true if a snapshot is in effect, or false otherwise
  - startSnapshot
```
protected void startSnapshot()
```
    Denote that a snapshot is being (or has been) started.
  - completeSnapshot
```
protected void completeSnapshot()
```
    Denote that a snapshot has completed successfully.
  - lsn
```
protected Long lsn()
```
  - hasLastKnownPosition
```
protected boolean hasLastKnownPosition()
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class SourceInfo

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SERVER_NAME_KEY

SERVER_PARTITION_KEY

TIMESTAMP_KEY

TXID_KEY

LSN_KEY

SNAPSHOT_KEY

LAST_SNAPSHOT_RECORD_KEY

SCHEMA

serverName

sourcePartition

lsn

txId

useconds

snapshot

lastSnapshotRecord

Constructor Detail

SourceInfo

Method Detail

load

partition

offset

update

update

markLastSnapshotRecord

schema

source

isSnapshotInEffect

startSnapshot

completeSnapshot

lsn

hasLastKnownPosition

toString