io.debezium.connector.postgresql.connection

Class PostgresConnection

java.lang.Object

io.debezium.jdbc.JdbcConnection

io.debezium.connector.postgresql.connection.PostgresConnection

All Implemented Interfaces:

AutoCloseable

public class PostgresConnection
extends JdbcConnection

JdbcConnection connection extension used for connecting to Postgres instances.

Author:

Horia Chiorean

Nested Class Summary

Nested classes/interfaces inherited from class io.debezium.jdbc.JdbcConnection

JdbcConnection.CallPreparer, JdbcConnection.ConnectionFactory, JdbcConnection.Operations, JdbcConnection.ResultSetConsumer, JdbcConnection.SingleParameterResultSetConsumer, JdbcConnection.StatementFactory, JdbcConnection.StatementPreparer

Field Summary

Fields

Modifier and Type	Field and Description
protected static JdbcConnection.ConnectionFactory	FACTORY
private static org.slf4j.Logger	LOGGER
private static String	URL_PATTERN

Constructor Summary

Constructors

Constructor and Description
PostgresConnection(Configuration config) Creates a Postgres connection using the supplied configuration.

Method Summary

Modifier and Type	Method and Description
void	close()
String	connectionString() Returns a JDBC connection string for the current configuration.
Long	currentTransactionId() Returns the PG id of the current active transaction
long	currentXLogLocation() Returns the current position in the server tx log.
protected static void	defaultSettings(Configuration.Builder builder)
boolean	dropReplicationSlot(String slotName) Drops a replication slot that was created on the DB
PostgresConnection	executeWithoutCommitting(String... statements) Executes a series of statements without explicitly committing the connection.
ServerInfo.ReplicaIdentity	readReplicaIdentityInfo(TableId tableId) Prints out information about the REPLICA IDENTITY status of a table.
protected ServerInfo.ReplicationSlot	readReplicationSlotInfo(String slotName, String pluginName)
ServerInfo	serverInfo() Returns information about the PG server to which this instance is connected.
private static void	validateServerVersion(Statement statement)

Methods inherited from class io.debezium.jdbc.JdbcConnection

call, columnsFor, columnsFor, config, connect, connection, connectionString, database, execute, execute, isConnected, patternBasedFactory, patternBasedFactory, prepareQuery, prepareQuery, prepareQuery, prepareUpdate, print, print, query, query, readAllCatalogNames, readAllSchemaNames, readAllTableNames, readSchema, readTableNames, readTypeInfo, setAutoCommit, tableTypes, username

Methods inherited from class java.lang.Object

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

Field Detail

URL_PATTERN

private static final String URL_PATTERN

FACTORY

protected static JdbcConnection.ConnectionFactory FACTORY

LOGGER

private static org.slf4j.Logger LOGGER

Constructor Detail

PostgresConnection

public PostgresConnection(Configuration config)

Creates a Postgres connection using the supplied configuration.

Parameters:

config - Configuration instance, may not be null.

Method Detail

connectionString

public String connectionString()

Returns a JDBC connection string for the current configuration.

Returns:

a String where the variables in urlPattern are replaced with values from the configuration

executeWithoutCommitting

public PostgresConnection executeWithoutCommitting(String... statements)
                                            throws SQLException

Executes a series of statements without explicitly committing the connection.

Parameters:

statements - a series of statements to execute

Returns:

this object so methods can be chained together; never null

Throws:

SQLException - if anything fails

readReplicaIdentityInfo

public ServerInfo.ReplicaIdentity readReplicaIdentityInfo(TableId tableId)
                                                   throws SQLException

Prints out information about the REPLICA IDENTITY status of a table. This in turn determines how much information is available for UPDATE and DELETE operations for logical replication.

Parameters:

tableId - the identifier of the table

Returns:

the replica identity information; never null

Throws:

SQLException - if there is a problem obtaining the replica identity information for the given table

readReplicationSlotInfo

protected ServerInfo.ReplicationSlot readReplicationSlotInfo(String slotName,
                                                             String pluginName)
                                                      throws SQLException

Throws:

SQLException

dropReplicationSlot

public boolean dropReplicationSlot(String slotName)

Drops a replication slot that was created on the DB

Parameters:

slotName - the name of the replication slot, may not be null

Returns:

true if the slot was dropped, false otherwise

close

public void close()

Specified by:

close in interface AutoCloseable

Overrides:

close in class JdbcConnection

currentTransactionId

public Long currentTransactionId()
                          throws SQLException

Returns the PG id of the current active transaction

Returns:

a PG transaction identifier, or null if no tx is active

Throws:

SQLException - if anything fails.

currentXLogLocation

public long currentXLogLocation()
                         throws SQLException

Returns the current position in the server tx log.

Returns:

a long value, never negative

Throws:

SQLException - if anything unexpected fails.

serverInfo

public ServerInfo serverInfo()
                      throws SQLException

Returns information about the PG server to which this instance is connected.

Returns:

a ServerInfo instance, never null

Throws:

SQLException - if anything fails

defaultSettings

protected static void defaultSettings(Configuration.Builder builder)

validateServerVersion

private static void validateServerVersion(Statement statement)
                                   throws SQLException

Throws:

SQLException