io.debezium.connector.mysql

Class MySqlTaskContext

java.lang.Object

io.debezium.connector.mysql.MySqlJdbcContext

io.debezium.connector.mysql.MySqlTaskContext

All Implemented Interfaces:

AutoCloseable

public final class MySqlTaskContext
extends MySqlJdbcContext

A Kafka Connect source task reads the MySQL binary log and generate the corresponding data change events.

Author:

Randall Hauch

See Also:

MySqlConnector

Field Summary

Fields

Modifier and Type	Field and Description
private Clock	clock
private MySqlSchema	dbSchema
private Predicate<String>	ddlFilter
private Predicate<String>	gtidSourceFilter
private RecordMakers	recordProcessor
private SourceInfo	source
private boolean	tableIdCaseInsensitive Whether table ids are compared ingnoring letter casing.
private TopicSelector	topicSelector

Fields inherited from class io.debezium.connector.mysql.MySqlJdbcContext

config, FACTORY, jdbc, logger, MYSQL_CONNECTION_URL

Constructor Summary

Constructors

Constructor and Description
MySqlTaskContext(Configuration config)
MySqlTaskContext(Configuration config, Boolean tableIdCaseInsensitive)

Method Summary

Modifier and Type	Method and Description
int	bufferSizeForBinlogReader()
Clock	clock()
LoggingContext.PreviousContext	configureLoggingContext(String contextName) Configure the logger's Mapped Diagnostic Context (MDC) properties for the thread making this call.
String	connectorName()
MySqlSchema	dbSchema()
Predicate<String>	ddlFilter() Get the predicate function that will return true if a DDL has to be skipped over and left out of the schema history or false when it should be processed.
GtidSet	filterGtidSet(GtidSet availableServerGtidSet) Apply the include/exclude GTID source filters to the current GTID set and merge them onto the currently available GTID set from a MySQL server.
String	getSnapshotSelectOverrides()
Predicate<String>	gtidSourceFilter() Get the predicate function that will return true if a GTID source is to be included, or false if a GTID source is to be excluded.
boolean	historyExists() Return true if the database history entity exists
boolean	includeSchemaChangeRecords()
void	initializeHistory() Initialize the database history with any server-specific information.
boolean	isInitialSnapshotOnly()
boolean	isSchemaOnlyRecoverySnapshot()
boolean	isSchemaOnlySnapshot()
boolean	isSnapshotAllowedWhenNeeded()
boolean	isSnapshotNeverAllowed()
boolean	isTableIdCaseInsensitive()
void	loadHistory(SourceInfo startingPoint) Load the database schema information using the previously-recorded history, and stop reading the history when the the history reaches the supplied starting point.
RecordMakers	makeRecord()
int	maxBatchSize()
int	maxQueueSize()
ObjectName	metricName(String contextName) Create a JMX metric name for the given metric.
long	pollIntervalInMillseconds()
long	rowCountForLargeTable()
long	serverId()
String	serverName()
void	shutdown()
protected MySqlConnectorConfig.SnapshotMode	snapshotMode()
SourceInfo	source()
void	start()
void	temporaryLoggingContext(String contextName, Runnable operation) Run the supplied function in the temporary connector MDC context, and when complete always return the MDC context to its state before this method was called.
long	timeoutInMilliseconds()
TopicSelector	topicSelector()
boolean	useMinimalSnapshotLocking()

Methods inherited from class io.debezium.connector.mysql.MySqlJdbcContext

close, config, connectionString, eventDeserializationFailureHandlingMode, hostname, jdbc, knownGtidSet, logger, password, port, readMySqlCharsetSystemVariables, readMySqlSystemVariables, setStatementFor, setSystemProperty, sslMode, sslModeEnabled, userHasPrivileges, username

Methods inherited from class java.lang.Object

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

Field Detail

source

private final SourceInfo source

dbSchema

private final MySqlSchema dbSchema

topicSelector

private final TopicSelector topicSelector

recordProcessor

private final RecordMakers recordProcessor

gtidSourceFilter

private final Predicate<String> gtidSourceFilter

ddlFilter

private final Predicate<String> ddlFilter

clock

private final Clock clock

tableIdCaseInsensitive

private final boolean tableIdCaseInsensitive

Whether table ids are compared ingnoring letter casing.

Constructor Detail

MySqlTaskContext

public MySqlTaskContext(Configuration config)

MySqlTaskContext

public MySqlTaskContext(Configuration config,
                        Boolean tableIdCaseInsensitive)

Method Detail

connectorName

public String connectorName()

topicSelector

public TopicSelector topicSelector()

source

public SourceInfo source()

dbSchema

public MySqlSchema dbSchema()

makeRecord

public RecordMakers makeRecord()

gtidSourceFilter

public Predicate<String> gtidSourceFilter()

Get the predicate function that will return true if a GTID source is to be included, or false if a GTID source is to be excluded.

Returns:

the GTID source predicate function; never null

initializeHistory

public void initializeHistory()

Initialize the database history with any server-specific information. This should be done only upon connector startup when the connector has no prior history.

loadHistory

public void loadHistory(SourceInfo startingPoint)

Load the database schema information using the previously-recorded history, and stop reading the history when the the history reaches the supplied starting point.

Parameters:

startingPoint - the source information with the current SourceInfo.partition() and offset at which the database schemas are to reflect; may not be null

historyExists

public boolean historyExists()

Return true if the database history entity exists

clock

public Clock clock()

serverId

public long serverId()

serverName

public String serverName()

maxQueueSize

public int maxQueueSize()

maxBatchSize

public int maxBatchSize()

timeoutInMilliseconds

public long timeoutInMilliseconds()

pollIntervalInMillseconds

public long pollIntervalInMillseconds()

rowCountForLargeTable

public long rowCountForLargeTable()

bufferSizeForBinlogReader

public int bufferSizeForBinlogReader()

includeSchemaChangeRecords

public boolean includeSchemaChangeRecords()

isSnapshotAllowedWhenNeeded

public boolean isSnapshotAllowedWhenNeeded()

isSnapshotNeverAllowed

public boolean isSnapshotNeverAllowed()

isInitialSnapshotOnly

public boolean isInitialSnapshotOnly()

isSchemaOnlySnapshot

public boolean isSchemaOnlySnapshot()

isSchemaOnlyRecoverySnapshot

public boolean isSchemaOnlyRecoverySnapshot()

snapshotMode

protected MySqlConnectorConfig.SnapshotMode snapshotMode()

useMinimalSnapshotLocking

public boolean useMinimalSnapshotLocking()

getSnapshotSelectOverrides

public String getSnapshotSelectOverrides()

start

public void start()

Overrides:

start in class MySqlJdbcContext

shutdown

public void shutdown()

Overrides:

shutdown in class MySqlJdbcContext

configureLoggingContext

public LoggingContext.PreviousContext configureLoggingContext(String contextName)

Configure the logger's Mapped Diagnostic Context (MDC) properties for the thread making this call.

Parameters:

contextName - the name of the context; may not be null

Returns:

the previous MDC context; never null

Throws:

IllegalArgumentException - if contextName is null

temporaryLoggingContext

public void temporaryLoggingContext(String contextName,
                                    Runnable operation)

Run the supplied function in the temporary connector MDC context, and when complete always return the MDC context to its state before this method was called.

Parameters:

contextName - the name of the context; may not be null

operation - the function to run in the new MDC context; may not be null

Throws:

IllegalArgumentException - if any of the parameters are null

metricName

public ObjectName metricName(String contextName)
                      throws MalformedObjectNameException

Create a JMX metric name for the given metric.

Parameters:

contextName - the name of the context

Returns:

the JMX metric name

Throws:

MalformedObjectNameException - if the name is invalid

filterGtidSet

public GtidSet filterGtidSet(GtidSet availableServerGtidSet)

Apply the include/exclude GTID source filters to the current GTID set and merge them onto the currently available GTID set from a MySQL server. The merging behavior of this method might seem a bit strange at first. It's required in order for Debezium to consume a MySQL binlog that has multi-source replication enabled, if a failover has to occur. In such a case, the server that Debezium is failed over to might have a different set of sources, but still include the sources required for Debezium to continue to function. MySQL does not allow downstream replicas to connect if the GTID set does not contain GTIDs for all channels that the server is replicating from, even if the server does have the data needed by the client. To get around this, we can have Debezium merge its GTID set with whatever is on the server, so that MySQL will allow it to connect. See DBZ-143 for details. This method does not mutate any state in the context.

Parameters:

availableServerGtidSet - the GTID set currently available in the MySQL server

Returns:

A GTID set meant for consuming from a MySQL binlog; may return null if the SourceInfo has no GTIDs and therefore none were filtered

ddlFilter

public Predicate<String> ddlFilter()

Get the predicate function that will return true if a DDL has to be skipped over and left out of the schema history or false when it should be processed.

Returns:

the DDL predicate function; never null

isTableIdCaseInsensitive

public boolean isTableIdCaseInsensitive()