io.debezium.connector.mysql

Class MySqlConnectorConfig

java.lang.Object

io.debezium.connector.mysql.MySqlConnectorConfig

public class MySqlConnectorConfig
extends Object

The configuration properties.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MySqlConnectorConfig.DecimalHandlingMode The set of predefined DecimalHandlingMode options or aliases.
static class	MySqlConnectorConfig.SecureConnectionMode The set of predefined SecureConnectionMode options or aliases.
static class	MySqlConnectorConfig.SnapshotMode The set of predefined SnapshotMode options or aliases.
static class	MySqlConnectorConfig.TemporalPrecisionMode The set of predefined TemporalPrecisionMode options or aliases.

Field Summary

Fields

Modifier and Type	Field and Description
static Field.Set	ALL_FIELDS The set of Fields defined as part of this configuration.
static Field	COLUMN_BLACKLIST A comma-separated list of regular expressions that match fully-qualified names of columns to be excluded from monitoring and change messages.
static Field	CONNECTION_TIMEOUT_MS
static Field	DATABASE_BLACKLIST A comma-separated list of regular expressions that match database names to be excluded from monitoring.
static Field	DATABASE_HISTORY The database history class is hidden in the configDef() since that is designed to work with a user interface, and in these situations using Kafka is the only way to go.
static Field	DATABASE_WHITELIST A comma-separated list of regular expressions that match database names to be monitored.
private static String	DATABASE_WHITELIST_NAME
static Field	DECIMAL_HANDLING_MODE
protected static Field.Set	EXPOSED_FIELDS The set of Fields that are included in the configuration definition.
static Field	GTID_SOURCE_EXCLUDES A comma-separated list of regular expressions that match source UUIDs in the GTID set used to find the binlog position in the MySQL server.
static Field	GTID_SOURCE_FILTER_DML_EVENTS If set to true, we will only produce DML events into Kafka for transactions that were written on MySQL servers with UUIDs matching the filters defined by the GTID_SOURCE_INCLUDES or GTID_SOURCE_EXCLUDES configuration options, if they are specified.
static Field	GTID_SOURCE_INCLUDES A comma-separated list of regular expressions that match source UUIDs in the GTID set used to find the binlog position in the MySQL server.
static Field	HOSTNAME
static Field	INCLUDE_SCHEMA_CHANGES
static Field	JDBC_DRIVER
static Field	KEEP_ALIVE
static Field	MAX_BATCH_SIZE
static Field	MAX_QUEUE_SIZE
static Field	PASSWORD
static Field	POLL_INTERVAL_MS
static Field	PORT
static Field	ROW_COUNT_FOR_STREAMING_RESULT_SETS
static Field	SERVER_ID
static Field	SERVER_NAME
static Field	SNAPSHOT_MINIMAL_LOCKING
static Field	SNAPSHOT_MODE
static Field	SSL_KEYSTORE
static Field	SSL_KEYSTORE_PASSWORD
static Field	SSL_MODE
static Field	SSL_TRUSTSTORE
static Field	SSL_TRUSTSTORE_PASSWORD
static Field	TABLE_BLACKLIST A comma-separated list of regular expressions that match the fully-qualified names of tables to be excluded from monitoring.
private static String	TABLE_IGNORE_BUILTIN_NAME
static Field	TABLE_WHITELIST A comma-separated list of regular expressions that match the fully-qualified names of tables to be monitored.
private static String	TABLE_WHITELIST_NAME
static Field	TABLES_IGNORE_BUILTIN
static Field	TIME_PRECISION_MODE
static Field	USER

Constructor Summary

Constructors

Constructor and Description
MySqlConnectorConfig()

Method Summary

Modifier and Type	Method and Description
protected static org.apache.kafka.common.config.ConfigDef	configDef()
static Field	MASK_COLUMN(int length) Method that generates a Field for specifying that string columns whose names match a set of regular expressions should have their values masked by the specified number of asterisk ('*') characters.
private static int	randomServerId()
static Field	TRUNCATE_COLUMN(int length) Method that generates a Field for specifying that string columns whose names match a set of regular expressions should have their values truncated to be no longer than the specified number of characters.
private static int	validateColumnBlacklist(Configuration config, Field field, Field.ValidationOutput problems)
private static int	validateDatabaseBlacklist(Configuration config, Field field, Field.ValidationOutput problems)
private static int	validateGtidSetExcludes(Configuration config, Field field, Field.ValidationOutput problems)
private static int	validateMaxQueueSize(Configuration config, Field field, Field.ValidationOutput problems)
private static int	validateServerNameIsDifferentFromHistoryTopicName(Configuration config, Field field, Field.ValidationOutput problems)
private static int	validateTableBlacklist(Configuration config, Field field, Field.ValidationOutput problems)

Methods inherited from class java.lang.Object

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

Field Detail

DATABASE_WHITELIST_NAME

private static final String DATABASE_WHITELIST_NAME

See Also:

Constant Field Values

TABLE_WHITELIST_NAME

private static final String TABLE_WHITELIST_NAME

See Also:

Constant Field Values

TABLE_IGNORE_BUILTIN_NAME

private static final String TABLE_IGNORE_BUILTIN_NAME

See Also:

Constant Field Values

HOSTNAME

public static final Field HOSTNAME

PORT

public static final Field PORT

USER

public static final Field USER

PASSWORD

public static final Field PASSWORD

SERVER_NAME

public static final Field SERVER_NAME

SERVER_ID

public static final Field SERVER_ID

SSL_MODE

public static final Field SSL_MODE

SSL_KEYSTORE

public static final Field SSL_KEYSTORE

SSL_KEYSTORE_PASSWORD

public static final Field SSL_KEYSTORE_PASSWORD

SSL_TRUSTSTORE

public static final Field SSL_TRUSTSTORE

SSL_TRUSTSTORE_PASSWORD

public static final Field SSL_TRUSTSTORE_PASSWORD

TABLES_IGNORE_BUILTIN

public static final Field TABLES_IGNORE_BUILTIN

JDBC_DRIVER

public static final Field JDBC_DRIVER

DATABASE_WHITELIST

public static final Field DATABASE_WHITELIST

A comma-separated list of regular expressions that match database names to be monitored. May not be used with DATABASE_BLACKLIST.

DATABASE_BLACKLIST

public static final Field DATABASE_BLACKLIST

A comma-separated list of regular expressions that match database names to be excluded from monitoring. May not be used with DATABASE_WHITELIST.

TABLE_WHITELIST

public static final Field TABLE_WHITELIST

A comma-separated list of regular expressions that match the fully-qualified names of tables to be monitored. Fully-qualified names for tables are of the form <databaseName>.<tableName> or <databaseName>.<schemaName>.<tableName>. May not be used with TABLE_BLACKLIST, and superseded by database inclusions/exclusions.

TABLE_BLACKLIST

public static final Field TABLE_BLACKLIST

A comma-separated list of regular expressions that match the fully-qualified names of tables to be excluded from monitoring. Fully-qualified names for tables are of the form <databaseName>.<tableName> or <databaseName>.<schemaName>.<tableName>. May not be used with TABLE_WHITELIST.

COLUMN_BLACKLIST

public static final Field COLUMN_BLACKLIST

A comma-separated list of regular expressions that match fully-qualified names of columns to be excluded from monitoring and change messages. Fully-qualified names for columns are of the form <databaseName>.<tableName>.<columnName> or <databaseName>.<schemaName>.<tableName>.<columnName>.

GTID_SOURCE_INCLUDES

public static final Field GTID_SOURCE_INCLUDES

A comma-separated list of regular expressions that match source UUIDs in the GTID set used to find the binlog position in the MySQL server. Only the GTID ranges that have sources matching one of these include patterns will be used. May not be used with GTID_SOURCE_EXCLUDES.

GTID_SOURCE_EXCLUDES

public static final Field GTID_SOURCE_EXCLUDES

A comma-separated list of regular expressions that match source UUIDs in the GTID set used to find the binlog position in the MySQL server. Only the GTID ranges that have sources matching none of these exclude patterns will be used. May not be used with GTID_SOURCE_INCLUDES.

GTID_SOURCE_FILTER_DML_EVENTS

public static final Field GTID_SOURCE_FILTER_DML_EVENTS

If set to true, we will only produce DML events into Kafka for transactions that were written on MySQL servers with UUIDs matching the filters defined by the GTID_SOURCE_INCLUDES or GTID_SOURCE_EXCLUDES configuration options, if they are specified. Defaults to true. When true, either GTID_SOURCE_INCLUDES or GTID_SOURCE_EXCLUDES must be set.

CONNECTION_TIMEOUT_MS

public static final Field CONNECTION_TIMEOUT_MS

KEEP_ALIVE

public static final Field KEEP_ALIVE

MAX_QUEUE_SIZE

public static final Field MAX_QUEUE_SIZE

MAX_BATCH_SIZE

public static final Field MAX_BATCH_SIZE

POLL_INTERVAL_MS

public static final Field POLL_INTERVAL_MS

ROW_COUNT_FOR_STREAMING_RESULT_SETS

public static final Field ROW_COUNT_FOR_STREAMING_RESULT_SETS

DATABASE_HISTORY

public static final Field DATABASE_HISTORY

The database history class is hidden in the configDef() since that is designed to work with a user interface, and in these situations using Kafka is the only way to go.

INCLUDE_SCHEMA_CHANGES

public static final Field INCLUDE_SCHEMA_CHANGES

SNAPSHOT_MODE

public static final Field SNAPSHOT_MODE

SNAPSHOT_MINIMAL_LOCKING

public static final Field SNAPSHOT_MINIMAL_LOCKING

TIME_PRECISION_MODE

public static final Field TIME_PRECISION_MODE

DECIMAL_HANDLING_MODE

public static final Field DECIMAL_HANDLING_MODE

ALL_FIELDS

public static Field.Set ALL_FIELDS

The set of Fields defined as part of this configuration.

EXPOSED_FIELDS

protected static Field.Set EXPOSED_FIELDS

The set of Fields that are included in the configuration definition. This includes all fields defined in this class (though some are always invisible since they are not to be exposed to the user interface) plus several that are specific to the KafkaDatabaseHistory class, since history is always stored in Kafka when run via the user interface.

Constructor Detail

MySqlConnectorConfig

public MySqlConnectorConfig()

Method Detail

TRUNCATE_COLUMN

public static final Field TRUNCATE_COLUMN(int length)

Method that generates a Field for specifying that string columns whose names match a set of regular expressions should have their values truncated to be no longer than the specified number of characters.

Parameters:

length - the maximum length of the column's string values written in source records; must be positive

Returns:

the field; never null

MASK_COLUMN

public static final Field MASK_COLUMN(int length)

Method that generates a Field for specifying that string columns whose names match a set of regular expressions should have their values masked by the specified number of asterisk ('*') characters.

Parameters:

length - the number of asterisks that should appear in place of the column's string values written in source records; must be positive

Returns:

the field; never null

configDef

protected static org.apache.kafka.common.config.ConfigDef configDef()

validateMaxQueueSize

private static int validateMaxQueueSize(Configuration config,
                                        Field field,
                                        Field.ValidationOutput problems)

validateDatabaseBlacklist

private static int validateDatabaseBlacklist(Configuration config,
                                             Field field,
                                             Field.ValidationOutput problems)

validateTableBlacklist

private static int validateTableBlacklist(Configuration config,
                                          Field field,
                                          Field.ValidationOutput problems)

validateGtidSetExcludes

private static int validateGtidSetExcludes(Configuration config,
                                           Field field,
                                           Field.ValidationOutput problems)

validateServerNameIsDifferentFromHistoryTopicName

private static int validateServerNameIsDifferentFromHistoryTopicName(Configuration config,
                                                                     Field field,
                                                                     Field.ValidationOutput problems)

validateColumnBlacklist

private static int validateColumnBlacklist(Configuration config,
                                           Field field,
                                           Field.ValidationOutput problems)

randomServerId

private static int randomServerId()