Package io.debezium.connector.mysql

Class MySqlConnection

java.lang.Object

io.debezium.jdbc.JdbcConnection

io.debezium.connector.mysql.MySqlConnection

All Implemented Interfaces:

AutoCloseable

public class MySqlConnection
extends io.debezium.jdbc.JdbcConnection

Copied from Debezium project(1.9.8.final) to add custom jdbc properties in the jdbc url. The new parameter MySqlConnectionConfiguration(Configuration config, Properties jdbcProperties) in the constructor of MySqlConnection.MySqlConnectionConfiguration will be used to generate the jdbc url pattern, and may overwrite the default value.

Add field urlPattern in MySqlConnection and remove old pattern.

Added MySQL 8.4+ compatible probing fields MYSQL_CLASSIC_SHOW_BINARY_LOG_STATEMENT, MYSQL_NEW_SHOW_BINARY_LOG_STATEMENT, and showBinaryLogStatement.

Init urlPattern using the url pattern from MySqlConnection.MySqlConnectionConfiguration.

Generate the connection string by the new field urlPattern.

Add new constant and field urlPattern to MySqlConnection.MySqlConnectionConfiguration.

Init new field urlPattern in MySqlConnection.MySqlConnectionConfiguration.

Add utility methods helping to generate the url pattern and add default values.

Added utility method getShowBinaryLogStatement() and probeShowBinaryLogStatement() for MySQL 8.4 compatibility.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MySqlConnection.MySqlConnectionConfiguration	Connection configuration to create a MySqlConnection.

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

io.debezium.jdbc.JdbcConnection.BlockingMultiResultSetConsumer, io.debezium.jdbc.JdbcConnection.BlockingResultSetConsumer, io.debezium.jdbc.JdbcConnection.CallPreparer, io.debezium.jdbc.JdbcConnection.ConnectionFactory, io.debezium.jdbc.JdbcConnection.MultiResultSetConsumer, io.debezium.jdbc.JdbcConnection.Operations, io.debezium.jdbc.JdbcConnection.ParameterResultSetConsumer, io.debezium.jdbc.JdbcConnection.ResultSetConsumer, io.debezium.jdbc.JdbcConnection.ResultSetExtractor<T extends Object>, io.debezium.jdbc.JdbcConnection.ResultSetMapper<T extends Object>, io.debezium.jdbc.JdbcConnection.StatementFactory, io.debezium.jdbc.JdbcConnection.StatementPreparer

Constructor Summary

Constructors

Constructor	Description
MySqlConnection(MySqlConnection.MySqlConnectionConfiguration connectionConfig)	Creates a new connection using the supplied configuration.
MySqlConnection(MySqlConnection.MySqlConnectionConfiguration connectionConfig, io.debezium.connector.mysql.MySqlFieldReader fieldReader)	Creates a new connection using the supplied configuration.

Method Summary

Modifier and Type	Method	Description
List<String>	availableBinlogFiles()	Query the database server to get the list of the binlog files availble.
void	close()
MySqlConnection.MySqlConnectionConfiguration	connectionConfig()
String	connectionString()
String	earliestBinlogFilename()	Determine the earliest binlog filename that is still available in the server.
<T extends io.debezium.schema.DatabaseSchema<io.debezium.relational.TableId>> Object	getColumnValue(ResultSet rs, int columnIndex, io.debezium.relational.Column column, io.debezium.relational.Table table, T schema)
OptionalLong	getEstimatedTableSize(io.debezium.relational.TableId tableId)
static String	getJavaEncodingForMysqlCharSet(String mysqlCharsetName)
protected String	getSessionVariableForSslVersion()	Read the Ssl Version session variable.
String	getShowBinaryLogStatement()
protected boolean	isBinlogFormatRow()	Determine whether the MySQL server has the row-level binlog enabled.
protected boolean	isBinlogRowImageFull()	Determine whether the MySQL server has the binlog_row_image set to 'FULL'.
boolean	isGtidModeEnabled()	Determine whether the MySQL server has GTIDs enabled.
boolean	isTableIdCaseSensitive()
String	knownGtidSet()	Determine the executed GTID set for MySQL.
io.debezium.connector.mysql.GtidSet	purgedGtidSet()	Get the purged GTID values from MySQL (gtid_purged value).
String	quotedTableIdString(io.debezium.relational.TableId tableId)
protected Map<String,io.debezium.connector.mysql.legacy.MySqlJdbcContext.DatabaseLocales>	readDatabaseCollations()	Read the MySQL default character sets for exisiting databases.
protected Map<String,String>	readMySqlCharsetSystemVariables()	Read the MySQL charset-related system variables.
protected Map<String,String>	readMySqlSystemVariables()	Read the MySQL system variables.
protected String	setStatementFor(Map<String,String> variables)
protected void	setSystemProperty(String property, io.debezium.config.Field field, boolean showValueInError)
io.debezium.connector.mysql.GtidSet	subtractGtidSet(io.debezium.connector.mysql.GtidSet set1, io.debezium.connector.mysql.GtidSet set2)	Determine the difference between two sets.
boolean	userHasPrivileges(String grantName)	Determine if the current user has the named privilege.

Methods inherited from class io.debezium.jdbc.JdbcConnection

buildSelectWithRowLimits, call, commit, config, connect, connection, connection, connectionString, database, execute, execute, executeWithoutCommitting, getColumnsDetails, getCurrentTimestamp, isConnected, isNullable, isTableType, isTableUniqueIndexIncluded, isValid, loadKeyStore, overrideColumn, parseSqlStatementString, patternBasedFactory, patternBasedFactory, prepareQuery, prepareQuery, prepareQuery, prepareQuery, prepareQuery, prepareQueryAndMap, prepareQueryWithBlockingConsumer, prepareUpdate, print, print, query, query, queryAndMap, queryAndMap, querySingleValue, queryWithBlockingConsumer, quotedColumnIdString, readAllCatalogNames, readAllSchemaNames, readAllTableNames, readPrimaryKeyNames, readPrimaryKeyOrUniqueIndexNames, readSchema, readTableColumn, readTableNames, readTablePreparedStatement, readTableStatement, readTableUniqueIndices, resolveCatalogName, resolveJdbcType, resolveNativeType, rollback, rowToArray, setAutoCommit, singleResultMapper, supportedTableTypes, tableTypes, username

Methods inherited from class java.lang.Object

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

Constructor Detail

MySqlConnection

public MySqlConnection(MySqlConnection.MySqlConnectionConfiguration connectionConfig,
                       io.debezium.connector.mysql.MySqlFieldReader fieldReader)

Creates a new connection using the supplied configuration.

Parameters:

connectionConfig - MySqlConnection.MySqlConnectionConfiguration instance, may not be null.

fieldReader - binary or text protocol based readers

MySqlConnection

public MySqlConnection(MySqlConnection.MySqlConnectionConfiguration connectionConfig)

Creates a new connection using the supplied configuration.

Parameters:

connectionConfig - MySqlConnection.MySqlConnectionConfiguration instance, may not be null.

Method Detail

close

public void close()
           throws SQLException

Specified by:

close in interface AutoCloseable

Overrides:

close in class io.debezium.jdbc.JdbcConnection

Throws:

SQLException

readMySqlCharsetSystemVariables

protected Map<String,String> readMySqlCharsetSystemVariables()

Read the MySQL charset-related system variables.

Returns:

the system variables that are related to server character sets; never null

readMySqlSystemVariables

protected Map<String,String> readMySqlSystemVariables()

Read the MySQL system variables.

Returns:

the system variables that are related to server character sets; never null

setStatementFor

protected String setStatementFor(Map<String,String> variables)

setSystemProperty

protected void setSystemProperty(String property,
                                 io.debezium.config.Field field,
                                 boolean showValueInError)

getSessionVariableForSslVersion

protected String getSessionVariableForSslVersion()

Read the Ssl Version session variable.

Returns:

the session variables that are related to sessions ssl version

isGtidModeEnabled

public boolean isGtidModeEnabled()

Determine whether the MySQL server has GTIDs enabled.

Returns:

false if the server's gtid_mode is set and is OFF, or true otherwise

knownGtidSet

public String knownGtidSet()

Determine the executed GTID set for MySQL.

Returns:

the string representation of MySQL's GTID sets; never null but an empty string if the server does not use GTIDs

subtractGtidSet

public io.debezium.connector.mysql.GtidSet subtractGtidSet(io.debezium.connector.mysql.GtidSet set1,
                                                           io.debezium.connector.mysql.GtidSet set2)

Determine the difference between two sets.

Returns:

a subtraction of two GTID sets; never null

purgedGtidSet

public io.debezium.connector.mysql.GtidSet purgedGtidSet()

Get the purged GTID values from MySQL (gtid_purged value).

Returns:

A GTID set; may be empty if not using GTIDs or none have been purged yet

userHasPrivileges

public boolean userHasPrivileges(String grantName)

Determine if the current user has the named privilege. Note that if the user has the "ALL" privilege this method returns true.

Parameters:

grantName - the name of the MySQL privilege; may not be null

Returns:

true if the user has the named privilege, or false otherwise

earliestBinlogFilename

public String earliestBinlogFilename()

Determine the earliest binlog filename that is still available in the server.

Returns:

the name of the earliest binlog filename, or null if there are none.

isBinlogRowImageFull

protected boolean isBinlogRowImageFull()

Determine whether the MySQL server has the binlog_row_image set to 'FULL'.

Returns:

true if the server's binlog_row_image is set to FULL, or false otherwise

isBinlogFormatRow

protected boolean isBinlogFormatRow()

Determine whether the MySQL server has the row-level binlog enabled.

Returns:

true if the server's binlog_format is set to ROW, or false otherwise

availableBinlogFiles

public List<String> availableBinlogFiles()

Query the database server to get the list of the binlog files availble.

Returns:

list of the binlog files

getEstimatedTableSize

public OptionalLong getEstimatedTableSize(io.debezium.relational.TableId tableId)

isTableIdCaseSensitive

public boolean isTableIdCaseSensitive()

readDatabaseCollations

protected Map<String,io.debezium.connector.mysql.legacy.MySqlJdbcContext.DatabaseLocales> readDatabaseCollations()

Read the MySQL default character sets for exisiting databases.

Returns:

the map of database names with their default character sets; never null

connectionConfig

public MySqlConnection.MySqlConnectionConfiguration connectionConfig()

connectionString

public String connectionString()

getJavaEncodingForMysqlCharSet

public static String getJavaEncodingForMysqlCharSet(String mysqlCharsetName)

getColumnValue

public <T extends io.debezium.schema.DatabaseSchema<io.debezium.relational.TableId>> Object getColumnValue(ResultSet rs,
                                                                                                           int columnIndex,
                                                                                                           io.debezium.relational.Column column,
                                                                                                           io.debezium.relational.Table table,
                                                                                                           T schema)
                                                                                                    throws SQLException

Overrides:

getColumnValue in class io.debezium.jdbc.JdbcConnection

Throws:

SQLException

quotedTableIdString

public String quotedTableIdString(io.debezium.relational.TableId tableId)

Overrides:

quotedTableIdString in class io.debezium.jdbc.JdbcConnection

getShowBinaryLogStatement

public String getShowBinaryLogStatement()