Package io.debezium.connector.postgresql

Class PostgresSnapshotChangeEventSource

java.lang.Object

io.debezium.pipeline.source.AbstractSnapshotChangeEventSource<P,O>

io.debezium.relational.RelationalSnapshotChangeEventSource<PostgresPartition,PostgresOffsetContext>

io.debezium.connector.postgresql.PostgresSnapshotChangeEventSource

All Implemented Interfaces:

ChangeEventSource, SnapshotChangeEventSource<PostgresPartition,PostgresOffsetContext>, AutoCloseable

public class PostgresSnapshotChangeEventSource
extends RelationalSnapshotChangeEventSource<PostgresPartition,PostgresOffsetContext>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	PostgresSnapshotChangeEventSource.PostgresSnapshotContext	Mutable context which is populated in the course of snapshotting.

Nested classes/interfaces inherited from class io.debezium.relational.RelationalSnapshotChangeEventSource

RelationalSnapshotChangeEventSource.RelationalSnapshotContext<P extends Partition,O extends OffsetContext>

Nested classes/interfaces inherited from class io.debezium.pipeline.source.AbstractSnapshotChangeEventSource

AbstractSnapshotChangeEventSource.SnapshotContext<P extends Partition,O extends OffsetContext>, AbstractSnapshotChangeEventSource.SnapshottingTask

Nested classes/interfaces inherited from interface io.debezium.pipeline.source.spi.ChangeEventSource

ChangeEventSource.ChangeEventSourceContext

Field Summary

Fields

Modifier and Type	Field	Description
private final PostgresConnectorConfig	connectorConfig
private final PostgresConnection	jdbcConnection
private static final org.slf4j.Logger	LOGGER
private final PostgresSchema	schema
private final SlotCreationResult	slotCreatedInfo
private final Snapshotter	snapshotter
private final SlotState	startingSlotInfo

Fields inherited from class io.debezium.relational.RelationalSnapshotChangeEventSource

clock, dispatcher, SELECT_ALL_PATTERN

Fields inherited from class io.debezium.pipeline.source.AbstractSnapshotChangeEventSource

LOG_INTERVAL

Constructor Summary

Constructors

Constructor

Description

PostgresSnapshotChangeEventSource(PostgresConnectorConfig connectorConfig, Snapshotter snapshotter, MainConnectionProvidingConnectionFactory<PostgresConnection> connectionFactory, PostgresSchema schema, EventDispatcher<PostgresPartition,TableId> dispatcher, Clock clock, SnapshotProgressListener<PostgresPartition> snapshotProgressListener, SlotCreationResult slotCreatedInfo, SlotState startingSlotInfo)

Method Summary

Modifier and Type	Method	Description
protected void	aborted(AbstractSnapshotChangeEventSource.SnapshotContext<PostgresPartition,PostgresOffsetContext> snapshotContext)
protected void	completed(AbstractSnapshotChangeEventSource.SnapshotContext<PostgresPartition,PostgresOffsetContext> snapshotContext)
protected void	connectionCreated(RelationalSnapshotChangeEventSource.RelationalSnapshotContext<PostgresPartition,PostgresOffsetContext> snapshotContext)
protected PostgresOffsetContext	copyOffset(RelationalSnapshotChangeEventSource.RelationalSnapshotContext<PostgresPartition,PostgresOffsetContext> snapshotContext)
protected void	determineSnapshotOffset(RelationalSnapshotChangeEventSource.RelationalSnapshotContext<PostgresPartition,PostgresOffsetContext> ctx, PostgresOffsetContext previousOffset)
protected Set<TableId>	getAllTableIds(RelationalSnapshotChangeEventSource.RelationalSnapshotContext<PostgresPartition,PostgresOffsetContext> ctx)
protected SchemaChangeEvent	getCreateTableEvent(RelationalSnapshotChangeEventSource.RelationalSnapshotContext<PostgresPartition,PostgresOffsetContext> snapshotContext, Table table)
protected Optional<String>	getSnapshotSelect(RelationalSnapshotChangeEventSource.RelationalSnapshotContext<PostgresPartition,PostgresOffsetContext> snapshotContext, TableId tableId, List<String> columns)	Generate a valid Postgres query string for the specified table and columns
protected AbstractSnapshotChangeEventSource.SnapshottingTask	getSnapshottingTask(PostgresPartition partition, PostgresOffsetContext previousOffset)
private Lsn	getTransactionStartLsn()
protected void	lockTablesForSchemaSnapshot(ChangeEventSource.ChangeEventSourceContext sourceContext, RelationalSnapshotChangeEventSource.RelationalSnapshotContext<PostgresPartition,PostgresOffsetContext> snapshotContext)
protected AbstractSnapshotChangeEventSource.SnapshotContext<PostgresPartition,PostgresOffsetContext>	prepare(PostgresPartition partition)
protected void	readTableStructure(ChangeEventSource.ChangeEventSourceContext sourceContext, RelationalSnapshotChangeEventSource.RelationalSnapshotContext<PostgresPartition,PostgresOffsetContext> snapshotContext, PostgresOffsetContext offsetContext)
protected void	releaseSchemaSnapshotLocks(RelationalSnapshotChangeEventSource.RelationalSnapshotContext<PostgresPartition,PostgresOffsetContext> snapshotContext)
protected void	setSnapshotTransactionIsolationLevel()
protected void	updateOffsetForPreSnapshotCatchUpStreaming(PostgresOffsetContext offset)
private void	updateOffsetForSnapshot(PostgresOffsetContext offset)

Methods inherited from class io.debezium.relational.RelationalSnapshotChangeEventSource

additionalColumnFilter, connectionPoolConnectionCreated, createSchemaChangeEventsForTables, createSnapshotConnection, doExecute, enhanceOverriddenSelect, getChangeRecordEmitter, getClock, getPreparedColumnNames, getSignalDataCollectionPattern, getSnapshotConnectionFirstSelect, getSnapshotSelectOverridesByTable, getSnapshotSourceTimestamp, getTablesForSchemaChange, lastSnapshotRecord, postSnapshot, readTableStatement, releaseDataSnapshotLocks, rowCountForTable, tryStartingSnapshot

Methods inherited from class io.debezium.pipeline.source.AbstractSnapshotChangeEventSource

close, delaySnapshotIfNeeded, determineDataCollectionsToBeSnapshotted, execute

Methods inherited from class java.lang.Object

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

Field Details

LOGGER

private static final org.slf4j.Logger LOGGER

connectorConfig

private final PostgresConnectorConfig connectorConfig

jdbcConnection

private final PostgresConnection jdbcConnection

schema

private final PostgresSchema schema

snapshotter

private final Snapshotter snapshotter

slotCreatedInfo

private final SlotCreationResult slotCreatedInfo

startingSlotInfo

private final SlotState startingSlotInfo

Constructor Details

PostgresSnapshotChangeEventSource

public PostgresSnapshotChangeEventSource(PostgresConnectorConfig connectorConfig,
 Snapshotter snapshotter,
 MainConnectionProvidingConnectionFactory<PostgresConnection> connectionFactory,
 PostgresSchema schema,
 EventDispatcher<PostgresPartition,TableId> dispatcher,
 Clock clock,
 SnapshotProgressListener<PostgresPartition> snapshotProgressListener,
 SlotCreationResult slotCreatedInfo,
 SlotState startingSlotInfo)

Method Details

getSnapshottingTask

protected AbstractSnapshotChangeEventSource.SnapshottingTask getSnapshottingTask(PostgresPartition partition,
 PostgresOffsetContext previousOffset)

Specified by:

getSnapshottingTask in class AbstractSnapshotChangeEventSource<PostgresPartition,PostgresOffsetContext>

prepare

protected AbstractSnapshotChangeEventSource.SnapshotContext<PostgresPartition,PostgresOffsetContext> prepare(PostgresPartition partition)
                                                                                                      throws Exception

Specified by:

prepare in class AbstractSnapshotChangeEventSource<PostgresPartition,PostgresOffsetContext>

Throws:

Exception

connectionCreated

protected void connectionCreated(RelationalSnapshotChangeEventSource.RelationalSnapshotContext<PostgresPartition,PostgresOffsetContext> snapshotContext)
                          throws Exception

Overrides:

connectionCreated in class RelationalSnapshotChangeEventSource<PostgresPartition,PostgresOffsetContext>

Throws:

Exception

getAllTableIds

protected Set<TableId> getAllTableIds(RelationalSnapshotChangeEventSource.RelationalSnapshotContext<PostgresPartition,PostgresOffsetContext> ctx)
                               throws Exception

Specified by:

getAllTableIds in class RelationalSnapshotChangeEventSource<PostgresPartition,PostgresOffsetContext>

Throws:

Exception

lockTablesForSchemaSnapshot

protected void lockTablesForSchemaSnapshot(ChangeEventSource.ChangeEventSourceContext sourceContext,
 RelationalSnapshotChangeEventSource.RelationalSnapshotContext<PostgresPartition,PostgresOffsetContext> snapshotContext)
                                    throws SQLException,
InterruptedException

Specified by:

lockTablesForSchemaSnapshot in class RelationalSnapshotChangeEventSource<PostgresPartition,PostgresOffsetContext>

Throws:

SQLException

InterruptedException

releaseSchemaSnapshotLocks

protected void releaseSchemaSnapshotLocks(RelationalSnapshotChangeEventSource.RelationalSnapshotContext<PostgresPartition,PostgresOffsetContext> snapshotContext)
                                   throws SQLException

Specified by:

releaseSchemaSnapshotLocks in class RelationalSnapshotChangeEventSource<PostgresPartition,PostgresOffsetContext>

Throws:

SQLException

determineSnapshotOffset

protected void determineSnapshotOffset(RelationalSnapshotChangeEventSource.RelationalSnapshotContext<PostgresPartition,PostgresOffsetContext> ctx,
 PostgresOffsetContext previousOffset)
                                throws Exception

Specified by:

determineSnapshotOffset in class RelationalSnapshotChangeEventSource<PostgresPartition,PostgresOffsetContext>

Throws:

Exception

updateOffsetForSnapshot

private void updateOffsetForSnapshot(PostgresOffsetContext offset)
                              throws SQLException

Throws:

SQLException

updateOffsetForPreSnapshotCatchUpStreaming

protected void updateOffsetForPreSnapshotCatchUpStreaming(PostgresOffsetContext offset)
                                                   throws SQLException

Throws:

SQLException

getTransactionStartLsn

private Lsn getTransactionStartLsn()
                            throws SQLException

Throws:

SQLException

readTableStructure

protected void readTableStructure(ChangeEventSource.ChangeEventSourceContext sourceContext,
 RelationalSnapshotChangeEventSource.RelationalSnapshotContext<PostgresPartition,PostgresOffsetContext> snapshotContext,
 PostgresOffsetContext offsetContext)
                           throws SQLException,
InterruptedException

Specified by:

readTableStructure in class RelationalSnapshotChangeEventSource<PostgresPartition,PostgresOffsetContext>

Throws:

SQLException

InterruptedException

getCreateTableEvent

protected SchemaChangeEvent getCreateTableEvent(RelationalSnapshotChangeEventSource.RelationalSnapshotContext<PostgresPartition,PostgresOffsetContext> snapshotContext,
 Table table)
                                         throws SQLException

Specified by:

getCreateTableEvent in class RelationalSnapshotChangeEventSource<PostgresPartition,PostgresOffsetContext>

Throws:

SQLException

completed

protected void completed(AbstractSnapshotChangeEventSource.SnapshotContext<PostgresPartition,PostgresOffsetContext> snapshotContext)

Overrides:

completed in class AbstractSnapshotChangeEventSource<PostgresPartition,PostgresOffsetContext>

aborted

protected void aborted(AbstractSnapshotChangeEventSource.SnapshotContext<PostgresPartition,PostgresOffsetContext> snapshotContext)

Overrides:

aborted in class AbstractSnapshotChangeEventSource<PostgresPartition,PostgresOffsetContext>

getSnapshotSelect

protected Optional<String> getSnapshotSelect(RelationalSnapshotChangeEventSource.RelationalSnapshotContext<PostgresPartition,PostgresOffsetContext> snapshotContext,
 TableId tableId,
 List<String> columns)

Generate a valid Postgres query string for the specified table and columns

Specified by:

getSnapshotSelect in class RelationalSnapshotChangeEventSource<PostgresPartition,PostgresOffsetContext>

Parameters:

tableId - the table to generate a query for

Returns:

a valid query string

setSnapshotTransactionIsolationLevel

protected void setSnapshotTransactionIsolationLevel()
                                             throws SQLException

Throws:

SQLException

copyOffset

protected PostgresOffsetContext copyOffset(RelationalSnapshotChangeEventSource.RelationalSnapshotContext<PostgresPartition,PostgresOffsetContext> snapshotContext)

Specified by:

copyOffset in class RelationalSnapshotChangeEventSource<PostgresPartition,PostgresOffsetContext>