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..
DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder.autowiredEnabled(boolean autowiredEnabled)
Whether autowiring is enabled.
DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder.binaryHandlingMode(String binaryHandlingMode)
Specify how binary (blob, binary, etc.) columns should be represented
in change events, including: 'bytes' represents binary data as byte
array (default); 'base64' represents binary data as base64-encoded
string; 'base64-url-safe' represents binary data as
base64-url-safe-encoded string; 'hex' represents binary data as
hex-encoded (base16) string.
DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder.bridgeErrorHandler(boolean bridgeErrorHandler)
Allows for bridging the consumer to the Camel routing Error Handler,
which mean any exceptions (if possible) occurred while the Camel
consumer is trying to pickup incoming messages, or the likes, will
now be processed as a message and handled by the routing Error
Handler.
DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder.columnExcludeList(String columnExcludeList)
Regular expressions matching columns to exclude from change events.
DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder.columnIncludeList(String columnIncludeList)
Regular expressions matching columns to include in change events.
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.
DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder.configuration(org.apache.camel.component.debezium.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration configuration)
Allow pre-configured Configurations to be set.
DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder.converters(String converters)
Optional list of custom converters that would be used instead of
default ones.
DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder.customMetricTags(String customMetricTags)
The custom metric tags will accept key-value pairs to customize the
MBean object name which should be appended the end of regular name,
each key would represent a tag for the MBean object name, and the
corresponding value would be the value of that tag the key is.
DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder.databaseHostname(String databaseHostname)
Resolvable hostname or IP address of the database server.
DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder.databaseInstance(String databaseInstance)
The SQL Server instance name.
DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder.databaseNames(String databaseNames)
The names of the databases from which the connector should capture
changes.
DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder.databasePassword(String databasePassword)
Password of the database user to be used when connecting to the
database.
DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder.databasePort(int databasePort)
Port of the database server.
DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder.databaseQueryTimeoutMs(int databaseQueryTimeoutMs)
Time to wait for a query to execute, given in milliseconds.
DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder.databaseUser(String databaseUser)
Name of the database user to be used when connecting to the database.
DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder.dataQueryMode(String dataQueryMode)
Controls how the connector queries CDC data.
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.
Debezium SQL Server Connector (camel-debezium-sqlserver)
Capture changes from an SQL Server database.
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.
DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder.errorsMaxRetries(int errorsMaxRetries)
The maximum number of retries on connection errors before failing (-1
= no limit, 0 = disabled, 0 = num of retries).
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.
The query executed with every heartbeat.
DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder.heartbeatIntervalMs(int heartbeatIntervalMs)
Length of an interval in milli-seconds in in which the connector
periodically sends heartbeat messages to a heartbeat topic.
The prefix that is used to name heartbeat topics.Defaults to
__debezium-heartbeat.
DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder.includeSchemaChanges(boolean includeSchemaChanges)
Whether the connector should publish changes in the database schema
to a Kafka topic with the same name as the database server ID.
DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder.includeSchemaComments(boolean includeSchemaComments)
Whether the connector parse table and column's comment to metadata
object.
Detect schema change during an incremental snapshot and re-select a
current chunk to avoid locking DDLs.
The maximum size of chunk (number of documents/rows) for incremental
snapshotting.
Add OPTION(RECOMPILE) on each SELECT statement during the incremental
snapshot process.
Specify the strategy used for watermarking during an incremental
snapshot: 'insert_insert' both open and close signal is written into
signal data collection (default); 'insert_delete' only open signal is
written on signal data collection, the close will delete the relative
open signal;.
The Converter class that should be used to serialize and deserialize
key data for offsets.
The Converter class that should be used to serialize and deserialize
value data for offsets.
DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder.maxBatchSize(int maxBatchSize)
Maximum size of each batch of source records.
DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder.maxIterationTransactions(int maxIterationTransactions)
This property can be used to reduce the connector memory usage
footprint when changes are streamed from multiple tables per
database.
DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder.maxQueueSize(int maxQueueSize)
Maximum size of the queue for change events read from the database
log but not yet recorded or forwarded.
DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder.maxQueueSizeInBytes(long maxQueueSizeInBytes)
Maximum size of the queue in bytes for change events read from the
database log but not yet recorded or forwarded.
DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder.messageKeyColumns(String messageKeyColumns)
A semicolon-separated list of expressions that match fully-qualified
tables and column(s) to be used as message key.
List of notification channels names that are enabled.
The name of the topic for the notifications.
DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder.offsetCommitPolicy(String offsetCommitPolicy)
The name of the Java class of the commit policy.
DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder.offsetCommitTimeoutMs(long offsetCommitTimeoutMs)
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.
DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder.offsetFlushIntervalMs(long offsetFlushIntervalMs)
Interval at which to try committing offsets.
DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder.offsetStorage(String offsetStorage)
The name of the Java class that is responsible for persistence of
connector offsets.
Path to file where offsets are to be stored.
DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder.offsetStoragePartitions(int offsetStoragePartitions)
The number of partitions used when creating the offset storage topic.
Replication factor used when creating the offset storage topic.
DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder.offsetStorageTopic(String offsetStorageTopic)
The name of the Kafka topic where offsets are to be stored.
DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder.pollIntervalMs(long pollIntervalMs)
Time to wait for new change events to appear after receiving no
events, given in milliseconds.
DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder.postProcessors(String postProcessors)
Optional list of post processors.
DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder.provideTransactionMetadata(boolean provideTransactionMetadata)
Enables transaction metadata extraction together with event counting.
Time to wait before restarting connector after retriable exception
occurs.
The name of the SchemaHistory class that should be used to store and
recover database schema changes.
The path to the file that will be used to record the database schema
history.
Controls the action Debezium will take when it meets a DDL statement
in binlog, that it cannot parse.By default the connector will stop
operating but by changing the setting it can ignore the statements
which it cannot parse.
Controls what DDL will Debezium store in database schema history.
Controls what DDL will Debezium store in database schema history.
Specify how schema names should be adjusted for compatibility with
the message converter used by the connector, including: 'avro'
replaces the characters that cannot be used in the Avro type name
with underscore; 'avro_unicode' replaces the underscore or characters
that cannot be used in the Avro type name with corresponding unicode
like _uxxxx.
The name of the data collection that is used to send signals/commands
to Debezium.
List of channels names that are enabled.
DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder.signalPollIntervalMs(long signalPollIntervalMs)
Interval for looking for new signals in registered channels, given in
milliseconds.
DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder.skippedOperations(String skippedOperations)
The comma-separated list of operations to skip during streaming,
defined as: 'c' for inserts/create; 'u' for updates; 'd' for deletes,
't' for truncates, and 'none' to indicate nothing skipped.
DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder.snapshotDelayMs(long snapshotDelayMs)
A delay period before a snapshot will begin, given in milliseconds.
DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder.snapshotFetchSize(int snapshotFetchSize)
The maximum number of records that should be loaded into memory while
performing a snapshot.
This setting must be set to specify a list of tables/collections
whose snapshot must be taken on creating or restarting the connector.
Controls which transaction isolation level is used and how long the
connector locks the captured tables.
DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder.snapshotLockTimeoutMs(long snapshotLockTimeoutMs)
The maximum number of millis to wait for table locks at the beginning
of a snapshot.
DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder.snapshotMaxThreads(int snapshotMaxThreads)
The maximum number of threads used to perform the snapshot.
DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder.snapshotMode(String snapshotMode)
The criteria for running a snapshot upon startup of the connector.
When 'snapshot.mode' is set as configuration_based, this setting
permits to specify whenever the data should be snapshotted or not.
When 'snapshot.mode' is set as configuration_based, this setting
permits to specify whenever the data should be snapshotted or not in
case of error.
When 'snapshot.mode' is set as configuration_based, this setting
permits to specify whenever the schema should be snapshotted or not
in case of error.
When 'snapshot.mode' is set as configuration_based, this setting
permits to specify whenever the schema should be snapshotted or not.
When 'snapshot.mode' is set as configuration_based, this setting
permits to specify whenever the stream should start or not after
snapshot.
When 'snapshot.mode' is set as custom, this setting must be set to
specify a the name of the custom implementation provided in the
'name()' method.
This property contains a comma-separated list of fully-qualified
tables (DB_NAME.TABLE_NAME) or (SCHEMA_NAME.TABLE_NAME), depending on
the specific connectors.
Controls the order in which tables are processed in the initial
snapshot.
The name of the SourceInfoStructMaker class that returns SourceInfo
schema and struct.
DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder.streamingDelayMs(long streamingDelayMs)
A delay period after the snapshot is completed and the streaming
begins, given in milliseconds.
DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder.tableExcludeList(String tableExcludeList)
A comma-separated list of regular expressions that match the
fully-qualified names of tables to be excluded from monitoring.
DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder.tableIgnoreBuiltin(boolean tableIgnoreBuiltin)
Flag specifying whether built-in tables should be ignored.
DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder.tableIncludeList(String tableIncludeList)
The tables for which changes are to be captured.
DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder.timePrecisionMode(String timePrecisionMode)
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.
DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder.tombstonesOnDelete(boolean tombstonesOnDelete)
Whether delete operations should be represented by a delete event and
a subsequent tombstone event (true) or only by a delete event
(false).
The name of the TopicNamingStrategy class that should be used to
determine the topic name for data change, schema change, transaction,
heartbeat event etc.
DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder.topicPrefix(String topicPrefix)
Topic prefix that identifies and provides a namespace for the
particular database server/cluster is capturing changes.
Class to make transaction context & transaction struct/schemas.