Package org.apache.camel.builder.endpoint.dsl

Interface DebeziumSqlserverEndpointBuilderFactory.DebeziumSqlserverEndpointBuilder

All Superinterfaces:
org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver
Enclosing interface:
DebeziumSqlserverEndpointBuilderFactory
public static interface DebeziumSqlserverEndpointBuilderFactory.DebeziumSqlserverEndpointBuilder extends org.apache.camel.builder.EndpointConsumerBuilder
Builder for endpoint for the Debezium SQL Server Connector component.

  • Method Details

    • advanced

      default DebeziumSqlserverEndpointBuilderFactory.AdvancedDebeziumSqlserverEndpointBuilder advanced()

    • additionalProperties

      default DebeziumSqlserverEndpointBuilderFactory.DebeziumSqlserverEndpointBuilder additionalProperties(String key, Object value)
      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<java.lang.String, java.lang.Object> type. The option is multivalued, and you can use the additionalProperties(String, Object) method to add a value (call the method multiple times to set more values). Group: common
      Parameters:
      key - the option key
      value - the option value
      Returns:
      the dsl builder

    • additionalProperties

      default DebeziumSqlserverEndpointBuilderFactory.DebeziumSqlserverEndpointBuilder additionalProperties(Map values)
      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<java.lang.String, java.lang.Object> type. The option is multivalued, and you can use the additionalProperties(String, Object) method to add a value (call the method multiple times to set more values). Group: common
      Parameters:
      values - the values
      Returns:
      the dsl builder

    • internalKeyConverter

      default DebeziumSqlserverEndpointBuilderFactory.DebeziumSqlserverEndpointBuilder 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
      Parameters:
      internalKeyConverter - the value to set
      Returns:
      the dsl builder

    • internalValueConverter

      default DebeziumSqlserverEndpointBuilderFactory.DebeziumSqlserverEndpointBuilder 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
      Parameters:
      internalValueConverter - the value to set
      Returns:
      the dsl builder

    • offsetCommitPolicy

      default DebeziumSqlserverEndpointBuilderFactory.DebeziumSqlserverEndpointBuilder 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. Group: consumer
      Parameters:
      offsetCommitPolicy - the value to set
      Returns:
      the dsl builder

    • offsetCommitTimeoutMs

      default DebeziumSqlserverEndpointBuilderFactory.DebeziumSqlserverEndpointBuilder 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
      Parameters:
      offsetCommitTimeoutMs - the value to set
      Returns:
      the dsl builder

    • offsetCommitTimeoutMs

      default DebeziumSqlserverEndpointBuilderFactory.DebeziumSqlserverEndpointBuilder offsetCommitTimeoutMs(String 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 will be converted to a long type. Default: 5000 Group: consumer
      Parameters:
      offsetCommitTimeoutMs - the value to set
      Returns:
      the dsl builder

    • offsetFlushIntervalMs

      default DebeziumSqlserverEndpointBuilderFactory.DebeziumSqlserverEndpointBuilder 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
      Parameters:
      offsetFlushIntervalMs - the value to set
      Returns:
      the dsl builder

    • offsetFlushIntervalMs

      default DebeziumSqlserverEndpointBuilderFactory.DebeziumSqlserverEndpointBuilder offsetFlushIntervalMs(String offsetFlushIntervalMs)
      Interval at which to try committing offsets. The default is 1 minute. The option will be converted to a long type. Default: 60000 Group: consumer
      Parameters:
      offsetFlushIntervalMs - the value to set
      Returns:
      the dsl builder

    • offsetStorage

      default DebeziumSqlserverEndpointBuilderFactory.DebeziumSqlserverEndpointBuilder 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
      Parameters:
      offsetStorage - the value to set
      Returns:
      the dsl builder

    • offsetStorageFileName

      default DebeziumSqlserverEndpointBuilderFactory.DebeziumSqlserverEndpointBuilder 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
      Parameters:
      offsetStorageFileName - the value to set
      Returns:
      the dsl builder

    • offsetStoragePartitions

      default DebeziumSqlserverEndpointBuilderFactory.DebeziumSqlserverEndpointBuilder 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
      Parameters:
      offsetStoragePartitions - the value to set
      Returns:
      the dsl builder

    • offsetStoragePartitions

      default DebeziumSqlserverEndpointBuilderFactory.DebeziumSqlserverEndpointBuilder offsetStoragePartitions(String offsetStoragePartitions)
      The number of partitions used when creating the offset storage topic. Required when offset.storage is set to the 'KafkaOffsetBackingStore'. The option will be converted to a int type. Group: consumer
      Parameters:
      offsetStoragePartitions - the value to set
      Returns:
      the dsl builder

    • offsetStorageReplicationFactor

      default DebeziumSqlserverEndpointBuilderFactory.DebeziumSqlserverEndpointBuilder 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
      Parameters:
      offsetStorageReplicationFactor - the value to set
      Returns:
      the dsl builder

    • offsetStorageReplicationFactor

      default DebeziumSqlserverEndpointBuilderFactory.DebeziumSqlserverEndpointBuilder offsetStorageReplicationFactor(String offsetStorageReplicationFactor)
      Replication factor used when creating the offset storage topic. Required when offset.storage is set to the KafkaOffsetBackingStore. The option will be converted to a int type. Group: consumer
      Parameters:
      offsetStorageReplicationFactor - the value to set
      Returns:
      the dsl builder

    • offsetStorageTopic

      default DebeziumSqlserverEndpointBuilderFactory.DebeziumSqlserverEndpointBuilder 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
      Parameters:
      offsetStorageTopic - the value to set
      Returns:
      the dsl builder

    • binaryHandlingMode

      default DebeziumSqlserverEndpointBuilderFactory.DebeziumSqlserverEndpointBuilder 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. The option is a: java.lang.String type. Default: bytes Group: sqlserver
      Parameters:
      binaryHandlingMode - the value to set
      Returns:
      the dsl builder

    • columnExcludeList

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

    • columnIncludeList

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

    • columnPropagateSourceType

      default DebeziumSqlserverEndpointBuilderFactory.DebeziumSqlserverEndpointBuilder 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: java.lang.String type. Group: sqlserver
      Parameters:
      columnPropagateSourceType - the value to set
      Returns:
      the dsl builder

    • converters

      default DebeziumSqlserverEndpointBuilderFactory.DebeziumSqlserverEndpointBuilder 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: java.lang.String type. Group: sqlserver
      Parameters:
      converters - the value to set
      Returns:
      the dsl builder

    • customMetricTags

      default DebeziumSqlserverEndpointBuilderFactory.DebeziumSqlserverEndpointBuilder 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. For example: k1=v1,k2=v2. The option is a: java.lang.String type. Group: sqlserver
      Parameters:
      customMetricTags - the value to set
      Returns:
      the dsl builder

    • databaseHostname

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

    • databaseInstance

      default DebeziumSqlserverEndpointBuilderFactory.DebeziumSqlserverEndpointBuilder databaseInstance(String databaseInstance)
      The SQL Server instance name. The option is a: java.lang.String type. Group: sqlserver
      Parameters:
      databaseInstance - the value to set
      Returns:
      the dsl builder

    • databaseNames

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

    • databasePassword

      default DebeziumSqlserverEndpointBuilderFactory.DebeziumSqlserverEndpointBuilder databasePassword(String databasePassword)
      Password of the database user to be used when connecting to the database. The option is a: java.lang.String type. Required: true Group: sqlserver
      Parameters:
      databasePassword - the value to set
      Returns:
      the dsl builder

    • databasePort

      default DebeziumSqlserverEndpointBuilderFactory.DebeziumSqlserverEndpointBuilder databasePort(int databasePort)
      Port of the database server. The option is a: int type. Default: 1433 Group: sqlserver
      Parameters:
      databasePort - the value to set
      Returns:
      the dsl builder

    • databasePort

      default DebeziumSqlserverEndpointBuilderFactory.DebeziumSqlserverEndpointBuilder databasePort(String databasePort)
      Port of the database server. The option will be converted to a int type. Default: 1433 Group: sqlserver
      Parameters:
      databasePort - the value to set
      Returns:
      the dsl builder

    • databaseQueryTimeoutMs

      default DebeziumSqlserverEndpointBuilderFactory.DebeziumSqlserverEndpointBuilder databaseQueryTimeoutMs(int databaseQueryTimeoutMs)
      Time to wait for a query to execute, given in milliseconds. Defaults to 600 seconds (600,000 ms); zero means there is no limit. The option is a: int type. Default: 10m Group: sqlserver
      Parameters:
      databaseQueryTimeoutMs - the value to set
      Returns:
      the dsl builder

    • databaseQueryTimeoutMs

      default DebeziumSqlserverEndpointBuilderFactory.DebeziumSqlserverEndpointBuilder databaseQueryTimeoutMs(String databaseQueryTimeoutMs)
      Time to wait for a query to execute, given in milliseconds. Defaults to 600 seconds (600,000 ms); zero means there is no limit. The option will be converted to a int type. Default: 10m Group: sqlserver
      Parameters:
      databaseQueryTimeoutMs - the value to set
      Returns:
      the dsl builder

    • databaseUser

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

    • dataQueryMode

      default DebeziumSqlserverEndpointBuilderFactory.DebeziumSqlserverEndpointBuilder dataQueryMode(String dataQueryMode)
      Controls how the connector queries CDC data. The default is 'function', which means the data is queried by means of calling cdc.fn_cdc_get_all_changes_# function. The value of 'direct' makes the connector to query the change tables directly. The option is a: java.lang.String type. Default: function Group: sqlserver
      Parameters:
      dataQueryMode - the value to set
      Returns:
      the dsl builder

    • datatypePropagateSourceType

      default DebeziumSqlserverEndpointBuilderFactory.DebeziumSqlserverEndpointBuilder 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: java.lang.String type. Group: sqlserver
      Parameters:
      datatypePropagateSourceType - the value to set
      Returns:
      the dsl builder

    • decimalHandlingMode

      default DebeziumSqlserverEndpointBuilderFactory.DebeziumSqlserverEndpointBuilder 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
      Parameters:
      decimalHandlingMode - the value to set
      Returns:
      the dsl builder

    • errorsMaxRetries

      default DebeziumSqlserverEndpointBuilderFactory.DebeziumSqlserverEndpointBuilder errorsMaxRetries(int errorsMaxRetries)
      The maximum number of retries on connection errors before failing (-1 = no limit, 0 = disabled, 0 = num of retries). The option is a: int type. Default: -1 Group: sqlserver
      Parameters:
      errorsMaxRetries - the value to set
      Returns:
      the dsl builder

    • errorsMaxRetries

      default DebeziumSqlserverEndpointBuilderFactory.DebeziumSqlserverEndpointBuilder errorsMaxRetries(String errorsMaxRetries)
      The maximum number of retries on connection errors before failing (-1 = no limit, 0 = disabled, 0 = num of retries). The option will be converted to a int type. Default: -1 Group: sqlserver
      Parameters:
      errorsMaxRetries - the value to set
      Returns:
      the dsl builder

    • eventProcessingFailureHandlingMode

      default DebeziumSqlserverEndpointBuilderFactory.DebeziumSqlserverEndpointBuilder 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
      Parameters:
      eventProcessingFailureHandlingMode - the value to set
      Returns:
      the dsl builder

    • heartbeatActionQuery

      default DebeziumSqlserverEndpointBuilderFactory.DebeziumSqlserverEndpointBuilder heartbeatActionQuery(String heartbeatActionQuery)
      The query executed with every heartbeat. The option is a: java.lang.String type. Group: sqlserver
      Parameters:
      heartbeatActionQuery - the value to set
      Returns:
      the dsl builder

    • heartbeatIntervalMs

      default DebeziumSqlserverEndpointBuilderFactory.DebeziumSqlserverEndpointBuilder 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: 0ms Group: sqlserver
      Parameters:
      heartbeatIntervalMs - the value to set
      Returns:
      the dsl builder

    • heartbeatIntervalMs

      default DebeziumSqlserverEndpointBuilderFactory.DebeziumSqlserverEndpointBuilder heartbeatIntervalMs(String 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 will be converted to a int type. Default: 0ms Group: sqlserver
      Parameters:
      heartbeatIntervalMs - the value to set
      Returns:
      the dsl builder

    • heartbeatTopicsPrefix

      default DebeziumSqlserverEndpointBuilderFactory.DebeziumSqlserverEndpointBuilder 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
      Parameters:
      heartbeatTopicsPrefix - the value to set
      Returns:
      the dsl builder

    • includeSchemaChanges

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

    • includeSchemaChanges

      default DebeziumSqlserverEndpointBuilderFactory.DebeziumSqlserverEndpointBuilder includeSchemaChanges(String 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 schema history. The option will be converted to a boolean type. Default: true Group: sqlserver
      Parameters:
      includeSchemaChanges - the value to set
      Returns:
      the dsl builder

    • includeSchemaComments

      default DebeziumSqlserverEndpointBuilderFactory.DebeziumSqlserverEndpointBuilder 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: boolean type. Default: false Group: sqlserver
      Parameters:
      includeSchemaComments - the value to set
      Returns:
      the dsl builder

    • includeSchemaComments

      default DebeziumSqlserverEndpointBuilderFactory.DebeziumSqlserverEndpointBuilder includeSchemaComments(String 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 will be converted to a boolean type. Default: false Group: sqlserver
      Parameters:
      includeSchemaComments - the value to set
      Returns:
      the dsl builder

    • incrementalSnapshotAllowSchemaChanges

      default DebeziumSqlserverEndpointBuilderFactory.DebeziumSqlserverEndpointBuilder 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: boolean type. Default: false Group: sqlserver
      Parameters:
      incrementalSnapshotAllowSchemaChanges - the value to set
      Returns:
      the dsl builder

    • incrementalSnapshotAllowSchemaChanges

      default DebeziumSqlserverEndpointBuilderFactory.DebeziumSqlserverEndpointBuilder incrementalSnapshotAllowSchemaChanges(String 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 will be converted to a boolean type. Default: false Group: sqlserver
      Parameters:
      incrementalSnapshotAllowSchemaChanges - the value to set
      Returns:
      the dsl builder

    • incrementalSnapshotChunkSize

      default DebeziumSqlserverEndpointBuilderFactory.DebeziumSqlserverEndpointBuilder incrementalSnapshotChunkSize(int incrementalSnapshotChunkSize)
      The maximum size of chunk (number of documents/rows) for incremental snapshotting. The option is a: int type. Default: 1024 Group: sqlserver
      Parameters:
      incrementalSnapshotChunkSize - the value to set
      Returns:
      the dsl builder

    • incrementalSnapshotChunkSize

      default DebeziumSqlserverEndpointBuilderFactory.DebeziumSqlserverEndpointBuilder incrementalSnapshotChunkSize(String incrementalSnapshotChunkSize)
      The maximum size of chunk (number of documents/rows) for incremental snapshotting. The option will be converted to a int type. Default: 1024 Group: sqlserver
      Parameters:
      incrementalSnapshotChunkSize - the value to set
      Returns:
      the dsl builder

    • incrementalSnapshotOptionRecompile

      default DebeziumSqlserverEndpointBuilderFactory.DebeziumSqlserverEndpointBuilder 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: boolean type. Default: false Group: sqlserver
      Parameters:
      incrementalSnapshotOptionRecompile - the value to set
      Returns:
      the dsl builder

    • incrementalSnapshotOptionRecompile

      default DebeziumSqlserverEndpointBuilderFactory.DebeziumSqlserverEndpointBuilder incrementalSnapshotOptionRecompile(String 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 will be converted to a boolean type. Default: false Group: sqlserver
      Parameters:
      incrementalSnapshotOptionRecompile - the value to set
      Returns:
      the dsl builder

    • incrementalSnapshotWatermarkingStrategy

      default DebeziumSqlserverEndpointBuilderFactory.DebeziumSqlserverEndpointBuilder incrementalSnapshotWatermarkingStrategy(String incrementalSnapshotWatermarkingStrategy)
      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 option is a: java.lang.String type. Default: INSERT_INSERT Group: sqlserver
      Parameters:
      incrementalSnapshotWatermarkingStrategy - the value to set
      Returns:
      the dsl builder

    • maxBatchSize

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

    • maxBatchSize

      default DebeziumSqlserverEndpointBuilderFactory.DebeziumSqlserverEndpointBuilder maxBatchSize(String maxBatchSize)
      Maximum size of each batch of source records. Defaults to 2048. The option will be converted to a int type. Default: 2048 Group: sqlserver
      Parameters:
      maxBatchSize - the value to set
      Returns:
      the dsl builder

    • maxIterationTransactions

      default DebeziumSqlserverEndpointBuilderFactory.DebeziumSqlserverEndpointBuilder 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: int type. Default: 500 Group: sqlserver
      Parameters:
      maxIterationTransactions - the value to set
      Returns:
      the dsl builder

    • maxIterationTransactions

      default DebeziumSqlserverEndpointBuilderFactory.DebeziumSqlserverEndpointBuilder maxIterationTransactions(String maxIterationTransactions)
      This property can be used to reduce the connector memory usage footprint when changes are streamed from multiple tables per database. The option will be converted to a int type. Default: 500 Group: sqlserver
      Parameters:
      maxIterationTransactions - the value to set
      Returns:
      the dsl builder

    • maxQueueSize

      default DebeziumSqlserverEndpointBuilderFactory.DebeziumSqlserverEndpointBuilder 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
      Parameters:
      maxQueueSize - the value to set
      Returns:
      the dsl builder

    • maxQueueSize

      default DebeziumSqlserverEndpointBuilderFactory.DebeziumSqlserverEndpointBuilder maxQueueSize(String 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 will be converted to a int type. Default: 8192 Group: sqlserver
      Parameters:
      maxQueueSize - the value to set
      Returns:
      the dsl builder

    • maxQueueSizeInBytes

      default DebeziumSqlserverEndpointBuilderFactory.DebeziumSqlserverEndpointBuilder 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: long type. Default: 0 Group: sqlserver
      Parameters:
      maxQueueSizeInBytes - the value to set
      Returns:
      the dsl builder

    • maxQueueSizeInBytes

      default DebeziumSqlserverEndpointBuilderFactory.DebeziumSqlserverEndpointBuilder maxQueueSizeInBytes(String 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 will be converted to a long type. Default: 0 Group: sqlserver
      Parameters:
      maxQueueSizeInBytes - the value to set
      Returns:
      the dsl builder

    • messageKeyColumns

      default DebeziumSqlserverEndpointBuilderFactory.DebeziumSqlserverEndpointBuilder 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
      Parameters:
      messageKeyColumns - the value to set
      Returns:
      the dsl builder

    • notificationEnabledChannels

      default DebeziumSqlserverEndpointBuilderFactory.DebeziumSqlserverEndpointBuilder notificationEnabledChannels(String notificationEnabledChannels)
      List of notification channels names that are enabled. The option is a: java.lang.String type. Group: sqlserver
      Parameters:
      notificationEnabledChannels - the value to set
      Returns:
      the dsl builder

    • notificationSinkTopicName

      default DebeziumSqlserverEndpointBuilderFactory.DebeziumSqlserverEndpointBuilder notificationSinkTopicName(String notificationSinkTopicName)
      The name of the topic for the notifications. This is required in case 'sink' is in the list of enabled channels. The option is a: java.lang.String type. Group: sqlserver
      Parameters:
      notificationSinkTopicName - the value to set
      Returns:
      the dsl builder

    • pollIntervalMs

      default DebeziumSqlserverEndpointBuilderFactory.DebeziumSqlserverEndpointBuilder 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: long type. Default: 500ms Group: sqlserver
      Parameters:
      pollIntervalMs - the value to set
      Returns:
      the dsl builder

    • pollIntervalMs

      default DebeziumSqlserverEndpointBuilderFactory.DebeziumSqlserverEndpointBuilder pollIntervalMs(String pollIntervalMs)
      Time to wait for new change events to appear after receiving no events, given in milliseconds. Defaults to 500 ms. The option will be converted to a long type. Default: 500ms Group: sqlserver
      Parameters:
      pollIntervalMs - the value to set
      Returns:
      the dsl builder

    • postProcessors

      default DebeziumSqlserverEndpointBuilderFactory.DebeziumSqlserverEndpointBuilder postProcessors(String postProcessors)
      Optional list of post processors. The processors are defined using '.type' config option and configured using options ''. The option is a: java.lang.String type. Group: sqlserver
      Parameters:
      postProcessors - the value to set
      Returns:
      the dsl builder

    • provideTransactionMetadata

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

    • provideTransactionMetadata

      default DebeziumSqlserverEndpointBuilderFactory.DebeziumSqlserverEndpointBuilder provideTransactionMetadata(String provideTransactionMetadata)
      Enables transaction metadata extraction together with event counting. The option will be converted to a boolean type. Default: false Group: sqlserver
      Parameters:
      provideTransactionMetadata - the value to set
      Returns:
      the dsl builder

    • retriableRestartConnectorWaitMs

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

    • retriableRestartConnectorWaitMs

      default DebeziumSqlserverEndpointBuilderFactory.DebeziumSqlserverEndpointBuilder retriableRestartConnectorWaitMs(String retriableRestartConnectorWaitMs)
      Time to wait before restarting connector after retriable exception occurs. Defaults to 10000ms. The option will be converted to a long type. Default: 10s Group: sqlserver
      Parameters:
      retriableRestartConnectorWaitMs - the value to set
      Returns:
      the dsl builder

    • schemaHistoryInternal

      default DebeziumSqlserverEndpointBuilderFactory.DebeziumSqlserverEndpointBuilder schemaHistoryInternal(String schemaHistoryInternal)
      The name of the SchemaHistory class that should be used to store and recover database schema changes. The configuration properties for the history are prefixed with the 'schema.history.internal.' string. The option is a: java.lang.String type. Default: io.debezium.storage.kafka.history.KafkaSchemaHistory Group: sqlserver
      Parameters:
      schemaHistoryInternal - the value to set
      Returns:
      the dsl builder

    • schemaHistoryInternalFileFilename

      default DebeziumSqlserverEndpointBuilderFactory.DebeziumSqlserverEndpointBuilder schemaHistoryInternalFileFilename(String schemaHistoryInternalFileFilename)
      The path to the file that will be used to record the database schema history. The option is a: java.lang.String type. Group: sqlserver
      Parameters:
      schemaHistoryInternalFileFilename - the value to set
      Returns:
      the dsl builder

    • schemaHistoryInternalSkipUnparseableDdl

      default DebeziumSqlserverEndpointBuilderFactory.DebeziumSqlserverEndpointBuilder schemaHistoryInternalSkipUnparseableDdl(boolean schemaHistoryInternalSkipUnparseableDdl)
      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: boolean type. Default: false Group: sqlserver
      Parameters:
      schemaHistoryInternalSkipUnparseableDdl - the value to set
      Returns:
      the dsl builder

    • schemaHistoryInternalSkipUnparseableDdl

      default DebeziumSqlserverEndpointBuilderFactory.DebeziumSqlserverEndpointBuilder schemaHistoryInternalSkipUnparseableDdl(String schemaHistoryInternalSkipUnparseableDdl)
      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 will be converted to a boolean type. Default: false Group: sqlserver
      Parameters:
      schemaHistoryInternalSkipUnparseableDdl - the value to set
      Returns:
      the dsl builder

    • schemaHistoryInternalStoreOnlyCapturedDatabasesDdl

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

    • schemaHistoryInternalStoreOnlyCapturedDatabasesDdl

      default DebeziumSqlserverEndpointBuilderFactory.DebeziumSqlserverEndpointBuilder schemaHistoryInternalStoreOnlyCapturedDatabasesDdl(String schemaHistoryInternalStoreOnlyCapturedDatabasesDdl)
      Controls what DDL will Debezium store in database schema history. By default (true) only DDL that manipulates a table from captured schema/database will be stored. If set to false, then Debezium will store all incoming DDL statements. The option will be converted to a boolean type. Default: false Group: sqlserver
      Parameters:
      schemaHistoryInternalStoreOnlyCapturedDatabasesDdl - the value to set
      Returns:
      the dsl builder

    • schemaHistoryInternalStoreOnlyCapturedTablesDdl

      default DebeziumSqlserverEndpointBuilderFactory.DebeziumSqlserverEndpointBuilder schemaHistoryInternalStoreOnlyCapturedTablesDdl(boolean schemaHistoryInternalStoreOnlyCapturedTablesDdl)
      Controls what DDL will Debezium store in database schema 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: boolean type. Default: false Group: sqlserver
      Parameters:
      schemaHistoryInternalStoreOnlyCapturedTablesDdl - the value to set
      Returns:
      the dsl builder

    • schemaHistoryInternalStoreOnlyCapturedTablesDdl

      default DebeziumSqlserverEndpointBuilderFactory.DebeziumSqlserverEndpointBuilder schemaHistoryInternalStoreOnlyCapturedTablesDdl(String schemaHistoryInternalStoreOnlyCapturedTablesDdl)
      Controls what DDL will Debezium store in database schema 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 will be converted to a boolean type. Default: false Group: sqlserver
      Parameters:
      schemaHistoryInternalStoreOnlyCapturedTablesDdl - the value to set
      Returns:
      the dsl builder

    • schemaNameAdjustmentMode

      default DebeziumSqlserverEndpointBuilderFactory.DebeziumSqlserverEndpointBuilder 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; 'avro_unicode' replaces the underscore or characters that cannot be used in the Avro type name with corresponding unicode like _uxxxx. Note: _ is an escape sequence like backslash in Java;'none' does not apply any adjustment (default). The option is a: java.lang.String type. Default: none Group: sqlserver
      Parameters:
      schemaNameAdjustmentMode - the value to set
      Returns:
      the dsl builder

    • signalDataCollection

      default DebeziumSqlserverEndpointBuilderFactory.DebeziumSqlserverEndpointBuilder 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: java.lang.String type. Group: sqlserver
      Parameters:
      signalDataCollection - the value to set
      Returns:
      the dsl builder

    • signalEnabledChannels

      default DebeziumSqlserverEndpointBuilderFactory.DebeziumSqlserverEndpointBuilder signalEnabledChannels(String signalEnabledChannels)
      List of channels names that are enabled. Source channel is enabled by default. The option is a: java.lang.String type. Default: source Group: sqlserver
      Parameters:
      signalEnabledChannels - the value to set
      Returns:
      the dsl builder

    • signalPollIntervalMs

      default DebeziumSqlserverEndpointBuilderFactory.DebeziumSqlserverEndpointBuilder signalPollIntervalMs(long signalPollIntervalMs)
      Interval for looking for new signals in registered channels, given in milliseconds. Defaults to 5 seconds. The option is a: long type. Default: 5s Group: sqlserver
      Parameters:
      signalPollIntervalMs - the value to set
      Returns:
      the dsl builder

    • signalPollIntervalMs

      default DebeziumSqlserverEndpointBuilderFactory.DebeziumSqlserverEndpointBuilder signalPollIntervalMs(String signalPollIntervalMs)
      Interval for looking for new signals in registered channels, given in milliseconds. Defaults to 5 seconds. The option will be converted to a long type. Default: 5s Group: sqlserver
      Parameters:
      signalPollIntervalMs - the value to set
      Returns:
      the dsl builder

    • skippedOperations

      default DebeziumSqlserverEndpointBuilderFactory.DebeziumSqlserverEndpointBuilder 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, only truncate operations will be skipped. The option is a: java.lang.String type. Default: t Group: sqlserver
      Parameters:
      skippedOperations - the value to set
      Returns:
      the dsl builder

    • snapshotDelayMs

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

    • snapshotDelayMs

      default DebeziumSqlserverEndpointBuilderFactory.DebeziumSqlserverEndpointBuilder snapshotDelayMs(String snapshotDelayMs)
      A delay period before a snapshot will begin, given in milliseconds. Defaults to 0 ms. The option will be converted to a long type. Default: 0ms Group: sqlserver
      Parameters:
      snapshotDelayMs - the value to set
      Returns:
      the dsl builder

    • snapshotFetchSize

      default DebeziumSqlserverEndpointBuilderFactory.DebeziumSqlserverEndpointBuilder 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
      Parameters:
      snapshotFetchSize - the value to set
      Returns:
      the dsl builder

    • snapshotFetchSize

      default DebeziumSqlserverEndpointBuilderFactory.DebeziumSqlserverEndpointBuilder snapshotFetchSize(String snapshotFetchSize)
      The maximum number of records that should be loaded into memory while performing a snapshot. The option will be converted to a int type. Group: sqlserver
      Parameters:
      snapshotFetchSize - the value to set
      Returns:
      the dsl builder

    • snapshotIncludeCollectionList

      default DebeziumSqlserverEndpointBuilderFactory.DebeziumSqlserverEndpointBuilder 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: java.lang.String type. Group: sqlserver
      Parameters:
      snapshotIncludeCollectionList - the value to set
      Returns:
      the dsl builder

    • snapshotIsolationMode

      default DebeziumSqlserverEndpointBuilderFactory.DebeziumSqlserverEndpointBuilder snapshotIsolationMode(String snapshotIsolationMode)
      Controls which transaction isolation level is used and how long the connector locks the captured tables. The default is 'repeatable_read', which means that repeatable read isolation level is used. In addition, type of acquired lock during schema snapshot depends on snapshot.locking.mode property. Using a value of 'exclusive' ensures that the connector holds the type of lock specified with snapshot.locking.mode property (and thus prevents any reads and updates) for all captured 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: java.lang.String type. Default: repeatable_read Group: sqlserver
      Parameters:
      snapshotIsolationMode - the value to set
      Returns:
      the dsl builder

    • snapshotLockTimeoutMs

      default DebeziumSqlserverEndpointBuilderFactory.DebeziumSqlserverEndpointBuilder 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: 10s Group: sqlserver
      Parameters:
      snapshotLockTimeoutMs - the value to set
      Returns:
      the dsl builder

    • snapshotLockTimeoutMs

      default DebeziumSqlserverEndpointBuilderFactory.DebeziumSqlserverEndpointBuilder snapshotLockTimeoutMs(String 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 will be converted to a long type. Default: 10s Group: sqlserver
      Parameters:
      snapshotLockTimeoutMs - the value to set
      Returns:
      the dsl builder

    • snapshotMaxThreads

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

    • snapshotMaxThreads

      default DebeziumSqlserverEndpointBuilderFactory.DebeziumSqlserverEndpointBuilder snapshotMaxThreads(String snapshotMaxThreads)
      The maximum number of threads used to perform the snapshot. Defaults to 1. The option will be converted to a int type. Default: 1 Group: sqlserver
      Parameters:
      snapshotMaxThreads - the value to set
      Returns:
      the dsl builder

    • snapshotMode

      default DebeziumSqlserverEndpointBuilderFactory.DebeziumSqlserverEndpointBuilder snapshotMode(String snapshotMode)
      The criteria for running a snapshot upon startup of the connector. Select one of the following snapshot options: 'initial' (default): If the connector does not detect any offsets for the logical server name, it runs a snapshot that captures the current full state of the configured tables. After the snapshot completes, the connector begins to stream changes from the transaction log.; 'initial_only': The connector performs a snapshot as it does for the 'initial' option, but after the connector completes the snapshot, it stops, and does not stream changes from the transaction log.; 'schema_only': If the connector does not detect any offsets for the logical server name, it runs a snapshot that captures only the schema (table structures), but not any table data. After the snapshot completes, the connector begins to stream changes from the transaction log. The option is a: java.lang.String type. Default: initial Group: sqlserver
      Parameters:
      snapshotMode - the value to set
      Returns:
      the dsl builder

    • snapshotModeConfigurationBasedSnapshotData

      default DebeziumSqlserverEndpointBuilderFactory.DebeziumSqlserverEndpointBuilder snapshotModeConfigurationBasedSnapshotData(boolean snapshotModeConfigurationBasedSnapshotData)
      When 'snapshot.mode' is set as configuration_based, this setting permits to specify whenever the data should be snapshotted or not. The option is a: boolean type. Default: false Group: sqlserver
      Parameters:
      snapshotModeConfigurationBasedSnapshotData - the value to set
      Returns:
      the dsl builder

    • snapshotModeConfigurationBasedSnapshotData

      default DebeziumSqlserverEndpointBuilderFactory.DebeziumSqlserverEndpointBuilder snapshotModeConfigurationBasedSnapshotData(String snapshotModeConfigurationBasedSnapshotData)
      When 'snapshot.mode' is set as configuration_based, this setting permits to specify whenever the data should be snapshotted or not. The option will be converted to a boolean type. Default: false Group: sqlserver
      Parameters:
      snapshotModeConfigurationBasedSnapshotData - the value to set
      Returns:
      the dsl builder

    • snapshotModeConfigurationBasedSnapshotOnDataError

      default DebeziumSqlserverEndpointBuilderFactory.DebeziumSqlserverEndpointBuilder snapshotModeConfigurationBasedSnapshotOnDataError(boolean snapshotModeConfigurationBasedSnapshotOnDataError)
      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. The option is a: boolean type. Default: false Group: sqlserver
      Parameters:
      snapshotModeConfigurationBasedSnapshotOnDataError - the value to set
      Returns:
      the dsl builder

    • snapshotModeConfigurationBasedSnapshotOnDataError

      default DebeziumSqlserverEndpointBuilderFactory.DebeziumSqlserverEndpointBuilder snapshotModeConfigurationBasedSnapshotOnDataError(String snapshotModeConfigurationBasedSnapshotOnDataError)
      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. The option will be converted to a boolean type. Default: false Group: sqlserver
      Parameters:
      snapshotModeConfigurationBasedSnapshotOnDataError - the value to set
      Returns:
      the dsl builder

    • snapshotModeConfigurationBasedSnapshotOnSchemaError

      default DebeziumSqlserverEndpointBuilderFactory.DebeziumSqlserverEndpointBuilder snapshotModeConfigurationBasedSnapshotOnSchemaError(boolean snapshotModeConfigurationBasedSnapshotOnSchemaError)
      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. The option is a: boolean type. Default: false Group: sqlserver
      Parameters:
      snapshotModeConfigurationBasedSnapshotOnSchemaError - the value to set
      Returns:
      the dsl builder

    • snapshotModeConfigurationBasedSnapshotOnSchemaError

      default DebeziumSqlserverEndpointBuilderFactory.DebeziumSqlserverEndpointBuilder snapshotModeConfigurationBasedSnapshotOnSchemaError(String snapshotModeConfigurationBasedSnapshotOnSchemaError)
      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. The option will be converted to a boolean type. Default: false Group: sqlserver
      Parameters:
      snapshotModeConfigurationBasedSnapshotOnSchemaError - the value to set
      Returns:
      the dsl builder

    • snapshotModeConfigurationBasedSnapshotSchema

      default DebeziumSqlserverEndpointBuilderFactory.DebeziumSqlserverEndpointBuilder snapshotModeConfigurationBasedSnapshotSchema(boolean snapshotModeConfigurationBasedSnapshotSchema)
      When 'snapshot.mode' is set as configuration_based, this setting permits to specify whenever the schema should be snapshotted or not. The option is a: boolean type. Default: false Group: sqlserver
      Parameters:
      snapshotModeConfigurationBasedSnapshotSchema - the value to set
      Returns:
      the dsl builder

    • snapshotModeConfigurationBasedSnapshotSchema

      default DebeziumSqlserverEndpointBuilderFactory.DebeziumSqlserverEndpointBuilder snapshotModeConfigurationBasedSnapshotSchema(String snapshotModeConfigurationBasedSnapshotSchema)
      When 'snapshot.mode' is set as configuration_based, this setting permits to specify whenever the schema should be snapshotted or not. The option will be converted to a boolean type. Default: false Group: sqlserver
      Parameters:
      snapshotModeConfigurationBasedSnapshotSchema - the value to set
      Returns:
      the dsl builder

    • snapshotModeConfigurationBasedStartStream

      default DebeziumSqlserverEndpointBuilderFactory.DebeziumSqlserverEndpointBuilder snapshotModeConfigurationBasedStartStream(boolean snapshotModeConfigurationBasedStartStream)
      When 'snapshot.mode' is set as configuration_based, this setting permits to specify whenever the stream should start or not after snapshot. The option is a: boolean type. Default: false Group: sqlserver
      Parameters:
      snapshotModeConfigurationBasedStartStream - the value to set
      Returns:
      the dsl builder

    • snapshotModeConfigurationBasedStartStream

      default DebeziumSqlserverEndpointBuilderFactory.DebeziumSqlserverEndpointBuilder snapshotModeConfigurationBasedStartStream(String snapshotModeConfigurationBasedStartStream)
      When 'snapshot.mode' is set as configuration_based, this setting permits to specify whenever the stream should start or not after snapshot. The option will be converted to a boolean type. Default: false Group: sqlserver
      Parameters:
      snapshotModeConfigurationBasedStartStream - the value to set
      Returns:
      the dsl builder

    • snapshotModeCustomName

      default DebeziumSqlserverEndpointBuilderFactory.DebeziumSqlserverEndpointBuilder snapshotModeCustomName(String snapshotModeCustomName)
      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. The implementations must implement the 'Snapshotter' interface and is called on each app boot to determine whether to do a snapshot. The option is a: java.lang.String type. Group: sqlserver
      Parameters:
      snapshotModeCustomName - the value to set
      Returns:
      the dsl builder

    • snapshotSelectStatementOverrides

      default DebeziumSqlserverEndpointBuilderFactory.DebeziumSqlserverEndpointBuilder 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 the specific 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
      Parameters:
      snapshotSelectStatementOverrides - the value to set
      Returns:
      the dsl builder

    • snapshotTablesOrderByRowCount

      default DebeziumSqlserverEndpointBuilderFactory.DebeziumSqlserverEndpointBuilder snapshotTablesOrderByRowCount(String snapshotTablesOrderByRowCount)
      Controls the order in which tables are processed in the initial snapshot. A descending value will order the tables by row count descending. A ascending value will order the tables by row count ascending. A value of disabled (the default) will disable ordering by row count. The option is a: java.lang.String type. Default: disabled Group: sqlserver
      Parameters:
      snapshotTablesOrderByRowCount - the value to set
      Returns:
      the dsl builder

    • sourceinfoStructMaker

      default DebeziumSqlserverEndpointBuilderFactory.DebeziumSqlserverEndpointBuilder sourceinfoStructMaker(String sourceinfoStructMaker)
      The name of the SourceInfoStructMaker class that returns SourceInfo schema and struct. The option is a: java.lang.String type. Default: io.debezium.connector.sqlserver.SqlServerSourceInfoStructMaker Group: sqlserver
      Parameters:
      sourceinfoStructMaker - the value to set
      Returns:
      the dsl builder

    • streamingDelayMs

      default DebeziumSqlserverEndpointBuilderFactory.DebeziumSqlserverEndpointBuilder streamingDelayMs(long streamingDelayMs)
      A delay period after the snapshot is completed and the streaming begins, given in milliseconds. Defaults to 0 ms. The option is a: long type. Default: 0ms Group: sqlserver
      Parameters:
      streamingDelayMs - the value to set
      Returns:
      the dsl builder

    • streamingDelayMs

      default DebeziumSqlserverEndpointBuilderFactory.DebeziumSqlserverEndpointBuilder streamingDelayMs(String streamingDelayMs)
      A delay period after the snapshot is completed and the streaming begins, given in milliseconds. Defaults to 0 ms. The option will be converted to a long type. Default: 0ms Group: sqlserver
      Parameters:
      streamingDelayMs - the value to set
      Returns:
      the dsl builder

    • tableExcludeList

      default DebeziumSqlserverEndpointBuilderFactory.DebeziumSqlserverEndpointBuilder 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: java.lang.String type. Group: sqlserver
      Parameters:
      tableExcludeList - the value to set
      Returns:
      the dsl builder

    • tableIgnoreBuiltin

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

    • tableIgnoreBuiltin

      default DebeziumSqlserverEndpointBuilderFactory.DebeziumSqlserverEndpointBuilder tableIgnoreBuiltin(String tableIgnoreBuiltin)
      Flag specifying whether built-in tables should be ignored. The option will be converted to a boolean type. Default: true Group: sqlserver
      Parameters:
      tableIgnoreBuiltin - the value to set
      Returns:
      the dsl builder

    • tableIncludeList

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

    • timePrecisionMode

      default DebeziumSqlserverEndpointBuilderFactory.DebeziumSqlserverEndpointBuilder 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
      Parameters:
      timePrecisionMode - the value to set
      Returns:
      the dsl builder

    • tombstonesOnDelete

      default DebeziumSqlserverEndpointBuilderFactory.DebeziumSqlserverEndpointBuilder 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). 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
      Parameters:
      tombstonesOnDelete - the value to set
      Returns:
      the dsl builder

    • tombstonesOnDelete

      default DebeziumSqlserverEndpointBuilderFactory.DebeziumSqlserverEndpointBuilder tombstonesOnDelete(String tombstonesOnDelete)
      Whether delete operations should be represented by a delete event and a subsequent tombstone 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 will be converted to a boolean type. Default: false Group: sqlserver
      Parameters:
      tombstonesOnDelete - the value to set
      Returns:
      the dsl builder

    • topicNamingStrategy

      default DebeziumSqlserverEndpointBuilderFactory.DebeziumSqlserverEndpointBuilder topicNamingStrategy(String topicNamingStrategy)
      The name of the TopicNamingStrategy class that should be used to determine the topic name for data change, schema change, transaction, heartbeat event etc. The option is a: java.lang.String type. Default: io.debezium.schema.SchemaTopicNamingStrategy Group: sqlserver
      Parameters:
      topicNamingStrategy - the value to set
      Returns:
      the dsl builder

    • topicPrefix

      default DebeziumSqlserverEndpointBuilderFactory.DebeziumSqlserverEndpointBuilder topicPrefix(String topicPrefix)
      Topic prefix that identifies and provides a namespace for the particular database server/cluster is capturing changes. The topic prefix should be unique across all other connectors, since it is used as a prefix for all Kafka topic names that receive events emitted by this connector. Only alphanumeric characters, hyphens, dots and underscores must be accepted. The option is a: java.lang.String type. Required: true Group: sqlserver
      Parameters:
      topicPrefix - the value to set
      Returns:
      the dsl builder

    • transactionMetadataFactory

      default DebeziumSqlserverEndpointBuilderFactory.DebeziumSqlserverEndpointBuilder transactionMetadataFactory(String transactionMetadataFactory)
      Class to make transaction context & transaction struct/schemas. The option is a: java.lang.String type. Default: io.debezium.pipeline.txmetadata.DefaultTransactionMetadataFactory Group: sqlserver
      Parameters:
      transactionMetadataFactory - the value to set
      Returns:
      the dsl builder