Skip to main content

MySQL Source Connector

Source connector

MySQL Source Connector

MySQL replication uses the Debezium MySQL connector and reads changes from the binary log. Database filters use database-level parameters instead of PostgreSQL-style schemas.

Connector Class

io.debezium.connector.mysql.MySqlConnector

Parameters

CategoryParameterRequiredRecommended / DefaultDescription
BasicnameYesUser-definedUnique connector name. GIFROST derives topic.prefix as <name>-server.
Basictasks.maxYes1Keep one task for ordered binlog reading.
Database Connectiondatabase.hostnameYesFrom Database StoreMySQL host.
Database Connectiondatabase.portYes3306MySQL port.
Database Connectiondatabase.userYesFrom Database StoreReplication user.
Database Connectiondatabase.passwordYesHiddenPassword or secret reference.
Database Settingsdatabase.server.idYesUnique integerUnique MySQL replication server id.
Database Wizarddatabase.include.list / database.exclude.listNoGeneratedDatabase filters generated by the wizard.
Database Wizardtable.include.list / table.exclude.listNoGeneratedTable filters.
Database Wizardcolumn.include.list / column.exclude.listNoGeneratedColumn filters.
Database Wizardmessage.key.columnsConditionalGeneratedCustom keys for tables without primary keys.
Snapshotsnapshot.modeNoinitialInitial loading behavior.
Snapshotsnapshot.locking.modeNoDeployment-specificControls locking during snapshot.
Signalsignal.data.collectionConditional<databaseName>.<tableName>Signal table.
Eventsinclude.schema.changesNoDeployment-specificEmits schema change records when enabled.

Reference

Debezium MySQL connector