Debezium SQL Server Connector
Since Camel 3.0
Only consumer is supported
The Debezium SQL Server component is wrapper around Debezium using Debezium Embedded, which enables Change Data Capture from SQL Server database using Debezium without the need for Kafka or Kafka Connect.
Note on handling failures: Per Debezium Embedded Engine documentation, the engines is actively recording source offsets and periodically flushes these offsets to a persistent storage, so when the application is restarted or crashed, the engine will resume from the last recorded offset. Thus, at normal operation, your downstream routes will receive each event exactly once, however in case of an application crash (not having a graceful shutdown), the application will resume from the last recorded offset, which may result in receiving duplicate events immediately after the restart. Therefore, your downstream routes should be tolerant enough of such case and deduplicate events if needed.
Note: The Debezium SQL Server component is currently not supported in OSGi
Maven users will need to add the following dependency to their pom.xml
for this component.
<dependency>
<groupId>org.apache.camel</groupId>
<artifactId>camel-debezium-sqlserver</artifactId>
<version>x.x.x</version>
<!-- use the same version as your Camel core version -->
</dependency>Options
The Debezium SQL Server Connector component supports 64 options, which are listed below.
| Name | Description | Default | Type |
|---|---|---|---|
additionalProperties (common) |
Additional properties for debezium components in case they can’t be set directly on the camel configurations (e.g: setting Kafka Connect properties needed by Debezium engine, for example setting KafkaOffsetBackingStore), the properties have to be prefixed with additionalProperties.. E.g: additionalProperties.transactional.id=12345&additionalProperties.schema.registry.url=\http://localhost:8811/avro |
Map |
|
bridgeErrorHandler (consumer) |
Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored. |
false |
boolean |
configuration (consumer) |
Allow pre-configured Configurations to be set. |
SqlServerConnectorEmbeddedDebeziumConfiguration |
|
internalKeyConverter (consumer) |
The Converter class that should be used to serialize and deserialize key data for offsets. The default is JSON converter. |
org.apache.kafka.connect.json.JsonConverter |
String |
internalValueConverter (consumer) |
The Converter class that should be used to serialize and deserialize value data for offsets. The default is JSON converter. |
org.apache.kafka.connect.json.JsonConverter |
String |
offsetCommitPolicy (consumer) |
The name of the Java class of the commit policy. It defines when offsets commit has to be triggered based on the number of events processed and the time elapsed since the last commit. This class must implement the interface 'OffsetCommitPolicy'. The default is a periodic commit policy based upon time intervals. |
io.debezium.embedded.spi.OffsetCommitPolicy.PeriodicCommitOffsetPolicy |
String |
offsetCommitTimeoutMs (consumer) |
Maximum number of milliseconds to wait for records to flush and partition offset data to be committed to offset storage before cancelling the process and restoring the offset data to be committed in a future attempt. The default is 5 seconds. |
5s |
long |
offsetFlushIntervalMs (consumer) |
Interval at which to try committing offsets. The default is 1 minute. |
60s |
long |
offsetStorage (consumer) |
The name of the Java class that is responsible for persistence of connector offsets. |
org.apache.kafka.connect.storage.FileOffsetBackingStore |
String |
offsetStorageFileName (consumer) |
Path to file where offsets are to be stored. Required when offset.storage is set to the FileOffsetBackingStore. |
String |
|
offsetStoragePartitions (consumer) |
The number of partitions used when creating the offset storage topic. Required when offset.storage is set to the 'KafkaOffsetBackingStore'. |
int |
|
offsetStorageReplicationFactor (consumer) |
Replication factor used when creating the offset storage topic. Required when offset.storage is set to the KafkaOffsetBackingStore |
int |
|
offsetStorageTopic (consumer) |
The name of the Kafka topic where offsets are to be stored. Required when offset.storage is set to the KafkaOffsetBackingStore. |
String |
|
autowiredEnabled (advanced) |
Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc. |
true |
boolean |
columnBlacklist (sqlserver) |
Regular expressions matching columns to exclude from change events (deprecated, use column.exclude.list instead) |
String |
|
columnExcludeList (sqlserver) |
Regular expressions matching columns to exclude from change events |
String |
|
columnIncludeList (sqlserver) |
Regular expressions matching columns to include in change events |
String |
|
columnPropagateSourceType (sqlserver) |
A comma-separated list of regular expressions matching fully-qualified names of columns that adds the columns original type and original length as parameters to the corresponding field schemas in the emitted change records. |
String |
|
columnWhitelist (sqlserver) |
Regular expressions matching columns to include in change events (deprecated, use column.include.list instead) |
String |
|
converters (sqlserver) |
Optional list of custom converters that would be used instead of default ones. The converters are defined using '.type' config option and configured using options '.' |
String |
|
databaseDbname (sqlserver) |
The name of the database the connector should be monitoring. When working with a multi-tenant set-up, must be set to the CDB name. |
String |
|
databaseHistory (sqlserver) |
The name of the DatabaseHistory class that should be used to store and recover database schema changes. The configuration properties for the history are prefixed with the 'database.history.' string. |
io.debezium.relational.history.FileDatabaseHistory |
String |
databaseHistoryFileFilename (sqlserver) |
The path to the file that will be used to record the database history |
String |
|
databaseHistoryKafkaBootstrapServers (sqlserver) |
A list of host/port pairs that the connector will use for establishing the initial connection to the Kafka cluster for retrieving database schema history previously stored by the connector. This should point to the same Kafka cluster used by the Kafka Connect process. |
String |
|
databaseHistoryKafkaRecoveryAttempts (sqlserver) |
The number of attempts in a row that no data are returned from Kafka before recover completes. The maximum amount of time to wait after receiving no data is (recovery.attempts) x (recovery.poll.interval.ms). |
100 |
int |
databaseHistoryKafkaRecoveryPollIntervalMs (sqlserver) |
The number of milliseconds to wait while polling for persisted data during recovery. |
100ms |
int |
databaseHistoryKafkaTopic (sqlserver) |
The name of the topic for the database schema history |
String |
|
databaseHostname (sqlserver) |
Resolvable hostname or IP address of the SQL Server database server. |
String |
|
databaseInstance (sqlserver) |
The SQL Server instance name |
String |
|
databasePassword (sqlserver) |
Required Password of the SQL Server database user to be used when connecting to the database. |
String |
|
databasePort (sqlserver) |
Port of the SQL Server database server. |
1433 |
int |
databaseServerName (sqlserver) |
Required Unique name that identifies the database server and all recorded offsets, and that is used as a prefix for all schemas and topics. Each distinct installation should have a separate namespace and be monitored by at most one Debezium connector. |
String |
|
databaseServerTimezone (sqlserver) |
The timezone of the server used to correctly shift the commit transaction timestamp on the client sideOptions include: Any valid Java ZoneId |
String |
|
databaseUser (sqlserver) |
Name of the SQL Server database user to be used when connecting to the database. |
String |
|
datatypePropagateSourceType (sqlserver) |
A comma-separated list of regular expressions matching the database-specific data type names that adds the data type’s original type and original length as parameters to the corresponding field schemas in the emitted change records. |
String |
|
decimalHandlingMode (sqlserver) |
Specify how DECIMAL and NUMERIC columns should be represented in change events, including:'precise' (the default) uses java.math.BigDecimal to represent values, which are encoded in the change events using a binary representation and Kafka Connect’s 'org.apache.kafka.connect.data.Decimal' type; 'string' uses string to represent values; 'double' represents values using Java’s 'double', which may not offer the precision but will be far easier to use in consumers. |
precise |
String |
eventProcessingFailureHandlingMode (sqlserver) |
Specify how failures during processing of events (i.e. when encountering a corrupted event) should be handled, including:'fail' (the default) an exception indicating the problematic event and its position is raised, causing the connector to be stopped; 'warn' the problematic event and its position will be logged and the event will be skipped;'ignore' the problematic event will be skipped. |
fail |
String |
heartbeatIntervalMs (sqlserver) |
Length of an interval in milli-seconds in in which the connector periodically sends heartbeat messages to a heartbeat topic. Use 0 to disable heartbeat messages. Disabled by default. |
0ms |
int |
heartbeatTopicsPrefix (sqlserver) |
The prefix that is used to name heartbeat topics.Defaults to __debezium-heartbeat. |
__debezium-heartbeat |
String |
includeSchemaChanges (sqlserver) |
Whether the connector should publish changes in the database schema to a Kafka topic with the same name as the database server ID. Each schema change will be recorded using a key that contains the database name and whose value include logical description of the new schema and optionally the DDL statement(s).The default is 'true'. This is independent of how the connector internally records database history. |
true |
boolean |
maxBatchSize (sqlserver) |
Maximum size of each batch of source records. Defaults to 2048. |
2048 |
int |
maxQueueSize (sqlserver) |
Maximum size of the queue for change events read from the database log but not yet recorded or forwarded. Defaults to 8192, and should always be larger than the maximum batch size. |
8192 |
int |
messageKeyColumns (sqlserver) |
A semicolon-separated list of expressions that match fully-qualified tables and column(s) to be used as message key. Each expression must match the pattern ':',where the table names could be defined as (DB_NAME.TABLE_NAME) or (SCHEMA_NAME.TABLE_NAME), depending on the specific connector,and the key columns are a comma-separated list of columns representing the custom key. For any table without an explicit key configuration the table’s primary key column(s) will be used as message key.Example: dbserver1.inventory.orderlines:orderId,orderLineId;dbserver1.inventory.orders:id |
String |
|
pollIntervalMs (sqlserver) |
Frequency in milliseconds to wait for new change events to appear after receiving no events. Defaults to 500ms. |
500ms |
long |
provideTransactionMetadata (sqlserver) |
Enables transaction metadata extraction together with event counting |
false |
boolean |
queryFetchSize (sqlserver) |
The maximum number of records that should be loaded into memory while streaming. A value of 0 uses the default JDBC fetch size. |
0 |
int |
retriableRestartConnectorWaitMs (sqlserver) |
Time to wait before restarting connector after retriable exception occurs. Defaults to 10000ms. |
10s |
long |
sanitizeFieldNames (sqlserver) |
Whether field names will be sanitized to Avro naming conventions |
false |
boolean |
skippedOperations (sqlserver) |
The comma-separated list of operations to skip during streaming, defined as: 'i' for inserts; 'u' for updates; 'd' for deletes. By default, no operations will be skipped. |
String |
|
snapshotDelayMs (sqlserver) |
The number of milliseconds to delay before a snapshot will begin. |
0ms |
long |
snapshotFetchSize (sqlserver) |
The maximum number of records that should be loaded into memory while performing a snapshot |
int |
|
snapshotIsolationMode (sqlserver) |
Controls which transaction isolation level is used and how long the connector locks the monitored tables. The default is 'repeatable_read', which means that repeatable read isolation level is used. In addition, exclusive locks are taken only during schema snapshot. Using a value of 'exclusive' ensures that the connector holds the exclusive lock (and thus prevents any reads and updates) for all monitored tables during the entire snapshot duration. When 'snapshot' is specified, connector runs the initial snapshot in SNAPSHOT isolation level, which guarantees snapshot consistency. In addition, neither table nor row-level locks are held. When 'read_committed' is specified, connector runs the initial snapshot in READ COMMITTED isolation level. No long-running locks are taken, so that initial snapshot does not prevent other transactions from updating table rows. Snapshot consistency is not guaranteed.In 'read_uncommitted' mode neither table nor row-level locks are acquired, but connector does not guarantee snapshot consistency. |
repeatable_read |
String |
snapshotLockTimeoutMs (sqlserver) |
The maximum number of millis to wait for table locks at the beginning of a snapshot. If locks cannot be acquired in this time frame, the snapshot will be aborted. Defaults to 10 seconds |
10s |
long |
snapshotMode (sqlserver) |
The criteria for running a snapshot upon startup of the connector. Options include: 'initial' (the default) to specify the connector should run a snapshot only when no offsets are available for the logical server name; 'schema_only' to specify the connector should run a snapshot of the schema when no offsets are available for the logical server name. |
initial |
String |
snapshotSelectStatementOverrides (sqlserver) |
This property contains a comma-separated list of fully-qualified tables (DB_NAME.TABLE_NAME) or (SCHEMA_NAME.TABLE_NAME), depending on thespecific connectors . Select statements for the individual tables are specified in further configuration properties, one for each table, identified by the id 'snapshot.select.statement.overrides.DB_NAME.TABLE_NAME' or 'snapshot.select.statement.overrides.SCHEMA_NAME.TABLE_NAME', respectively. The value of those properties is the select statement to use when retrieving data from the specific table during snapshotting. A possible use case for large append-only tables is setting a specific point where to start (resume) snapshotting, in case a previous snapshotting was interrupted. |
String |
|
sourceStructVersion (sqlserver) |
A version of the format of the publicly visible source part in the message |
v2 |
String |
sourceTimestampMode (sqlserver) |
Configures the criteria of the attached timestamp within the source record (ts_ms).Options include:'commit', (default) the source timestamp is set to the instant where the record was committed in the database’processing', the source timestamp is set to the instant where the record was processed by Debezium. |
commit |
String |
tableBlacklist (sqlserver) |
A comma-separated list of regular expressions that match the fully-qualified names of tables to be excluded from monitoring (deprecated, use table.exclude.list instead) |
String |
|
tableExcludeList (sqlserver) |
A comma-separated list of regular expressions that match the fully-qualified names of tables to be excluded from monitoring |
String |
|
tableIgnoreBuiltin (sqlserver) |
Flag specifying whether built-in tables should be ignored. |
true |
boolean |
tableIncludeList (sqlserver) |
The tables for which changes are to be captured |
String |
|
tableWhitelist (sqlserver) |
The tables for which changes are to be captured (deprecated, use table.include.list instead) |
String |
|
timePrecisionMode (sqlserver) |
Time, date, and timestamps can be represented with different kinds of precisions, including:'adaptive' (the default) bases the precision of time, date, and timestamp values on the database column’s precision; 'adaptive_time_microseconds' like 'adaptive' mode, but TIME fields always use microseconds precision;'connect' always represents time, date, and timestamp values using Kafka Connect’s built-in representations for Time, Date, and Timestamp, which uses millisecond precision regardless of the database columns' precision . |
adaptive |
String |
tombstonesOnDelete (sqlserver) |
Whether delete operations should be represented by a delete event and a subsquenttombstone event (true) or only by a delete event (false). Emitting the tombstone event (the default behavior) allows Kafka to completely delete all events pertaining to the given key once the source record got deleted. |
false |
boolean |
The Debezium SQL Server Connector endpoint is configured using URI syntax:
debezium-sqlserver:name
with the following path and query parameters:
Path Parameters (1 parameters):
| Name | Description | Default | Type |
|---|---|---|---|
name |
Required Unique name for the connector. Attempting to register again with the same name will fail. |
String |
Query Parameters (65 parameters):
| Name | Description | Default | Type |
|---|---|---|---|
additionalProperties (common) |
Additional properties for debezium components in case they can’t be set directly on the camel configurations (e.g: setting Kafka Connect properties needed by Debezium engine, for example setting KafkaOffsetBackingStore), the properties have to be prefixed with additionalProperties.. E.g: additionalProperties.transactional.id=12345&additionalProperties.schema.registry.url=\http://localhost:8811/avro |
Map |
|
bridgeErrorHandler (consumer) |
Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored. |
false |
boolean |
internalKeyConverter (consumer) |
The Converter class that should be used to serialize and deserialize key data for offsets. The default is JSON converter. |
org.apache.kafka.connect.json.JsonConverter |
String |
internalValueConverter (consumer) |
The Converter class that should be used to serialize and deserialize value data for offsets. The default is JSON converter. |
org.apache.kafka.connect.json.JsonConverter |
String |
offsetCommitPolicy (consumer) |
The name of the Java class of the commit policy. It defines when offsets commit has to be triggered based on the number of events processed and the time elapsed since the last commit. This class must implement the interface 'OffsetCommitPolicy'. The default is a periodic commit policy based upon time intervals. |
io.debezium.embedded.spi.OffsetCommitPolicy.PeriodicCommitOffsetPolicy |
String |
offsetCommitTimeoutMs (consumer) |
Maximum number of milliseconds to wait for records to flush and partition offset data to be committed to offset storage before cancelling the process and restoring the offset data to be committed in a future attempt. The default is 5 seconds. |
5s |
long |
offsetFlushIntervalMs (consumer) |
Interval at which to try committing offsets. The default is 1 minute. |
60s |
long |
offsetStorage (consumer) |
The name of the Java class that is responsible for persistence of connector offsets. |
org.apache.kafka.connect.storage.FileOffsetBackingStore |
String |
offsetStorageFileName (consumer) |
Path to file where offsets are to be stored. Required when offset.storage is set to the FileOffsetBackingStore. |
String |
|
offsetStoragePartitions (consumer) |
The number of partitions used when creating the offset storage topic. Required when offset.storage is set to the 'KafkaOffsetBackingStore'. |
int |
|
offsetStorageReplicationFactor (consumer) |
Replication factor used when creating the offset storage topic. Required when offset.storage is set to the KafkaOffsetBackingStore |
int |
|
offsetStorageTopic (consumer) |
The name of the Kafka topic where offsets are to be stored. Required when offset.storage is set to the KafkaOffsetBackingStore. |
String |
|
exceptionHandler (consumer) |
To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By default the consumer will deal with exceptions, that will be logged at WARN or ERROR level and ignored. |
ExceptionHandler |
|
exchangePattern (consumer) |
Sets the exchange pattern when the consumer creates an exchange. There are 3 enums and the value can be one of: InOnly, InOut, InOptionalOut |
ExchangePattern |
|
synchronous (advanced) |
Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported). |
false |
boolean |
columnBlacklist (sqlserver) |
Regular expressions matching columns to exclude from change events (deprecated, use column.exclude.list instead) |
String |
|
columnExcludeList (sqlserver) |
Regular expressions matching columns to exclude from change events |
String |
|
columnIncludeList (sqlserver) |
Regular expressions matching columns to include in change events |
String |
|
columnPropagateSourceType (sqlserver) |
A comma-separated list of regular expressions matching fully-qualified names of columns that adds the columns original type and original length as parameters to the corresponding field schemas in the emitted change records. |
String |
|
columnWhitelist (sqlserver) |
Regular expressions matching columns to include in change events (deprecated, use column.include.list instead) |
String |
|
converters (sqlserver) |
Optional list of custom converters that would be used instead of default ones. The converters are defined using '.type' config option and configured using options '.' |
String |
|
databaseDbname (sqlserver) |
The name of the database the connector should be monitoring. When working with a multi-tenant set-up, must be set to the CDB name. |
String |
|
databaseHistory (sqlserver) |
The name of the DatabaseHistory class that should be used to store and recover database schema changes. The configuration properties for the history are prefixed with the 'database.history.' string. |
io.debezium.relational.history.FileDatabaseHistory |
String |
databaseHistoryFileFilename (sqlserver) |
The path to the file that will be used to record the database history |
String |
|
databaseHistoryKafkaBootstrapServers (sqlserver) |
A list of host/port pairs that the connector will use for establishing the initial connection to the Kafka cluster for retrieving database schema history previously stored by the connector. This should point to the same Kafka cluster used by the Kafka Connect process. |
String |
|
databaseHistoryKafkaRecoveryAttempts (sqlserver) |
The number of attempts in a row that no data are returned from Kafka before recover completes. The maximum amount of time to wait after receiving no data is (recovery.attempts) x (recovery.poll.interval.ms). |
100 |
int |
databaseHistoryKafkaRecoveryPollIntervalMs (sqlserver) |
The number of milliseconds to wait while polling for persisted data during recovery. |
100ms |
int |
databaseHistoryKafkaTopic (sqlserver) |
The name of the topic for the database schema history |
String |
|
databaseHostname (sqlserver) |
Resolvable hostname or IP address of the SQL Server database server. |
String |
|
databaseInstance (sqlserver) |
The SQL Server instance name |
String |
|
databasePassword (sqlserver) |
Required Password of the SQL Server database user to be used when connecting to the database. |
String |
|
databasePort (sqlserver) |
Port of the SQL Server database server. |
1433 |
int |
databaseServerName (sqlserver) |
Required Unique name that identifies the database server and all recorded offsets, and that is used as a prefix for all schemas and topics. Each distinct installation should have a separate namespace and be monitored by at most one Debezium connector. |
String |
|
databaseServerTimezone (sqlserver) |
The timezone of the server used to correctly shift the commit transaction timestamp on the client sideOptions include: Any valid Java ZoneId |
String |
|
databaseUser (sqlserver) |
Name of the SQL Server database user to be used when connecting to the database. |
String |
|
datatypePropagateSourceType (sqlserver) |
A comma-separated list of regular expressions matching the database-specific data type names that adds the data type’s original type and original length as parameters to the corresponding field schemas in the emitted change records. |
String |
|
decimalHandlingMode (sqlserver) |
Specify how DECIMAL and NUMERIC columns should be represented in change events, including:'precise' (the default) uses java.math.BigDecimal to represent values, which are encoded in the change events using a binary representation and Kafka Connect’s 'org.apache.kafka.connect.data.Decimal' type; 'string' uses string to represent values; 'double' represents values using Java’s 'double', which may not offer the precision but will be far easier to use in consumers. |
precise |
String |
eventProcessingFailureHandlingMode (sqlserver) |
Specify how failures during processing of events (i.e. when encountering a corrupted event) should be handled, including:'fail' (the default) an exception indicating the problematic event and its position is raised, causing the connector to be stopped; 'warn' the problematic event and its position will be logged and the event will be skipped;'ignore' the problematic event will be skipped. |
fail |
String |
heartbeatIntervalMs (sqlserver) |
Length of an interval in milli-seconds in in which the connector periodically sends heartbeat messages to a heartbeat topic. Use 0 to disable heartbeat messages. Disabled by default. |
0ms |
int |
heartbeatTopicsPrefix (sqlserver) |
The prefix that is used to name heartbeat topics.Defaults to __debezium-heartbeat. |
__debezium-heartbeat |
String |
includeSchemaChanges (sqlserver) |
Whether the connector should publish changes in the database schema to a Kafka topic with the same name as the database server ID. Each schema change will be recorded using a key that contains the database name and whose value include logical description of the new schema and optionally the DDL statement(s).The default is 'true'. This is independent of how the connector internally records database history. |
true |
boolean |
maxBatchSize (sqlserver) |
Maximum size of each batch of source records. Defaults to 2048. |
2048 |
int |
maxQueueSize (sqlserver) |
Maximum size of the queue for change events read from the database log but not yet recorded or forwarded. Defaults to 8192, and should always be larger than the maximum batch size. |
8192 |
int |
messageKeyColumns (sqlserver) |
A semicolon-separated list of expressions that match fully-qualified tables and column(s) to be used as message key. Each expression must match the pattern ':',where the table names could be defined as (DB_NAME.TABLE_NAME) or (SCHEMA_NAME.TABLE_NAME), depending on the specific connector,and the key columns are a comma-separated list of columns representing the custom key. For any table without an explicit key configuration the table’s primary key column(s) will be used as message key.Example: dbserver1.inventory.orderlines:orderId,orderLineId;dbserver1.inventory.orders:id |
String |
|
pollIntervalMs (sqlserver) |
Frequency in milliseconds to wait for new change events to appear after receiving no events. Defaults to 500ms. |
500ms |
long |
provideTransactionMetadata (sqlserver) |
Enables transaction metadata extraction together with event counting |
false |
boolean |
queryFetchSize (sqlserver) |
The maximum number of records that should be loaded into memory while streaming. A value of 0 uses the default JDBC fetch size. |
0 |
int |
retriableRestartConnectorWaitMs (sqlserver) |
Time to wait before restarting connector after retriable exception occurs. Defaults to 10000ms. |
10s |
long |
sanitizeFieldNames (sqlserver) |
Whether field names will be sanitized to Avro naming conventions |
false |
boolean |
skippedOperations (sqlserver) |
The comma-separated list of operations to skip during streaming, defined as: 'i' for inserts; 'u' for updates; 'd' for deletes. By default, no operations will be skipped. |
String |
|
snapshotDelayMs (sqlserver) |
The number of milliseconds to delay before a snapshot will begin. |
0ms |
long |
snapshotFetchSize (sqlserver) |
The maximum number of records that should be loaded into memory while performing a snapshot |
int |
|
snapshotIsolationMode (sqlserver) |
Controls which transaction isolation level is used and how long the connector locks the monitored tables. The default is 'repeatable_read', which means that repeatable read isolation level is used. In addition, exclusive locks are taken only during schema snapshot. Using a value of 'exclusive' ensures that the connector holds the exclusive lock (and thus prevents any reads and updates) for all monitored tables during the entire snapshot duration. When 'snapshot' is specified, connector runs the initial snapshot in SNAPSHOT isolation level, which guarantees snapshot consistency. In addition, neither table nor row-level locks are held. When 'read_committed' is specified, connector runs the initial snapshot in READ COMMITTED isolation level. No long-running locks are taken, so that initial snapshot does not prevent other transactions from updating table rows. Snapshot consistency is not guaranteed.In 'read_uncommitted' mode neither table nor row-level locks are acquired, but connector does not guarantee snapshot consistency. |
repeatable_read |
String |
snapshotLockTimeoutMs (sqlserver) |
The maximum number of millis to wait for table locks at the beginning of a snapshot. If locks cannot be acquired in this time frame, the snapshot will be aborted. Defaults to 10 seconds |
10s |
long |
snapshotMode (sqlserver) |
The criteria for running a snapshot upon startup of the connector. Options include: 'initial' (the default) to specify the connector should run a snapshot only when no offsets are available for the logical server name; 'schema_only' to specify the connector should run a snapshot of the schema when no offsets are available for the logical server name. |
initial |
String |
snapshotSelectStatementOverrides (sqlserver) |
This property contains a comma-separated list of fully-qualified tables (DB_NAME.TABLE_NAME) or (SCHEMA_NAME.TABLE_NAME), depending on thespecific connectors . Select statements for the individual tables are specified in further configuration properties, one for each table, identified by the id 'snapshot.select.statement.overrides.DB_NAME.TABLE_NAME' or 'snapshot.select.statement.overrides.SCHEMA_NAME.TABLE_NAME', respectively. The value of those properties is the select statement to use when retrieving data from the specific table during snapshotting. A possible use case for large append-only tables is setting a specific point where to start (resume) snapshotting, in case a previous snapshotting was interrupted. |
String |
|
sourceStructVersion (sqlserver) |
A version of the format of the publicly visible source part in the message |
v2 |
String |
sourceTimestampMode (sqlserver) |
Configures the criteria of the attached timestamp within the source record (ts_ms).Options include:'commit', (default) the source timestamp is set to the instant where the record was committed in the database’processing', the source timestamp is set to the instant where the record was processed by Debezium. |
commit |
String |
tableBlacklist (sqlserver) |
A comma-separated list of regular expressions that match the fully-qualified names of tables to be excluded from monitoring (deprecated, use table.exclude.list instead) |
String |
|
tableExcludeList (sqlserver) |
A comma-separated list of regular expressions that match the fully-qualified names of tables to be excluded from monitoring |
String |
|
tableIgnoreBuiltin (sqlserver) |
Flag specifying whether built-in tables should be ignored. |
true |
boolean |
tableIncludeList (sqlserver) |
The tables for which changes are to be captured |
String |
|
tableWhitelist (sqlserver) |
The tables for which changes are to be captured (deprecated, use table.include.list instead) |
String |
|
timePrecisionMode (sqlserver) |
Time, date, and timestamps can be represented with different kinds of precisions, including:'adaptive' (the default) bases the precision of time, date, and timestamp values on the database column’s precision; 'adaptive_time_microseconds' like 'adaptive' mode, but TIME fields always use microseconds precision;'connect' always represents time, date, and timestamp values using Kafka Connect’s built-in representations for Time, Date, and Timestamp, which uses millisecond precision regardless of the database columns' precision . |
adaptive |
String |
tombstonesOnDelete (sqlserver) |
Whether delete operations should be represented by a delete event and a subsquenttombstone event (true) or only by a delete event (false). Emitting the tombstone event (the default behavior) allows Kafka to completely delete all events pertaining to the given key once the source record got deleted. |
false |
boolean |
Message headers
Consumer headers
The following headers are available when consuming change events from Debezium.
| Header constant | Header value | Type | Description |
|---|---|---|---|
|
|
|
The identifier of the connector, normally is this format "{server-name}.{database-name}.{table-name}". |
|
|
|
The key of the event, normally is the table Primary Key. |
|
|
|
The metadata about the source event, for example |
|
|
|
If presents, the type of event operation. Values for the connector are |
|
|
|
If presents, the time (using the system clock in the JVM) at which the connector processed the event. |
|
|
|
If presents, contains the state of the row before the event occurred. |
Message body
The message body if is not null (in case of tombstones), it contains the state of the row after the event occurred as Struct format or Map format if you use the included Type Converter from Struct to Map (please look below for more explanation).
Samples
Consuming events
Here is a very simple route that you can use in order to listen to Debezium events from SQL Server connector.
from("debezium-sqlserver:dbz-test-1?offsetStorageFileName=/usr/offset-file-1.dat&databaseHostName=localhost&databaseUser=debezium&databasePassword=dbz&databaseServerName=my-app-connector&databaseHistoryFileName=/usr/history-file-1.dat")
.log("Event received from Debezium : ${body}")
.log(" with this identifier ${headers.CamelDebeziumIdentifier}")
.log(" with these source metadata ${headers.CamelDebeziumSourceMetadata}")
.log(" the event occured upon this operation '${headers.CamelDebeziumSourceOperation}'")
.log(" on this database '${headers.CamelDebeziumSourceMetadata[db]}' and this table '${headers.CamelDebeziumSourceMetadata[table]}'")
.log(" with the key ${headers.CamelDebeziumKey}")
.log(" the previous value is ${headers.CamelDebeziumBefore}")By default, the component will emit the events in the body and CamelDebeziumBefore header as Struct data type, the reasoning behind this, is to perceive the schema information in case is needed.
However, the component as well contains a Type Converter that converts
from default output type of Struct to Map in order to leverage Camel’s rich Data Format types which many of them work out of box with Map data type.
To use it, you can either add Map.class type when you access the message e.g: exchange.getIn().getBody(Map.class), or you can convert the body always to Map from the route builder by adding .convertBodyTo(Map.class) to your Camel Route DSL after from statement.
We mentioned above about the schema, which can be used in case you need to perform advance data transformation and the schema is needed for that. If you choose not to convert your body to Map,
you can obtain the schema information as Schema type from Struct like this:
from("debezium-sqlserver:[name]?[options]])
.process(exchange -> {
final Struct bodyValue = exchange.getIn().getBody(Struct.class);
final Schema schemaValue = bodyValue.schema();
log.info("Body value is :" + bodyValue);
log.info("With Schema : " + schemaValue);
log.info("And fields of :" + schemaValue.fields());
log.info("Field name has `" + schemaValue.field("name").schema() + "` type");
});Important Note: This component is a thin wrapper around Debezium Engine as mentioned, therefore before using this component in production, you need to understand how Debezium works and how configurations can reflect the expected behavior, especially in regards to handling failures.
Spring Boot Auto-Configuration
When using debezium-sqlserver with Spring Boot make sure to use the following Maven dependency to have support for auto configuration:
<dependency>
<groupId>org.apache.camel.springboot</groupId>
<artifactId>camel-debezium-sqlserver-starter</artifactId>
<version>x.x.x</version>
<!-- use the same version as your Camel core version -->
</dependency>The component supports 65 options, which are listed below.
| Name | Description | Default | Type |
|---|---|---|---|
camel.component.debezium-sqlserver.additional-properties |
Additional properties for debezium components in case they can’t be set directly on the camel configurations (e.g: setting Kafka Connect properties needed by Debezium engine, for example setting KafkaOffsetBackingStore), the properties have to be prefixed with additionalProperties.. E.g: additionalProperties.transactional.id=12345&additionalProperties.schema.registry.url=\http://localhost:8811/avro |
Map |
|
camel.component.debezium-sqlserver.autowired-enabled |
Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc. |
true |
Boolean |
camel.component.debezium-sqlserver.bridge-error-handler |
Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored. |
false |
Boolean |
camel.component.debezium-sqlserver.column-blacklist |
Regular expressions matching columns to exclude from change events (deprecated, use column.exclude.list instead) |
String |
|
camel.component.debezium-sqlserver.column-exclude-list |
Regular expressions matching columns to exclude from change events |
String |
|
camel.component.debezium-sqlserver.column-include-list |
Regular expressions matching columns to include in change events |
String |
|
camel.component.debezium-sqlserver.column-propagate-source-type |
A comma-separated list of regular expressions matching fully-qualified names of columns that adds the columns original type and original length as parameters to the corresponding field schemas in the emitted change records. |
String |
|
camel.component.debezium-sqlserver.column-whitelist |
Regular expressions matching columns to include in change events (deprecated, use column.include.list instead) |
String |
|
camel.component.debezium-sqlserver.configuration |
Allow pre-configured Configurations to be set. The option is a org.apache.camel.component.debezium.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration type. |
SqlServerConnectorEmbeddedDebeziumConfiguration |
|
camel.component.debezium-sqlserver.converters |
Optional list of custom converters that would be used instead of default ones. The converters are defined using '.type' config option and configured using options '.' |
String |
|
camel.component.debezium-sqlserver.database-dbname |
The name of the database the connector should be monitoring. When working with a multi-tenant set-up, must be set to the CDB name. |
String |
|
camel.component.debezium-sqlserver.database-history |
The name of the DatabaseHistory class that should be used to store and recover database schema changes. The configuration properties for the history are prefixed with the 'database.history.' string. |
io.debezium.relational.history.FileDatabaseHistory |
String |
camel.component.debezium-sqlserver.database-history-file-filename |
The path to the file that will be used to record the database history |
String |
|
camel.component.debezium-sqlserver.database-history-kafka-bootstrap-servers |
A list of host/port pairs that the connector will use for establishing the initial connection to the Kafka cluster for retrieving database schema history previously stored by the connector. This should point to the same Kafka cluster used by the Kafka Connect process. |
String |
|
camel.component.debezium-sqlserver.database-history-kafka-recovery-attempts |
The number of attempts in a row that no data are returned from Kafka before recover completes. The maximum amount of time to wait after receiving no data is (recovery.attempts) x (recovery.poll.interval.ms). |
100 |
Integer |
camel.component.debezium-sqlserver.database-history-kafka-recovery-poll-interval-ms |
The number of milliseconds to wait while polling for persisted data during recovery. The option is a int type. |
100 |
Integer |
camel.component.debezium-sqlserver.database-history-kafka-topic |
The name of the topic for the database schema history |
String |
|
camel.component.debezium-sqlserver.database-hostname |
Resolvable hostname or IP address of the SQL Server database server. |
String |
|
camel.component.debezium-sqlserver.database-instance |
The SQL Server instance name |
String |
|
camel.component.debezium-sqlserver.database-password |
Password of the SQL Server database user to be used when connecting to the database. |
String |
|
camel.component.debezium-sqlserver.database-port |
Port of the SQL Server database server. |
1433 |
Integer |
camel.component.debezium-sqlserver.database-server-name |
Unique name that identifies the database server and all recorded offsets, and that is used as a prefix for all schemas and topics. Each distinct installation should have a separate namespace and be monitored by at most one Debezium connector. |
String |
|
camel.component.debezium-sqlserver.database-server-timezone |
The timezone of the server used to correctly shift the commit transaction timestamp on the client sideOptions include: Any valid Java ZoneId |
String |
|
camel.component.debezium-sqlserver.database-user |
Name of the SQL Server database user to be used when connecting to the database. |
String |
|
camel.component.debezium-sqlserver.datatype-propagate-source-type |
A comma-separated list of regular expressions matching the database-specific data type names that adds the data type’s original type and original length as parameters to the corresponding field schemas in the emitted change records. |
String |
|
camel.component.debezium-sqlserver.decimal-handling-mode |
Specify how DECIMAL and NUMERIC columns should be represented in change events, including:'precise' (the default) uses java.math.BigDecimal to represent values, which are encoded in the change events using a binary representation and Kafka Connect’s 'org.apache.kafka.connect.data.Decimal' type; 'string' uses string to represent values; 'double' represents values using Java’s 'double', which may not offer the precision but will be far easier to use in consumers. |
precise |
String |
camel.component.debezium-sqlserver.enabled |
Whether to enable auto configuration of the debezium-sqlserver component. This is enabled by default. |
Boolean |
|
camel.component.debezium-sqlserver.event-processing-failure-handling-mode |
Specify how failures during processing of events (i.e. when encountering a corrupted event) should be handled, including:'fail' (the default) an exception indicating the problematic event and its position is raised, causing the connector to be stopped; 'warn' the problematic event and its position will be logged and the event will be skipped;'ignore' the problematic event will be skipped. |
fail |
String |
camel.component.debezium-sqlserver.heartbeat-interval-ms |
Length of an interval in milli-seconds in in which the connector periodically sends heartbeat messages to a heartbeat topic. Use 0 to disable heartbeat messages. Disabled by default. The option is a int type. |
0 |
Integer |
camel.component.debezium-sqlserver.heartbeat-topics-prefix |
The prefix that is used to name heartbeat topics.Defaults to __debezium-heartbeat. |
__debezium-heartbeat |
String |
camel.component.debezium-sqlserver.include-schema-changes |
Whether the connector should publish changes in the database schema to a Kafka topic with the same name as the database server ID. Each schema change will be recorded using a key that contains the database name and whose value include logical description of the new schema and optionally the DDL statement(s).The default is 'true'. This is independent of how the connector internally records database history. |
true |
Boolean |
camel.component.debezium-sqlserver.internal-key-converter |
The Converter class that should be used to serialize and deserialize key data for offsets. The default is JSON converter. |
org.apache.kafka.connect.json.JsonConverter |
String |
camel.component.debezium-sqlserver.internal-value-converter |
The Converter class that should be used to serialize and deserialize value data for offsets. The default is JSON converter. |
org.apache.kafka.connect.json.JsonConverter |
String |
camel.component.debezium-sqlserver.max-batch-size |
Maximum size of each batch of source records. Defaults to 2048. |
2048 |
Integer |
camel.component.debezium-sqlserver.max-queue-size |
Maximum size of the queue for change events read from the database log but not yet recorded or forwarded. Defaults to 8192, and should always be larger than the maximum batch size. |
8192 |
Integer |
camel.component.debezium-sqlserver.message-key-columns |
A semicolon-separated list of expressions that match fully-qualified tables and column(s) to be used as message key. Each expression must match the pattern ':',where the table names could be defined as (DB_NAME.TABLE_NAME) or (SCHEMA_NAME.TABLE_NAME), depending on the specific connector,and the key columns are a comma-separated list of columns representing the custom key. For any table without an explicit key configuration the table’s primary key column(s) will be used as message key.Example: dbserver1.inventory.orderlines:orderId,orderLineId;dbserver1.inventory.orders:id |
String |
|
camel.component.debezium-sqlserver.offset-commit-policy |
The name of the Java class of the commit policy. It defines when offsets commit has to be triggered based on the number of events processed and the time elapsed since the last commit. This class must implement the interface 'OffsetCommitPolicy'. The default is a periodic commit policy based upon time intervals. |
io.debezium.embedded.spi.OffsetCommitPolicy.PeriodicCommitOffsetPolicy |
String |
camel.component.debezium-sqlserver.offset-commit-timeout-ms |
Maximum number of milliseconds to wait for records to flush and partition offset data to be committed to offset storage before cancelling the process and restoring the offset data to be committed in a future attempt. The default is 5 seconds. The option is a long type. |
5000 |
Long |
camel.component.debezium-sqlserver.offset-flush-interval-ms |
Interval at which to try committing offsets. The default is 1 minute. The option is a long type. |
60000 |
Long |
camel.component.debezium-sqlserver.offset-storage |
The name of the Java class that is responsible for persistence of connector offsets. |
org.apache.kafka.connect.storage.FileOffsetBackingStore |
String |
camel.component.debezium-sqlserver.offset-storage-file-name |
Path to file where offsets are to be stored. Required when offset.storage is set to the FileOffsetBackingStore. |
String |
|
camel.component.debezium-sqlserver.offset-storage-partitions |
The number of partitions used when creating the offset storage topic. Required when offset.storage is set to the 'KafkaOffsetBackingStore'. |
Integer |
|
camel.component.debezium-sqlserver.offset-storage-replication-factor |
Replication factor used when creating the offset storage topic. Required when offset.storage is set to the KafkaOffsetBackingStore |
Integer |
|
camel.component.debezium-sqlserver.offset-storage-topic |
The name of the Kafka topic where offsets are to be stored. Required when offset.storage is set to the KafkaOffsetBackingStore. |
String |
|
camel.component.debezium-sqlserver.poll-interval-ms |
Frequency in milliseconds to wait for new change events to appear after receiving no events. Defaults to 500ms. The option is a long type. |
500 |
Long |
camel.component.debezium-sqlserver.provide-transaction-metadata |
Enables transaction metadata extraction together with event counting |
false |
Boolean |
camel.component.debezium-sqlserver.query-fetch-size |
The maximum number of records that should be loaded into memory while streaming. A value of 0 uses the default JDBC fetch size. |
0 |
Integer |
camel.component.debezium-sqlserver.retriable-restart-connector-wait-ms |
Time to wait before restarting connector after retriable exception occurs. Defaults to 10000ms. The option is a long type. |
10000 |
Long |
camel.component.debezium-sqlserver.sanitize-field-names |
Whether field names will be sanitized to Avro naming conventions |
false |
Boolean |
camel.component.debezium-sqlserver.skipped-operations |
The comma-separated list of operations to skip during streaming, defined as: 'i' for inserts; 'u' for updates; 'd' for deletes. By default, no operations will be skipped. |
String |
|
camel.component.debezium-sqlserver.snapshot-delay-ms |
The number of milliseconds to delay before a snapshot will begin. The option is a long type. |
0 |
Long |
camel.component.debezium-sqlserver.snapshot-fetch-size |
The maximum number of records that should be loaded into memory while performing a snapshot |
Integer |
|
camel.component.debezium-sqlserver.snapshot-isolation-mode |
Controls which transaction isolation level is used and how long the connector locks the monitored tables. The default is 'repeatable_read', which means that repeatable read isolation level is used. In addition, exclusive locks are taken only during schema snapshot. Using a value of 'exclusive' ensures that the connector holds the exclusive lock (and thus prevents any reads and updates) for all monitored tables during the entire snapshot duration. When 'snapshot' is specified, connector runs the initial snapshot in SNAPSHOT isolation level, which guarantees snapshot consistency. In addition, neither table nor row-level locks are held. When 'read_committed' is specified, connector runs the initial snapshot in READ COMMITTED isolation level. No long-running locks are taken, so that initial snapshot does not prevent other transactions from updating table rows. Snapshot consistency is not guaranteed.In 'read_uncommitted' mode neither table nor row-level locks are acquired, but connector does not guarantee snapshot consistency. |
repeatable_read |
String |
camel.component.debezium-sqlserver.snapshot-lock-timeout-ms |
The maximum number of millis to wait for table locks at the beginning of a snapshot. If locks cannot be acquired in this time frame, the snapshot will be aborted. Defaults to 10 seconds. The option is a long type. |
10000 |
Long |
camel.component.debezium-sqlserver.snapshot-mode |
The criteria for running a snapshot upon startup of the connector. Options include: 'initial' (the default) to specify the connector should run a snapshot only when no offsets are available for the logical server name; 'schema_only' to specify the connector should run a snapshot of the schema when no offsets are available for the logical server name. |
initial |
String |
camel.component.debezium-sqlserver.snapshot-select-statement-overrides |
This property contains a comma-separated list of fully-qualified tables (DB_NAME.TABLE_NAME) or (SCHEMA_NAME.TABLE_NAME), depending on thespecific connectors . Select statements for the individual tables are specified in further configuration properties, one for each table, identified by the id 'snapshot.select.statement.overrides.DB_NAME.TABLE_NAME' or 'snapshot.select.statement.overrides.SCHEMA_NAME.TABLE_NAME', respectively. The value of those properties is the select statement to use when retrieving data from the specific table during snapshotting. A possible use case for large append-only tables is setting a specific point where to start (resume) snapshotting, in case a previous snapshotting was interrupted. |
String |
|
camel.component.debezium-sqlserver.source-struct-version |
A version of the format of the publicly visible source part in the message |
v2 |
String |
camel.component.debezium-sqlserver.source-timestamp-mode |
Configures the criteria of the attached timestamp within the source record (ts_ms).Options include:'commit', (default) the source timestamp is set to the instant where the record was committed in the database’processing', the source timestamp is set to the instant where the record was processed by Debezium. |
commit |
String |
camel.component.debezium-sqlserver.table-blacklist |
A comma-separated list of regular expressions that match the fully-qualified names of tables to be excluded from monitoring (deprecated, use table.exclude.list instead) |
String |
|
camel.component.debezium-sqlserver.table-exclude-list |
A comma-separated list of regular expressions that match the fully-qualified names of tables to be excluded from monitoring |
String |
|
camel.component.debezium-sqlserver.table-ignore-builtin |
Flag specifying whether built-in tables should be ignored. |
true |
Boolean |
camel.component.debezium-sqlserver.table-include-list |
The tables for which changes are to be captured |
String |
|
camel.component.debezium-sqlserver.table-whitelist |
The tables for which changes are to be captured (deprecated, use table.include.list instead) |
String |
|
camel.component.debezium-sqlserver.time-precision-mode |
Time, date, and timestamps can be represented with different kinds of precisions, including:'adaptive' (the default) bases the precision of time, date, and timestamp values on the database column’s precision; 'adaptive_time_microseconds' like 'adaptive' mode, but TIME fields always use microseconds precision;'connect' always represents time, date, and timestamp values using Kafka Connect’s built-in representations for Time, Date, and Timestamp, which uses millisecond precision regardless of the database columns' precision . |
adaptive |
String |
camel.component.debezium-sqlserver.tombstones-on-delete |
Whether delete operations should be represented by a delete event and a subsquenttombstone event (true) or only by a delete event (false). Emitting the tombstone event (the default behavior) allows Kafka to completely delete all events pertaining to the given key once the source record got deleted. |
false |
Boolean |