DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder (Camel

All Superinterfaces:

ComponentBuilder<org.apache.camel.component.debezium.DebeziumSqlserverComponent>

All Known Implementing Classes:

DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilderImpl

Enclosing interface:

DebeziumSqlserverComponentBuilderFactory
```
public static interface DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder
extends ComponentBuilder<org.apache.camel.component.debezium.DebeziumSqlserverComponent>
```
Builder for the Debezium SQL Server Connector component.

Method Summary

All Methods Instance Methods Default Methods
Modifier and Type	Method and Description
`default DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder`	`additionalProperties(Map<String,Object> additionalProperties)` 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..
`default DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder`	`basicPropertyBinding(boolean basicPropertyBinding)` Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities.
`default DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder`	`bridgeErrorHandler(boolean bridgeErrorHandler)` 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.
`default DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder`	`columnBlacklist(String columnBlacklist)` Description is not available here, please check Debezium website for corresponding key 'column.blacklist' description.
`default DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder`	`configuration(org.apache.camel.component.debezium.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration configuration)` Allow pre-configured Configurations to be set.
`default DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder`	`databaseDbname(String databaseDbname)` The name of the database the connector should be monitoring.
`default DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder`	`databaseHistory(String databaseHistory)` The name of the DatabaseHistory class that should be used to store and recover database schema changes.
`default DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder`	`databaseHistoryFileFilename(String databaseHistoryFileFilename)` The path to the file that will be used to record the database history.
`default DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder`	`databaseHistoryKafkaBootstrapServers(String databaseHistoryKafkaBootstrapServers)` 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.
`default DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder`	`databaseHistoryKafkaRecoveryAttempts(int databaseHistoryKafkaRecoveryAttempts)` The number of attempts in a row that no data are returned from Kafka before recover completes.
`default DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder`	`databaseHistoryKafkaRecoveryPollIntervalMs(int databaseHistoryKafkaRecoveryPollIntervalMs)` The number of milliseconds to wait while polling for persisted data during recovery.
`default DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder`	`databaseHistoryKafkaTopic(String databaseHistoryKafkaTopic)` The name of the topic for the database schema history.
`default DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder`	`databaseHostname(String databaseHostname)` Resolvable hostname or IP address of the SQL Server database server.
`default DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder`	`databasePassword(String databasePassword)` Password of the SQL Server database user to be used when connecting to the database.
`default DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder`	`databasePort(int databasePort)` Port of the SQL Server database server.
`default DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder`	`databaseServerName(String databaseServerName)` Unique name that identifies the database server and all recorded offsets, and that is used as a prefix for all schemas and topics.
`default DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder`	`databaseServerTimezone(String databaseServerTimezone)` The timezone of the server used to correctly shift the commit transaction timestamp on the client sideOptions include: Any valid Java ZoneId.
`default DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder`	`databaseUser(String databaseUser)` Name of the SQL Server database user to be used when connecting to the database.
`default DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder`	`decimalHandlingMode(String decimalHandlingMode)` 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.
`default DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder`	`eventProcessingFailureHandlingMode(String eventProcessingFailureHandlingMode)` Specify how failures during processing of events (i.e.
`default 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.
`default DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder`	`heartbeatTopicsPrefix(String heartbeatTopicsPrefix)` The prefix that is used to name heartbeat topics.Defaults to __debezium-heartbeat.
`default DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder`	`internalKeyConverter(String internalKeyConverter)` The Converter class that should be used to serialize and deserialize key data for offsets.
`default DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder`	`internalValueConverter(String internalValueConverter)` The Converter class that should be used to serialize and deserialize value data for offsets.
`default DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder`	`maxBatchSize(int maxBatchSize)` Maximum size of each batch of source records.
`default DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder`	`maxQueueSize(int maxQueueSize)` Maximum size of the queue for change events read from the database log but not yet recorded or forwarded.
`default 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.
`default DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder`	`offsetCommitPolicy(String offsetCommitPolicy)` The name of the Java class of the commit policy.
`default 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.
`default DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder`	`offsetFlushIntervalMs(long offsetFlushIntervalMs)` Interval at which to try committing offsets.
`default DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder`	`offsetStorage(String offsetStorage)` The name of the Java class that is responsible for persistence of connector offsets.
`default DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder`	`offsetStorageFileName(String offsetStorageFileName)` Path to file where offsets are to be stored.
`default DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder`	`offsetStoragePartitions(int offsetStoragePartitions)` The number of partitions used when creating the offset storage topic.
`default DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder`	`offsetStorageReplicationFactor(int offsetStorageReplicationFactor)` Replication factor used when creating the offset storage topic.
`default DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder`	`offsetStorageTopic(String offsetStorageTopic)` The name of the Kafka topic where offsets are to be stored.
`default DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder`	`pollIntervalMs(long pollIntervalMs)` Frequency in milliseconds to wait for new change events to appear after receiving no events.
`default DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder`	`provideTransactionMetadata(boolean provideTransactionMetadata)` Enables transaction metadata extraction together with event counting.
`default DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder`	`snapshotDelayMs(long snapshotDelayMs)` The number of milliseconds to delay before a snapshot will begin.
`default DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder`	`snapshotFetchSize(int snapshotFetchSize)` The maximum number of records that should be loaded into memory while performing a snapshot.
`default DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder`	`snapshotLockTimeoutMs(long snapshotLockTimeoutMs)` The maximum number of millis to wait for table locks at the beginning of a snapshot.
`default DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder`	`snapshotMode(String snapshotMode)` The criteria for running a snapshot upon startup of the connector.
`default DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder`	`snapshotSelectStatementOverrides(String snapshotSelectStatementOverrides)` This property contains a comma-separated list of fully-qualified tables (DB_NAME.TABLE_NAME) or (SCHEMA_NAME.TABLE_NAME), depending on thespecific connectors .
`default DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder`	`sourceStructVersion(String sourceStructVersion)` A version of the format of the publicly visible source part in the message.
`default DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder`	`tableBlacklist(String tableBlacklist)` Description is not available here, please check Debezium website for corresponding key 'table.blacklist' description.
`default DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder`	`tableIgnoreBuiltin(boolean tableIgnoreBuiltin)` Flag specifying whether built-in tables should be ignored.
`default DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder`	`tableWhitelist(String tableWhitelist)` The tables for which changes are to be captured.
`default 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 .
`default DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder`	`tombstonesOnDelete(boolean tombstonesOnDelete)` Whether delete operations should be represented by a delete event and a subsquenttombstone event (true) or only by a delete event (false).

Methods inherited from interface org.apache.camel.builder.component.ComponentBuilder
build, build, doSetProperty, register

- Method Detail
  - additionalProperties
```
default DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder additionalProperties(Map<String,Object> additionalProperties)
```
    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. The option is a: java.util.Map type. Group: common
  - bridgeErrorHandler
```
default DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder bridgeErrorHandler(boolean bridgeErrorHandler)
```
    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. The option is a: boolean type. Default: false Group: consumer
  - configuration
```
default DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder configuration(org.apache.camel.component.debezium.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration configuration)
```
    Allow pre-configured Configurations to be set. The option is a: org.apache.camel.component.debezium.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration type. Group: consumer
  - internalKeyConverter
```
default DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder internalKeyConverter(String internalKeyConverter)
```
    The Converter class that should be used to serialize and deserialize key data for offsets. The default is JSON converter. The option is a: java.lang.String type. Default: org.apache.kafka.connect.json.JsonConverter Group: consumer
  - internalValueConverter
```
default DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder internalValueConverter(String internalValueConverter)
```
    The Converter class that should be used to serialize and deserialize value data for offsets. The default is JSON converter. The option is a: java.lang.String type. Default: org.apache.kafka.connect.json.JsonConverter Group: consumer
  - offsetCommitPolicy
```
default DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder offsetCommitPolicy(String offsetCommitPolicy)
```
    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. The option is a: java.lang.String type. Default: io.debezium.embedded.spi.OffsetCommitPolicy.PeriodicCommitOffsetPolicy Group: consumer
  - offsetCommitTimeoutMs
```
default 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. The default is 5 seconds. The option is a: long type. Default: 5000 Group: consumer
  - offsetFlushIntervalMs
```
default DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder offsetFlushIntervalMs(long offsetFlushIntervalMs)
```
    Interval at which to try committing offsets. The default is 1 minute. The option is a: long type. Default: 60000 Group: consumer
  - offsetStorage
```
default DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder offsetStorage(String offsetStorage)
```
    The name of the Java class that is responsible for persistence of connector offsets. The option is a: java.lang.String type. Default: org.apache.kafka.connect.storage.FileOffsetBackingStore Group: consumer
  - offsetStorageFileName
```
default DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder offsetStorageFileName(String offsetStorageFileName)
```
    Path to file where offsets are to be stored. Required when offset.storage is set to the FileOffsetBackingStore. The option is a: java.lang.String type. Group: consumer
  - offsetStoragePartitions
```
default DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder offsetStoragePartitions(int offsetStoragePartitions)
```
    The number of partitions used when creating the offset storage topic. Required when offset.storage is set to the 'KafkaOffsetBackingStore'. The option is a: int type. Group: consumer
  - offsetStorageReplicationFactor
```
default DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder offsetStorageReplicationFactor(int offsetStorageReplicationFactor)
```
    Replication factor used when creating the offset storage topic. Required when offset.storage is set to the KafkaOffsetBackingStore. The option is a: int type. Group: consumer
  - offsetStorageTopic
```
default DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder offsetStorageTopic(String offsetStorageTopic)
```
    The name of the Kafka topic where offsets are to be stored. Required when offset.storage is set to the KafkaOffsetBackingStore. The option is a: java.lang.String type. Group: consumer
  - basicPropertyBinding
```
default DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder basicPropertyBinding(boolean basicPropertyBinding)
```
    Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities. The option is a: boolean type. Default: false Group: advanced
  - columnBlacklist
```
default DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder columnBlacklist(String columnBlacklist)
```
    Description is not available here, please check Debezium website for corresponding key 'column.blacklist' description. The option is a: java.lang.String type. Group: sqlserver
  - databaseDbname
```
default DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder databaseDbname(String databaseDbname)
```
    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. The option is a: java.lang.String type. Group: sqlserver
  - databaseHistory
```
default DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder databaseHistory(String databaseHistory)
```
    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. The option is a: java.lang.String type. Default: io.debezium.relational.history.FileDatabaseHistory Group: sqlserver
  - databaseHistoryFileFilename
```
default DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder databaseHistoryFileFilename(String databaseHistoryFileFilename)
```
    The path to the file that will be used to record the database history. The option is a: java.lang.String type. Group: sqlserver
  - databaseHistoryKafkaBootstrapServers
```
default DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder databaseHistoryKafkaBootstrapServers(String databaseHistoryKafkaBootstrapServers)
```
    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. The option is a: java.lang.String type. Group: sqlserver
  - databaseHistoryKafkaRecoveryAttempts
```
default DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder databaseHistoryKafkaRecoveryAttempts(int databaseHistoryKafkaRecoveryAttempts)
```
    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). The option is a: int type. Default: 100 Group: sqlserver
  - databaseHistoryKafkaRecoveryPollIntervalMs
```
default DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder databaseHistoryKafkaRecoveryPollIntervalMs(int databaseHistoryKafkaRecoveryPollIntervalMs)
```
    The number of milliseconds to wait while polling for persisted data during recovery. The option is a: int type. Default: 100 Group: sqlserver
  - databaseHistoryKafkaTopic
```
default DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder databaseHistoryKafkaTopic(String databaseHistoryKafkaTopic)
```
    The name of the topic for the database schema history. The option is a: java.lang.String type. Group: sqlserver
  - databaseHostname
```
default DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder databaseHostname(String databaseHostname)
```
    Resolvable hostname or IP address of the SQL Server database server. The option is a: java.lang.String type. Group: sqlserver
  - databasePassword
```
default DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder databasePassword(String databasePassword)
```
    Password of the SQL Server database user to be used when connecting to the database. The option is a: java.lang.String type. Group: sqlserver
  - databasePort
```
default DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder databasePort(int databasePort)
```
    Port of the SQL Server database server. The option is a: int type. Default: 1433 Group: sqlserver
  - databaseServerName
```
default DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder databaseServerName(String databaseServerName)
```
    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. The option is a: java.lang.String type. Group: sqlserver
  - databaseServerTimezone
```
default DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder databaseServerTimezone(String databaseServerTimezone)
```
    The timezone of the server used to correctly shift the commit transaction timestamp on the client sideOptions include: Any valid Java ZoneId. The option is a: java.lang.String type. Group: sqlserver
  - databaseUser
```
default DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder databaseUser(String databaseUser)
```
    Name of the SQL Server database user to be used when connecting to the database. The option is a: java.lang.String type. Group: sqlserver
  - decimalHandlingMode
```
default DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder decimalHandlingMode(String decimalHandlingMode)
```
    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. The option is a: java.lang.String type. Default: precise Group: sqlserver
  - eventProcessingFailureHandlingMode
```
default DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder eventProcessingFailureHandlingMode(String eventProcessingFailureHandlingMode)
```
    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 option is a: java.lang.String type. Default: fail Group: sqlserver
  - heartbeatIntervalMs
```
default 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. Use 0 to disable heartbeat messages. Disabled by default. The option is a: int type. Default: 0 Group: sqlserver
  - heartbeatTopicsPrefix
```
default DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder heartbeatTopicsPrefix(String heartbeatTopicsPrefix)
```
    The prefix that is used to name heartbeat topics.Defaults to __debezium-heartbeat. The option is a: java.lang.String type. Default: __debezium-heartbeat Group: sqlserver
  - maxBatchSize
```
default DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder maxBatchSize(int maxBatchSize)
```
    Maximum size of each batch of source records. Defaults to 2048. The option is a: int type. Default: 2048 Group: sqlserver
  - maxQueueSize
```
default DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder maxQueueSize(int maxQueueSize)
```
    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. The option is a: int type. Default: 8192 Group: sqlserver
  - messageKeyColumns
```
default 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. 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. The option is a: java.lang.String type. Group: sqlserver
  - pollIntervalMs
```
default DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder pollIntervalMs(long pollIntervalMs)
```
    Frequency in milliseconds to wait for new change events to appear after receiving no events. Defaults to 500ms. The option is a: long type. Default: 500 Group: sqlserver
  - provideTransactionMetadata
```
default DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder provideTransactionMetadata(boolean provideTransactionMetadata)
```
    Enables transaction metadata extraction together with event counting. The option is a: boolean type. Default: false Group: sqlserver
  - snapshotDelayMs
```
default DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder snapshotDelayMs(long snapshotDelayMs)
```
    The number of milliseconds to delay before a snapshot will begin. The option is a: long type. Default: 0 Group: sqlserver
  - snapshotFetchSize
```
default DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder snapshotFetchSize(int snapshotFetchSize)
```
    The maximum number of records that should be loaded into memory while performing a snapshot. The option is a: int type. Group: sqlserver
  - snapshotLockTimeoutMs
```
default DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder snapshotLockTimeoutMs(long snapshotLockTimeoutMs)
```
    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. Default: 10000 Group: sqlserver
  - snapshotMode
```
default DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder snapshotMode(String snapshotMode)
```
    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. The option is a: java.lang.String type. Default: initial Group: sqlserver
  - snapshotSelectStatementOverrides
```
default DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder snapshotSelectStatementOverrides(String snapshotSelectStatementOverrides)
```
    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. The option is a: java.lang.String type. Group: sqlserver
  - sourceStructVersion
```
default DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder sourceStructVersion(String sourceStructVersion)
```
    A version of the format of the publicly visible source part in the message. The option is a: java.lang.String type. Default: v2 Group: sqlserver
  - tableBlacklist
```
default DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder tableBlacklist(String tableBlacklist)
```
    Description is not available here, please check Debezium website for corresponding key 'table.blacklist' description. The option is a: java.lang.String type. Group: sqlserver
  - tableIgnoreBuiltin
```
default DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder tableIgnoreBuiltin(boolean tableIgnoreBuiltin)
```
    Flag specifying whether built-in tables should be ignored. The option is a: boolean type. Default: true Group: sqlserver
  - tableWhitelist
```
default DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder tableWhitelist(String tableWhitelist)
```
    The tables for which changes are to be captured. The option is a: java.lang.String type. Group: sqlserver
  - timePrecisionMode
```
default 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 . The option is a: java.lang.String type. Default: adaptive Group: sqlserver
  - tombstonesOnDelete
```
default DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder tombstonesOnDelete(boolean tombstonesOnDelete)
```
    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. The option is a: boolean type. Default: false Group: sqlserver

Interface DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder

Method Summary

Methods inherited from interface org.apache.camel.builder.component.ComponentBuilder

Method Detail

additionalProperties

bridgeErrorHandler

configuration

internalKeyConverter

internalValueConverter

offsetCommitPolicy

offsetCommitTimeoutMs

offsetFlushIntervalMs

offsetStorage

offsetStorageFileName

offsetStoragePartitions

offsetStorageReplicationFactor

offsetStorageTopic

basicPropertyBinding

columnBlacklist

databaseDbname

databaseHistory

databaseHistoryFileFilename

databaseHistoryKafkaBootstrapServers

databaseHistoryKafkaRecoveryAttempts

databaseHistoryKafkaRecoveryPollIntervalMs

databaseHistoryKafkaTopic

databaseHostname

databasePassword

databasePort

databaseServerName

databaseServerTimezone

databaseUser

decimalHandlingMode

eventProcessingFailureHandlingMode

heartbeatIntervalMs

heartbeatTopicsPrefix

maxBatchSize

maxQueueSize

messageKeyColumns

pollIntervalMs

provideTransactionMetadata

snapshotDelayMs

snapshotFetchSize

snapshotLockTimeoutMs

snapshotMode

snapshotSelectStatementOverrides

sourceStructVersion

tableBlacklist

tableIgnoreBuiltin

tableWhitelist

timePrecisionMode

tombstonesOnDelete