Package org.apache.camel.builder.component.dsl

Interface DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder

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 Details

    • 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&amp;additionalProperties.schema.registry.url=http://localhost:8811/avro. The option is a: <code>java.util.Map&lt;java.lang.String, java.lang.Object&gt;</code> type. Group: common
      Parameters:
      additionalProperties - the value to set
      Returns:
      the dsl builder

    • 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: <code>boolean</code> type. Default: false Group: consumer
      Parameters:
      bridgeErrorHandler - the value to set
      Returns:
      the dsl builder

    • configuration

      default DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder configuration(org.apache.camel.component.debezium.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration configuration)
      Allow pre-configured Configurations to be set. The option is a: <code>org.apache.camel.component.debezium.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration</code> type. Group: consumer
      Parameters:
      configuration - the value to set
      Returns:
      the dsl builder

    • 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: <code>java.lang.String</code> type. Default: org.apache.kafka.connect.json.JsonConverter Group: consumer
      Parameters:
      internalKeyConverter - the value to set
      Returns:
      the dsl builder

    • 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: <code>java.lang.String</code> type. Default: org.apache.kafka.connect.json.JsonConverter Group: consumer
      Parameters:
      internalValueConverter - the value to set
      Returns:
      the dsl builder

    • 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: <code>java.lang.String</code> type. Group: consumer
      Parameters:
      offsetCommitPolicy - the value to set
      Returns:
      the dsl builder

    • 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: <code>long</code> type. Default: 5000 Group: consumer
      Parameters:
      offsetCommitTimeoutMs - the value to set
      Returns:
      the dsl builder

    • offsetFlushIntervalMs

      default DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder offsetFlushIntervalMs(long offsetFlushIntervalMs)
      Interval at which to try committing offsets. The default is 1 minute. The option is a: <code>long</code> type. Default: 60000 Group: consumer
      Parameters:
      offsetFlushIntervalMs - the value to set
      Returns:
      the dsl builder

    • 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: <code>java.lang.String</code> type. Default: org.apache.kafka.connect.storage.FileOffsetBackingStore Group: consumer
      Parameters:
      offsetStorage - the value to set
      Returns:
      the dsl builder

    • 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: <code>java.lang.String</code> type. Group: consumer
      Parameters:
      offsetStorageFileName - the value to set
      Returns:
      the dsl builder

    • 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: <code>int</code> type. Group: consumer
      Parameters:
      offsetStoragePartitions - the value to set
      Returns:
      the dsl builder

    • 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: <code>int</code> type. Group: consumer
      Parameters:
      offsetStorageReplicationFactor - the value to set
      Returns:
      the dsl builder

    • 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: <code>java.lang.String</code> type. Group: consumer
      Parameters:
      offsetStorageTopic - the value to set
      Returns:
      the dsl builder

    • autowiredEnabled

      default DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder autowiredEnabled(boolean autowiredEnabled)
      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. The option is a: <code>boolean</code> type. Default: true Group: advanced
      Parameters:
      autowiredEnabled - the value to set
      Returns:
      the dsl builder

    • binaryHandlingMode

      default 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'hex' represents binary data as hex-encoded (base16) string. The option is a: <code>java.lang.String</code> type. Default: bytes Group: sqlserver
      Parameters:
      binaryHandlingMode - the value to set
      Returns:
      the dsl builder

    • columnBlacklist

      default DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder columnBlacklist(String columnBlacklist)
      Regular expressions matching columns to exclude from change events (deprecated, use column.exclude.list instead). The option is a: <code>java.lang.String</code> type. Group: sqlserver
      Parameters:
      columnBlacklist - the value to set
      Returns:
      the dsl builder

    • columnExcludeList

      default DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder columnExcludeList(String columnExcludeList)
      Regular expressions matching columns to exclude from change events. The option is a: <code>java.lang.String</code> type. Group: sqlserver
      Parameters:
      columnExcludeList - the value to set
      Returns:
      the dsl builder

    • columnIncludeList

      default DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder columnIncludeList(String columnIncludeList)
      Regular expressions matching columns to include in change events. The option is a: <code>java.lang.String</code> type. Group: sqlserver
      Parameters:
      columnIncludeList - the value to set
      Returns:
      the dsl builder

    • columnPropagateSourceType

      default DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder columnPropagateSourceType(String columnPropagateSourceType)
      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. The option is a: <code>java.lang.String</code> type. Group: sqlserver
      Parameters:
      columnPropagateSourceType - the value to set
      Returns:
      the dsl builder

    • columnWhitelist

      default DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder columnWhitelist(String columnWhitelist)
      Regular expressions matching columns to include in change events (deprecated, use column.include.list instead). The option is a: <code>java.lang.String</code> type. Group: sqlserver
      Parameters:
      columnWhitelist - the value to set
      Returns:
      the dsl builder

    • converters

      default DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder converters(String 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 '.'. The option is a: <code>java.lang.String</code> type. Group: sqlserver
      Parameters:
      converters - the value to set
      Returns:
      the dsl builder

    • databaseDbname

      default DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder databaseDbname(String databaseDbname)
      The name of the database from which the connector should capture changes. The option is a: <code>java.lang.String</code> type. Group: sqlserver
      Parameters:
      databaseDbname - the value to set
      Returns:
      the dsl builder

    • 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: <code>java.lang.String</code> type. Default: io.debezium.relational.history.FileDatabaseHistory Group: sqlserver
      Parameters:
      databaseHistory - the value to set
      Returns:
      the dsl builder

    • 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: <code>java.lang.String</code> type. Group: sqlserver
      Parameters:
      databaseHistoryFileFilename - the value to set
      Returns:
      the dsl builder

    • 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: <code>java.lang.String</code> type. Group: sqlserver
      Parameters:
      databaseHistoryKafkaBootstrapServers - the value to set
      Returns:
      the dsl builder

    • databaseHistoryKafkaQueryTimeoutMs

      default DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder databaseHistoryKafkaQueryTimeoutMs(long databaseHistoryKafkaQueryTimeoutMs)
      The number of milliseconds to wait while fetching cluster information using Kafka admin client. The option is a: <code>long</code> type. Default: 3s Group: sqlserver
      Parameters:
      databaseHistoryKafkaQueryTimeoutMs - the value to set
      Returns:
      the dsl builder

    • 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: <code>int</code> type. Default: 100 Group: sqlserver
      Parameters:
      databaseHistoryKafkaRecoveryAttempts - the value to set
      Returns:
      the dsl builder

    • databaseHistoryKafkaRecoveryPollIntervalMs

      default DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder databaseHistoryKafkaRecoveryPollIntervalMs(int databaseHistoryKafkaRecoveryPollIntervalMs)
      The number of milliseconds to wait while polling for persisted data during recovery. The option is a: <code>int</code> type. Default: 100ms Group: sqlserver
      Parameters:
      databaseHistoryKafkaRecoveryPollIntervalMs - the value to set
      Returns:
      the dsl builder

    • databaseHistoryKafkaTopic

      default DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder databaseHistoryKafkaTopic(String databaseHistoryKafkaTopic)
      The name of the topic for the database schema history. The option is a: <code>java.lang.String</code> type. Group: sqlserver
      Parameters:
      databaseHistoryKafkaTopic - the value to set
      Returns:
      the dsl builder

    • databaseHistorySkipUnparseableDdl

      default DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder databaseHistorySkipUnparseableDdl(boolean databaseHistorySkipUnparseableDdl)
      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. If skipping is enabled then Debezium can miss metadata changes. The option is a: <code>boolean</code> type. Default: false Group: sqlserver
      Parameters:
      databaseHistorySkipUnparseableDdl - the value to set
      Returns:
      the dsl builder

    • databaseHistoryStoreOnlyCapturedTablesDdl

      default DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder databaseHistoryStoreOnlyCapturedTablesDdl(boolean databaseHistoryStoreOnlyCapturedTablesDdl)
      Controls what DDL will Debezium store in database history. By default (false) Debezium will store all incoming DDL statements. If set to true, then only DDL that manipulates a captured table will be stored. The option is a: <code>boolean</code> type. Default: false Group: sqlserver
      Parameters:
      databaseHistoryStoreOnlyCapturedTablesDdl - the value to set
      Returns:
      the dsl builder

    • databaseHistoryStoreOnlyMonitoredTablesDdl

      default DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder databaseHistoryStoreOnlyMonitoredTablesDdl(boolean databaseHistoryStoreOnlyMonitoredTablesDdl)
      Controls what DDL will Debezium store in database history. By default (false) Debezium will store all incoming DDL statements. If set to true, then only DDL that manipulates a monitored table will be stored (deprecated, use database.history.store.only.captured.tables.ddl instead). The option is a: <code>boolean</code> type. Default: false Group: sqlserver
      Parameters:
      databaseHistoryStoreOnlyMonitoredTablesDdl - the value to set
      Returns:
      the dsl builder

    • databaseHostname

      default DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder databaseHostname(String databaseHostname)
      Resolvable hostname or IP address of the database server. The option is a: <code>java.lang.String</code> type. Group: sqlserver
      Parameters:
      databaseHostname - the value to set
      Returns:
      the dsl builder

    • databaseInstance

      default DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder databaseInstance(String databaseInstance)
      The SQL Server instance name. The option is a: <code>java.lang.String</code> type. Group: sqlserver
      Parameters:
      databaseInstance - the value to set
      Returns:
      the dsl builder

    • databaseNames

      default DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder databaseNames(String databaseNames)
      The names of the databases from which the connector should capture changes. The option is a: <code>java.lang.String</code> type. Group: sqlserver
      Parameters:
      databaseNames - the value to set
      Returns:
      the dsl builder

    • databasePassword

      default DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder databasePassword(String databasePassword)
      Password of the database user to be used when connecting to the database. The option is a: <code>java.lang.String</code> type. Group: sqlserver
      Parameters:
      databasePassword - the value to set
      Returns:
      the dsl builder

    • databasePort

      default DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder databasePort(int databasePort)
      Port of the database server. The option is a: <code>int</code> type. Default: 1433 Group: sqlserver
      Parameters:
      databasePort - the value to set
      Returns:
      the dsl builder

    • 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: <code>java.lang.String</code> type. Group: sqlserver
      Parameters:
      databaseServerName - the value to set
      Returns:
      the dsl builder

    • databaseUser

      default DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder databaseUser(String databaseUser)
      Name of the database user to be used when connecting to the database. The option is a: <code>java.lang.String</code> type. Group: sqlserver
      Parameters:
      databaseUser - the value to set
      Returns:
      the dsl builder

    • datatypePropagateSourceType

      default DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder datatypePropagateSourceType(String datatypePropagateSourceType)
      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. The option is a: <code>java.lang.String</code> type. Group: sqlserver
      Parameters:
      datatypePropagateSourceType - the value to set
      Returns:
      the dsl builder

    • 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: <code>java.lang.String</code> type. Default: precise Group: sqlserver
      Parameters:
      decimalHandlingMode - the value to set
      Returns:
      the dsl builder

    • 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: <code>java.lang.String</code> type. Default: fail Group: sqlserver
      Parameters:
      eventProcessingFailureHandlingMode - the value to set
      Returns:
      the dsl builder

    • heartbeatActionQuery

      default DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder heartbeatActionQuery(String heartbeatActionQuery)
      The query executed with every heartbeat. The option is a: <code>java.lang.String</code> type. Group: sqlserver
      Parameters:
      heartbeatActionQuery - the value to set
      Returns:
      the dsl builder

    • 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: <code>int</code> type. Default: 0ms Group: sqlserver
      Parameters:
      heartbeatIntervalMs - the value to set
      Returns:
      the dsl builder

    • heartbeatTopicsPrefix

      default DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder heartbeatTopicsPrefix(String heartbeatTopicsPrefix)
      The prefix that is used to name heartbeat topics.Defaults to __debezium-heartbeat. The option is a: <code>java.lang.String</code> type. Default: __debezium-heartbeat Group: sqlserver
      Parameters:
      heartbeatTopicsPrefix - the value to set
      Returns:
      the dsl builder

    • includeSchemaChanges

      default 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. 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. The option is a: <code>boolean</code> type. Default: true Group: sqlserver
      Parameters:
      includeSchemaChanges - the value to set
      Returns:
      the dsl builder

    • includeSchemaComments

      default DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder includeSchemaComments(boolean includeSchemaComments)
      Whether the connector parse table and column's comment to metadata object.Note: Enable this option will bring the implications on memory usage. The number and size of ColumnImpl objects is what largely impacts how much memory is consumed by the Debezium connectors, and adding a String to each of them can potentially be quite heavy. The default is 'false'. The option is a: <code>boolean</code> type. Default: false Group: sqlserver
      Parameters:
      includeSchemaComments - the value to set
      Returns:
      the dsl builder

    • incrementalSnapshotAllowSchemaChanges

      default DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder incrementalSnapshotAllowSchemaChanges(boolean incrementalSnapshotAllowSchemaChanges)
      Detect schema change during an incremental snapshot and re-select a current chunk to avoid locking DDLs. Note that changes to a primary key are not supported and can cause incorrect results if performed during an incremental snapshot. Another limitation is that if a schema change affects only columns' default values, then the change won't be detected until the DDL is processed from the binlog stream. This doesn't affect the snapshot events' values, but the schema of snapshot events may have outdated defaults. The option is a: <code>boolean</code> type. Default: false Group: sqlserver
      Parameters:
      incrementalSnapshotAllowSchemaChanges - the value to set
      Returns:
      the dsl builder

    • incrementalSnapshotChunkSize

      default DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder incrementalSnapshotChunkSize(int incrementalSnapshotChunkSize)
      The maximum size of chunk for incremental snapshotting. The option is a: <code>int</code> type. Default: 1024 Group: sqlserver
      Parameters:
      incrementalSnapshotChunkSize - the value to set
      Returns:
      the dsl builder

    • incrementalSnapshotOptionRecompile

      default DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder incrementalSnapshotOptionRecompile(boolean incrementalSnapshotOptionRecompile)
      Add OPTION(RECOMPILE) on each SELECT statement during the incremental snapshot process. This prevents parameter sniffing but can cause CPU pressure on the source database. The option is a: <code>boolean</code> type. Default: false Group: sqlserver
      Parameters:
      incrementalSnapshotOptionRecompile - the value to set
      Returns:
      the dsl builder

    • maxBatchSize

      default DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder maxBatchSize(int maxBatchSize)
      Maximum size of each batch of source records. Defaults to 2048. The option is a: <code>int</code> type. Default: 2048 Group: sqlserver
      Parameters:
      maxBatchSize - the value to set
      Returns:
      the dsl builder

    • maxIterationTransactions

      default 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. The option is a: <code>int</code> type. Default: 0 Group: sqlserver
      Parameters:
      maxIterationTransactions - the value to set
      Returns:
      the dsl builder

    • 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: <code>int</code> type. Default: 8192 Group: sqlserver
      Parameters:
      maxQueueSize - the value to set
      Returns:
      the dsl builder

    • maxQueueSizeInBytes

      default 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. Defaults to 0. Mean the feature is not enabled. The option is a: <code>long</code> type. Default: 0 Group: sqlserver
      Parameters:
      maxQueueSizeInBytes - the value to set
      Returns:
      the dsl builder

    • 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: <code>java.lang.String</code> type. Group: sqlserver
      Parameters:
      messageKeyColumns - the value to set
      Returns:
      the dsl builder

    • pollIntervalMs

      default DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder pollIntervalMs(long pollIntervalMs)
      Time to wait for new change events to appear after receiving no events, given in milliseconds. Defaults to 500 ms. The option is a: <code>long</code> type. Default: 500ms Group: sqlserver
      Parameters:
      pollIntervalMs - the value to set
      Returns:
      the dsl builder

    • provideTransactionMetadata

      default DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder provideTransactionMetadata(boolean provideTransactionMetadata)
      Enables transaction metadata extraction together with event counting. The option is a: <code>boolean</code> type. Default: false Group: sqlserver
      Parameters:
      provideTransactionMetadata - the value to set
      Returns:
      the dsl builder

    • queryFetchSize

      default DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder queryFetchSize(int queryFetchSize)
      The maximum number of records that should be loaded into memory while streaming. A value of 0 uses the default JDBC fetch size. The option is a: <code>int</code> type. Default: 0 Group: sqlserver
      Parameters:
      queryFetchSize - the value to set
      Returns:
      the dsl builder

    • retriableRestartConnectorWaitMs

      default DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder retriableRestartConnectorWaitMs(long retriableRestartConnectorWaitMs)
      Time to wait before restarting connector after retriable exception occurs. Defaults to 10000ms. The option is a: <code>long</code> type. Default: 10s Group: sqlserver
      Parameters:
      retriableRestartConnectorWaitMs - the value to set
      Returns:
      the dsl builder

    • sanitizeFieldNames

      default DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder sanitizeFieldNames(boolean sanitizeFieldNames)
      Whether field names will be sanitized to Avro naming conventions. The option is a: <code>boolean</code> type. Default: false Group: sqlserver
      Parameters:
      sanitizeFieldNames - the value to set
      Returns:
      the dsl builder

    • schemaNameAdjustmentMode

      default DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder schemaNameAdjustmentMode(String schemaNameAdjustmentMode)
      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 (default)'none' does not apply any adjustment. The option is a: <code>java.lang.String</code> type. Default: avro Group: sqlserver
      Parameters:
      schemaNameAdjustmentMode - the value to set
      Returns:
      the dsl builder

    • signalDataCollection

      default DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder signalDataCollection(String signalDataCollection)
      The name of the data collection that is used to send signals/commands to Debezium. Signaling is disabled when not set. The option is a: <code>java.lang.String</code> type. Group: sqlserver
      Parameters:
      signalDataCollection - the value to set
      Returns:
      the dsl builder

    • skippedOperations

      default 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. By default, no operations will be skipped. The option is a: <code>java.lang.String</code> type. Group: sqlserver
      Parameters:
      skippedOperations - the value to set
      Returns:
      the dsl builder

    • snapshotDelayMs

      default DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder snapshotDelayMs(long snapshotDelayMs)
      A delay period before a snapshot will begin, given in milliseconds. Defaults to 0 ms. The option is a: <code>long</code> type. Default: 0ms Group: sqlserver
      Parameters:
      snapshotDelayMs - the value to set
      Returns:
      the dsl builder

    • 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: <code>int</code> type. Group: sqlserver
      Parameters:
      snapshotFetchSize - the value to set
      Returns:
      the dsl builder

    • snapshotIncludeCollectionList

      default DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder snapshotIncludeCollectionList(String snapshotIncludeCollectionList)
      this setting must be set to specify a list of tables/collections whose snapshot must be taken on creating or restarting the connector. The option is a: <code>java.lang.String</code> type. Group: sqlserver
      Parameters:
      snapshotIncludeCollectionList - the value to set
      Returns:
      the dsl builder

    • snapshotIsolationMode

      default DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder snapshotIsolationMode(String snapshotIsolationMode)
      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. The option is a: <code>java.lang.String</code> type. Default: repeatable_read Group: sqlserver
      Parameters:
      snapshotIsolationMode - the value to set
      Returns:
      the dsl builder

    • 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: <code>long</code> type. Default: 10s Group: sqlserver
      Parameters:
      snapshotLockTimeoutMs - the value to set
      Returns:
      the dsl builder

    • snapshotMaxThreads

      default DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder snapshotMaxThreads(int snapshotMaxThreads)
      The maximum number of threads used to perform the snapshot. Defaults to 1. The option is a: <code>int</code> type. Default: 1 Group: sqlserver
      Parameters:
      snapshotMaxThreads - the value to set
      Returns:
      the dsl builder

    • 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: <code>java.lang.String</code> type. Default: initial Group: sqlserver
      Parameters:
      snapshotMode - the value to set
      Returns:
      the dsl builder

    • 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: <code>java.lang.String</code> type. Group: sqlserver
      Parameters:
      snapshotSelectStatementOverrides - the value to set
      Returns:
      the dsl builder

    • 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: <code>java.lang.String</code> type. Default: v2 Group: sqlserver
      Parameters:
      sourceStructVersion - the value to set
      Returns:
      the dsl builder

    • sourceTimestampMode

      default DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder sourceTimestampMode(String sourceTimestampMode)
      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', (deprecated) the source timestamp is set to the instant where the record was processed by Debezium. The option is a: <code>java.lang.String</code> type. Default: commit Group: sqlserver
      Parameters:
      sourceTimestampMode - the value to set
      Returns:
      the dsl builder

    • tableBlacklist

      default DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder tableBlacklist(String tableBlacklist)
      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). The option is a: <code>java.lang.String</code> type. Group: sqlserver
      Parameters:
      tableBlacklist - the value to set
      Returns:
      the dsl builder

    • tableExcludeList

      default 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. The option is a: <code>java.lang.String</code> type. Group: sqlserver
      Parameters:
      tableExcludeList - the value to set
      Returns:
      the dsl builder

    • tableIgnoreBuiltin

      default DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder tableIgnoreBuiltin(boolean tableIgnoreBuiltin)
      Flag specifying whether built-in tables should be ignored. The option is a: <code>boolean</code> type. Default: true Group: sqlserver
      Parameters:
      tableIgnoreBuiltin - the value to set
      Returns:
      the dsl builder

    • tableIncludeList

      default DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder tableIncludeList(String tableIncludeList)
      The tables for which changes are to be captured. The option is a: <code>java.lang.String</code> type. Group: sqlserver
      Parameters:
      tableIncludeList - the value to set
      Returns:
      the dsl builder

    • tableWhitelist

      default DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder tableWhitelist(String tableWhitelist)
      The tables for which changes are to be captured (deprecated, use table.include.list instead). The option is a: <code>java.lang.String</code> type. Group: sqlserver
      Parameters:
      tableWhitelist - the value to set
      Returns:
      the dsl builder

    • 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: <code>java.lang.String</code> type. Default: adaptive Group: sqlserver
      Parameters:
      timePrecisionMode - the value to set
      Returns:
      the dsl builder

    • 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: <code>boolean</code> type. Default: false Group: sqlserver
      Parameters:
      tombstonesOnDelete - the value to set
      Returns:
      the dsl builder

    • transactionTopic

      default DebeziumSqlserverComponentBuilderFactory.DebeziumSqlserverComponentBuilder transactionTopic(String transactionTopic)
      The name of the transaction metadata topic. The placeholder ${database.server.name} can be used for referring to the connector's logical name; defaults to ${database.server.name}.transaction. The option is a: <code>java.lang.String</code> type. Default: ${database.server.name}.transaction Group: sqlserver
      Parameters:
      transactionTopic - the value to set
      Returns:
      the dsl builder