io.debezium.jdbc

Class JdbcConnection

java.lang.Object

io.debezium.jdbc.JdbcConnection

All Implemented Interfaces:

AutoCloseable

public class JdbcConnection
extends Object
implements AutoCloseable

A utility that simplifies using a JDBC connection and executing transactions composed of multiple statements.

Author:

Randall Hauch

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	JdbcConnection.ConnectionFactory Establishes JDBC connections.
static interface	JdbcConnection.Operations Defines multiple JDBC operations.
static interface	JdbcConnection.ResultSetConsumer
static interface	JdbcConnection.SingleParameterResultSetConsumer
static interface	JdbcConnection.StatementFactory A function to create a statement from a connection.
static interface	JdbcConnection.StatementPreparer

Field Summary

Fields

Modifier and Type	Field and Description
private Configuration	config
private Connection	conn
private JdbcConnection.ConnectionFactory	factory
private JdbcConnection.Operations	initialOps
private static org.slf4j.Logger	LOGGER

Constructor Summary

Constructors

Modifier	Constructor and Description
	JdbcConnection(Configuration config, JdbcConnection.ConnectionFactory connectionFactory) Create a new instance with the given configuration and connection factory.
	JdbcConnection(Configuration config, JdbcConnection.ConnectionFactory connectionFactory, JdbcConnection.Operations initialOperations) Create a new instance with the given configuration and connection factory, and specify the operations that should be run against each newly-established connection.
protected	JdbcConnection(Configuration config, JdbcConnection.ConnectionFactory connectionFactory, JdbcConnection.Operations initialOperations, Consumer<Configuration.Builder> adapter) Create a new instance with the given configuration and connection factory, and specify the operations that should be run against each newly-established connection.

Method Summary

Modifier and Type	Method and Description
void	close() Close the connection and release any resources.
static void	columnsFor(ResultSet resultSet, Consumer<Column> consumer) Determine the column definitions for the supplied result set and add each column to the specified consumer.
static void	columnsFor(ResultSet resultSet, TableEditor editor) Use the supplied table editor to create columns for the supplied result set.
private static Field[]	combineVariables(Field[] overriddenVariables, Field... defaultVariables)
JdbcConfiguration	config() Obtain the configuration for this connection.
JdbcConnection	connect() Ensure a connection to the database is established.
Connection	connection()
String	connectionString(String urlPattern) Returns a JDBC connection string using the current configuration and url.
private String	delimiter(int columnCount, int[] columnSizes)
JdbcConnection	execute(JdbcConnection.Operations operations) Execute a series of operations as a single transaction.
JdbcConnection	execute(String... sqlStatements) Execute a series of SQL statements as a single transaction.
private static String	findAndReplace(String url, Properties props, Field... variables)
private int[]	findMaxLength(ResultSet resultSet)
boolean	isConnected()
private static boolean	isNullable(int jdbcNullable)
static JdbcConnection.ConnectionFactory	patternBasedFactory(String urlPattern, Field... variables) Create a JdbcConnection.ConnectionFactory that replaces variables in the supplied URL pattern.
JdbcConnection	prepareQuery(String preparedQueryString, Collection<String> parameters, JdbcConnection.SingleParameterResultSetConsumer resultConsumer) Execute a SQL prepared query.
JdbcConnection	prepareQuery(String preparedQueryString, JdbcConnection.StatementPreparer preparer, JdbcConnection.ResultSetConsumer resultConsumer) Execute a SQL prepared query.
JdbcConnection	prepareQuery(String preparedQueryString, Stream<String> parameters, JdbcConnection.SingleParameterResultSetConsumer resultConsumer) Execute a SQL prepared query.
void	print(ResultSet resultSet)
void	print(ResultSet resultSet, Consumer<String> lines)
JdbcConnection	query(String query, JdbcConnection.ResultSetConsumer resultConsumer) Execute a SQL query.
JdbcConnection	query(String query, JdbcConnection.StatementFactory statementFactory, JdbcConnection.ResultSetConsumer resultConsumer) Execute a SQL query.
Set<String>	readAllCatalogNames() Get the names of all of the catalogs.
Set<TableId>	readAllTableNames(String[] tableTypes) Get the identifiers of all available tables.
void	readSchema(Tables tables, String databaseCatalog, String schemaNamePattern, Tables.TableNameFilter tableFilter, Tables.ColumnNameFilter columnFilter, boolean removeTablesNotFoundInJdbc) Create definitions for each tables in the database, given the catalog name, schema pattern, table filter, and column filter.
Set<TableId>	readTableNames(String databaseCatalog, String schemaNamePattern, String tableNamePattern, String[] tableTypes) Get the identifiers of the tables.
JdbcConnection	setAutoCommit(boolean autoCommit)
String[]	tableTypes()
String	username() Returns the username for this connection

Methods inherited from class java.lang.Object

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

Field Detail

LOGGER

private static final org.slf4j.Logger LOGGER

config

private final Configuration config

factory

private final JdbcConnection.ConnectionFactory factory

initialOps

private final JdbcConnection.Operations initialOps

conn

private volatile Connection conn

Constructor Detail

JdbcConnection

public JdbcConnection(Configuration config,
                      JdbcConnection.ConnectionFactory connectionFactory)

Create a new instance with the given configuration and connection factory.

Parameters:

config - the configuration; may not be null

connectionFactory - the connection factory; may not be null

JdbcConnection

public JdbcConnection(Configuration config,
                      JdbcConnection.ConnectionFactory connectionFactory,
                      JdbcConnection.Operations initialOperations)

Create a new instance with the given configuration and connection factory, and specify the operations that should be run against each newly-established connection.

Parameters:

config - the configuration; may not be null

connectionFactory - the connection factory; may not be null

initialOperations - the initial operations that should be run on each new connection; may be null

JdbcConnection

protected JdbcConnection(Configuration config,
                         JdbcConnection.ConnectionFactory connectionFactory,
                         JdbcConnection.Operations initialOperations,
                         Consumer<Configuration.Builder> adapter)

Create a new instance with the given configuration and connection factory, and specify the operations that should be run against each newly-established connection.

Parameters:

config - the configuration; may not be null

connectionFactory - the connection factory; may not be null

initialOperations - the initial operations that should be run on each new connection; may be null

adapter - the function that can be called to update the configuration with defaults

Method Detail

patternBasedFactory

public static JdbcConnection.ConnectionFactory patternBasedFactory(String urlPattern,
                                                                   Field... variables)

Create a JdbcConnection.ConnectionFactory that replaces variables in the supplied URL pattern. Variables include:

• ${hostname}
• ${port}
• ${dbname}
• ${username}
• ${password}

Parameters:

urlPattern - the URL pattern string; may not be null

variables - any custom or overridden configuration variables

Returns:

the connection factory

combineVariables

private static Field[] combineVariables(Field[] overriddenVariables,
                                        Field... defaultVariables)

findAndReplace

private static String findAndReplace(String url,
                                     Properties props,
                                     Field... variables)

config

public JdbcConfiguration config()

Obtain the configuration for this connection.

Returns:

the JDBC configuration; never null

setAutoCommit

public JdbcConnection setAutoCommit(boolean autoCommit)
                             throws SQLException

Throws:

SQLException

connect

public JdbcConnection connect()
                       throws SQLException

Ensure a connection to the database is established.

Returns:

this object for chaining methods together

Throws:

SQLException - if there is an error connecting to the database

execute

public JdbcConnection execute(String... sqlStatements)
                       throws SQLException

Execute a series of SQL statements as a single transaction.

Parameters:

sqlStatements - the SQL statements that are to be performed as a single transaction

Returns:

this object for chaining methods together

Throws:

SQLException - if there is an error connecting to the database or executing the statements

See Also:

execute(Operations)

execute

public JdbcConnection execute(JdbcConnection.Operations operations)
                       throws SQLException

Execute a series of operations as a single transaction.

Parameters:

operations - the function that will be called with a newly-created Statement, and that performs one or more operations on that statement object

Returns:

this object for chaining methods together

Throws:

SQLException - if there is an error connecting to the database or executing the statements

query

public JdbcConnection query(String query,
                            JdbcConnection.ResultSetConsumer resultConsumer)
                     throws SQLException

Execute a SQL query.

Parameters:

query - the SQL query

resultConsumer - the consumer of the query results

Returns:

this object for chaining methods together

Throws:

SQLException - if there is an error connecting to the database or executing the statements

See Also:

execute(Operations)

query

public JdbcConnection query(String query,
                            JdbcConnection.StatementFactory statementFactory,
                            JdbcConnection.ResultSetConsumer resultConsumer)
                     throws SQLException

Execute a SQL query.

Parameters:

query - the SQL query

statementFactory - the function that should be used to create the statement from the connection; may not be null

resultConsumer - the consumer of the query results

Returns:

this object for chaining methods together

Throws:

SQLException - if there is an error connecting to the database or executing the statements

See Also:

execute(Operations)

prepareQuery

public JdbcConnection prepareQuery(String preparedQueryString,
                                   JdbcConnection.StatementPreparer preparer,
                                   JdbcConnection.ResultSetConsumer resultConsumer)
                            throws SQLException

Execute a SQL prepared query.

Parameters:

preparedQueryString - the prepared query string

preparer - the function that supplied arguments to the prepared statement; may not be null

resultConsumer - the consumer of the query results

Returns:

this object for chaining methods together

Throws:

SQLException - if there is an error connecting to the database or executing the statements

See Also:

execute(Operations)

prepareQuery

public JdbcConnection prepareQuery(String preparedQueryString,
                                   Collection<String> parameters,
                                   JdbcConnection.SingleParameterResultSetConsumer resultConsumer)
                            throws SQLException

Execute a SQL prepared query.

Parameters:

preparedQueryString - the prepared query string

parameters - the collection of values for the first and only parameter in the query; may not be null

resultConsumer - the consumer of the query results

Returns:

this object for chaining methods together

Throws:

SQLException - if there is an error connecting to the database or executing the statements

See Also:

execute(Operations)

prepareQuery

public JdbcConnection prepareQuery(String preparedQueryString,
                                   Stream<String> parameters,
                                   JdbcConnection.SingleParameterResultSetConsumer resultConsumer)
                            throws SQLException

Execute a SQL prepared query.

Parameters:

preparedQueryString - the prepared query string

parameters - the stream of values for the first and only parameter in the query; may not be null

resultConsumer - the consumer of the query results

Returns:

this object for chaining methods together

Throws:

SQLException - if there is an error connecting to the database or executing the statements

See Also:

execute(Operations)

print

public void print(ResultSet resultSet)

print

public void print(ResultSet resultSet,
                  Consumer<String> lines)

delimiter

private String delimiter(int columnCount,
                         int[] columnSizes)

findMaxLength

private int[] findMaxLength(ResultSet resultSet)
                     throws SQLException

Throws:

SQLException

isConnected

public boolean isConnected()
                    throws SQLException

Throws:

SQLException

connection

public Connection connection()
                      throws SQLException

Throws:

SQLException

close

public void close()
           throws SQLException

Close the connection and release any resources.

Specified by:

close in interface AutoCloseable

Throws:

SQLException

readAllCatalogNames

public Set<String> readAllCatalogNames()
                                throws SQLException

Get the names of all of the catalogs.

Returns:

the set of catalog names; never null but possibly empty

Throws:

SQLException - if an error occurs while accessing the database metadata

tableTypes

public String[] tableTypes()
                    throws SQLException

Throws:

SQLException

readAllTableNames

public Set<TableId> readAllTableNames(String[] tableTypes)
                               throws SQLException

Get the identifiers of all available tables.

Parameters:

tableTypes - the set of table types to include in the results, which may be null for all table types

Returns:

the set of TableIds; never null but possibly empty

Throws:

SQLException - if an error occurs while accessing the database metadata

readTableNames

public Set<TableId> readTableNames(String databaseCatalog,
                                   String schemaNamePattern,
                                   String tableNamePattern,
                                   String[] tableTypes)
                            throws SQLException

Get the identifiers of the tables.

Parameters:

databaseCatalog - the name of the catalog, which is typically the database name; may be an empty string for tables that have no catalog, or null if the catalog name should not be used to narrow the list of table identifiers

schemaNamePattern - the pattern used to match database schema names, which may be "" to match only those tables with no schema or null if the schema name should not be used to narrow the list of table identifiers

tableNamePattern - the pattern used to match database table names, which may be null to match all table names

tableTypes - the set of table types to include in the results, which may be null for all table types

Returns:

the set of TableIds; never null but possibly empty

Throws:

SQLException - if an error occurs while accessing the database metadata

connectionString

public String connectionString(String urlPattern)

Returns a JDBC connection string using the current configuration and url.

Parameters:

urlPattern - a String representing a JDBC connection with variables that will be replaced

Returns:

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

username

public String username()

Returns the username for this connection

Returns:

a String, never null

readSchema

public void readSchema(Tables tables,
                       String databaseCatalog,
                       String schemaNamePattern,
                       Tables.TableNameFilter tableFilter,
                       Tables.ColumnNameFilter columnFilter,
                       boolean removeTablesNotFoundInJdbc)
                throws SQLException

Create definitions for each tables in the database, given the catalog name, schema pattern, table filter, and column filter.

Parameters:

tables - the set of table definitions to be modified; may not be null

databaseCatalog - the name of the catalog, which is typically the database name; may be null if all accessible databases are to be processed

schemaNamePattern - the pattern used to match database schema names, which may be "" to match only those tables with no schema or null to process all accessible tables regardless of database schema name

tableFilter - used to determine for which tables are to be processed; may be null if all accessible tables are to be processed

columnFilter - used to determine which columns should be included as fields in its table's definition; may be null if all columns for all tables are to be included

removeTablesNotFoundInJdbc - true if this method should remove from tables any definitions for tables that are not found in the database metadata, or false if such tables should be left untouched

Throws:

SQLException - if an error occurs while accessing the database metadata

columnsFor

public static void columnsFor(ResultSet resultSet,
                              TableEditor editor)
                       throws SQLException

Use the supplied table editor to create columns for the supplied result set.

Parameters:

resultSet - the query result set; may not be null

editor - the consumer of the definitions; may not be null

Throws:

SQLException - if an error occurs while using the result set

columnsFor

public static void columnsFor(ResultSet resultSet,
                              Consumer<Column> consumer)
                       throws SQLException

Determine the column definitions for the supplied result set and add each column to the specified consumer.

Parameters:

resultSet - the query result set; may not be null

consumer - the consumer of the definitions; may not be null

Throws:

SQLException - if an error occurs while using the result set

isNullable

private static boolean isNullable(int jdbcNullable)