Skip to main content

SQL Server Source Connector

Source connector

SQL Server Source Connector

SQL Server replication uses Debezium with SQL Server CDC enabled on the database and selected tables. Validate the Database Store connection before selecting replication scope.

Connector Class

io.debezium.connector.sqlserver.SqlServerConnector

Parameters

CategoryParameterRequiredRecommended / DefaultDescription
BasicnameYesUser-definedUnique connector name. GIFROST derives topic.prefix as <name>-server.
Basictasks.maxYes1Keep one task for ordered CDC reading.
Database Connectiondatabase.hostnameYesFrom Database StoreSQL Server host.
Database Connectiondatabase.portYes1433SQL Server port.
Database Connectiondatabase.userYesFrom Database StoreDatabase user.
Database Connectiondatabase.passwordYesHiddenPassword or secret reference.
Database Connectiondatabase.namesYesFrom Database StoreDatabase names captured by the connector.
Database Wizardtable.include.list / table.exclude.listNoGeneratedFully qualified table filters.
Database Wizardcolumn.include.list / column.exclude.listNoGeneratedColumn filters.
Database Wizardmessage.key.columnsConditionalGeneratedCustom keys for tables without primary keys.
Snapshotsnapshot.modeNoinitialInitial loading behavior.
Snapshotsnapshot.isolation.modeNoDeployment-specificIsolation used during snapshot.
Signalsignal.data.collectionConditional<databaseName>.<schemaName>.<tableName>Signal table.
Connectorpoll.interval.msNoDefaultsFrequency for polling change tables.

Reference

Debezium SQL Server connector