SqlServerConnectorEmbeddedDebeziumConfiguration (Camel :: Debezium

java.lang.Object
- org.apache.camel.component.debezium.configuration.EmbeddedDebeziumConfiguration
- - org.apache.camel.component.debezium.configuration.SqlServerConnectorEmbeddedDebeziumConfiguration

@UriParams
public class SqlServerConnectorEmbeddedDebeziumConfiguration
extends org.apache.camel.component.debezium.configuration.EmbeddedDebeziumConfiguration

Constructor Summary

Constructors
Constructor and Description

SqlServerConnectorEmbeddedDebeziumConfiguration()

Constructors
Constructor and Description
`SqlServerConnectorEmbeddedDebeziumConfiguration()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected Class`	`configureConnectorClass()`
`protected io.debezium.config.Configuration`	`createConnectorConfiguration()`
`String`	`getColumnBlacklist()`
`String`	`getConnectorDatabaseType()`
`String`	`getDatabaseDbname()`
`String`	`getDatabaseHistory()`
`String`	`getDatabaseHistoryFileFilename()`
`String`	`getDatabaseHistoryKafkaBootstrapServers()`
`int`	`getDatabaseHistoryKafkaRecoveryAttempts()`
`int`	`getDatabaseHistoryKafkaRecoveryPollIntervalMs()`
`String`	`getDatabaseHistoryKafkaTopic()`
`String`	`getDatabaseHostname()`
`String`	`getDatabasePassword()`
`int`	`getDatabasePort()`
`String`	`getDatabaseServerName()`
`String`	`getDatabaseServerTimezone()`
`String`	`getDatabaseUser()`
`String`	`getDecimalHandlingMode()`
`String`	`getEventProcessingFailureHandlingMode()`
`int`	`getHeartbeatIntervalMs()`
`String`	`getHeartbeatTopicsPrefix()`
`int`	`getMaxBatchSize()`
`int`	`getMaxQueueSize()`
`String`	`getMessageKeyColumns()`
`long`	`getPollIntervalMs()`
`long`	`getSnapshotDelayMs()`
`int`	`getSnapshotFetchSize()`
`long`	`getSnapshotLockTimeoutMs()`
`String`	`getSnapshotMode()`
`String`	`getSnapshotSelectStatementOverrides()`
`String`	`getSourceStructVersion()`
`String`	`getTableBlacklist()`
`String`	`getTableWhitelist()`
`String`	`getTimePrecisionMode()`
`boolean`	`isProvideTransactionMetadata()`
`boolean`	`isTableIgnoreBuiltin()`
`boolean`	`isTombstonesOnDelete()`
`void`	`setColumnBlacklist(String columnBlacklist)` Description is not available here, please check Debezium website for corresponding key 'column.blacklist' description.
`void`	`setDatabaseDbname(String databaseDbname)` The name of the database the connector should be monitoring.
`void`	`setDatabaseHistory(String databaseHistory)` The name of the DatabaseHistory class that should be used to store and recover database schema changes.
`void`	`setDatabaseHistoryFileFilename(String databaseHistoryFileFilename)` The path to the file that will be used to record the database history
`void`	`setDatabaseHistoryKafkaBootstrapServers(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.
`void`	`setDatabaseHistoryKafkaRecoveryAttempts(int databaseHistoryKafkaRecoveryAttempts)` The number of attempts in a row that no data are returned from Kafka before recover completes.
`void`	`setDatabaseHistoryKafkaRecoveryPollIntervalMs(int databaseHistoryKafkaRecoveryPollIntervalMs)` The number of milliseconds to wait while polling for persisted data during recovery.
`void`	`setDatabaseHistoryKafkaTopic(String databaseHistoryKafkaTopic)` The name of the topic for the database schema history
`void`	`setDatabaseHostname(String databaseHostname)` Resolvable hostname or IP address of the SQL Server database server.
`void`	`setDatabasePassword(String databasePassword)` Password of the SQL Server database user to be used when connecting to the database.
`void`	`setDatabasePort(int databasePort)` Port of the SQL Server database server.
`void`	`setDatabaseServerName(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.
`void`	`setDatabaseServerTimezone(String databaseServerTimezone)` The timezone of the server used to correctly shift the commit transaction timestamp on the client sideOptions include: Any valid Java ZoneId
`void`	`setDatabaseUser(String databaseUser)` Name of the SQL Server database user to be used when connecting to the database.
`void`	`setDecimalHandlingMode(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.
`void`	`setEventProcessingFailureHandlingMode(String eventProcessingFailureHandlingMode)` Specify how failures during processing of events (i.e.
`void`	`setHeartbeatIntervalMs(int heartbeatIntervalMs)` Length of an interval in milli-seconds in in which the connector periodically sends heartbeat messages to a heartbeat topic.
`void`	`setHeartbeatTopicsPrefix(String heartbeatTopicsPrefix)` The prefix that is used to name heartbeat topics.Defaults to __debezium-heartbeat.
`void`	`setMaxBatchSize(int maxBatchSize)` Maximum size of each batch of source records.
`void`	`setMaxQueueSize(int maxQueueSize)` Maximum size of the queue for change events read from the database log but not yet recorded or forwarded.
`void`	`setMessageKeyColumns(String messageKeyColumns)` A semicolon-separated list of expressions that match fully-qualified tables and column(s) to be used as message key.
`void`	`setPollIntervalMs(long pollIntervalMs)` Frequency in milliseconds to wait for new change events to appear after receiving no events.
`void`	`setProvideTransactionMetadata(boolean provideTransactionMetadata)` Enables transaction metadata extraction together with event counting
`void`	`setSnapshotDelayMs(long snapshotDelayMs)` The number of milliseconds to delay before a snapshot will begin.
`void`	`setSnapshotFetchSize(int snapshotFetchSize)` The maximum number of records that should be loaded into memory while performing a snapshot
`void`	`setSnapshotLockTimeoutMs(long snapshotLockTimeoutMs)` The maximum number of millis to wait for table locks at the beginning of a snapshot.
`void`	`setSnapshotMode(String snapshotMode)` The criteria for running a snapshot upon startup of the connector.
`void`	`setSnapshotSelectStatementOverrides(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 .
`void`	`setSourceStructVersion(String sourceStructVersion)` A version of the format of the publicly visible source part in the message
`void`	`setTableBlacklist(String tableBlacklist)` Description is not available here, please check Debezium website for corresponding key 'table.blacklist' description.
`void`	`setTableIgnoreBuiltin(boolean tableIgnoreBuiltin)` Flag specifying whether built-in tables should be ignored.
`void`	`setTableWhitelist(String tableWhitelist)` The tables for which changes are to be captured
`void`	`setTimePrecisionMode(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 .
`void`	`setTombstonesOnDelete(boolean tombstonesOnDelete)` Whether delete operations should be represented by a delete event and a subsquenttombstone event (true) or only by a delete event (false).
`protected org.apache.camel.component.debezium.configuration.ConfigurationValidation`	`validateConnectorConfiguration()`

Methods inherited from class org.apache.camel.component.debezium.configuration.EmbeddedDebeziumConfiguration
addPropertyIfNotNull, addPropertyIfNotNull, createDebeziumConfiguration, getAdditionalProperties, getConnectorClass, getInternalKeyConverter, getInternalValueConverter, getName, getOffsetCommitPolicy, getOffsetCommitTimeoutMs, getOffsetFlushIntervalMs, getOffsetStorage, getOffsetStorageFileName, getOffsetStoragePartitions, getOffsetStorageReplicationFactor, getOffsetStorageTopic, isFieldValueNotSet, setAdditionalProperties, setConnectorClass, setInternalKeyConverter, setInternalValueConverter, setName, setOffsetCommitPolicy, setOffsetCommitTimeoutMs, setOffsetFlushIntervalMs, setOffsetStorage, setOffsetStorageFileName, setOffsetStoragePartitions, setOffsetStorageReplicationFactor, setOffsetStorageTopic, validateConfiguration

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - SqlServerConnectorEmbeddedDebeziumConfiguration
```
public SqlServerConnectorEmbeddedDebeziumConfiguration()
```
- Method Detail
  - setMessageKeyColumns
```
public void setMessageKeyColumns(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
  - getMessageKeyColumns
```
public String getMessageKeyColumns()
```
  - setMaxQueueSize
```
public void setMaxQueueSize(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.
  - getMaxQueueSize
```
public int getMaxQueueSize()
```
  - setDatabaseHistoryKafkaTopic
```
public void setDatabaseHistoryKafkaTopic(String databaseHistoryKafkaTopic)
```
    The name of the topic for the database schema history
  - getDatabaseHistoryKafkaTopic
```
public String getDatabaseHistoryKafkaTopic()
```
  - setColumnBlacklist
```
public void setColumnBlacklist(String columnBlacklist)
```
    Description is not available here, please check Debezium website for corresponding key 'column.blacklist' description.
  - getColumnBlacklist
```
public String getColumnBlacklist()
```
  - setSnapshotDelayMs
```
public void setSnapshotDelayMs(long snapshotDelayMs)
```
    The number of milliseconds to delay before a snapshot will begin.
  - getSnapshotDelayMs
```
public long getSnapshotDelayMs()
```
  - setDatabaseHistoryKafkaRecoveryAttempts
```
public void setDatabaseHistoryKafkaRecoveryAttempts(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).
  - getDatabaseHistoryKafkaRecoveryAttempts
```
public int getDatabaseHistoryKafkaRecoveryAttempts()
```
  - setTableBlacklist
```
public void setTableBlacklist(String tableBlacklist)
```
    Description is not available here, please check Debezium website for corresponding key 'table.blacklist' description.
  - getTableBlacklist
```
public String getTableBlacklist()
```
  - setProvideTransactionMetadata
```
public void setProvideTransactionMetadata(boolean provideTransactionMetadata)
```
    Enables transaction metadata extraction together with event counting
  - isProvideTransactionMetadata
```
public boolean isProvideTransactionMetadata()
```
  - setTableWhitelist
```
public void setTableWhitelist(String tableWhitelist)
```
    The tables for which changes are to be captured
  - getTableWhitelist
```
public String getTableWhitelist()
```
  - setDatabaseServerTimezone
```
public void setDatabaseServerTimezone(String databaseServerTimezone)
```
    The timezone of the server used to correctly shift the commit transaction timestamp on the client sideOptions include: Any valid Java ZoneId
  - getDatabaseServerTimezone
```
public String getDatabaseServerTimezone()
```
  - setTombstonesOnDelete
```
public void setTombstonesOnDelete(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.
  - isTombstonesOnDelete
```
public boolean isTombstonesOnDelete()
```
  - setDecimalHandlingMode
```
public void setDecimalHandlingMode(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.
  - getDecimalHandlingMode
```
public String getDecimalHandlingMode()
```
  - setDatabaseHistoryKafkaRecoveryPollIntervalMs
```
public void setDatabaseHistoryKafkaRecoveryPollIntervalMs(int databaseHistoryKafkaRecoveryPollIntervalMs)
```
    The number of milliseconds to wait while polling for persisted data during recovery.
  - getDatabaseHistoryKafkaRecoveryPollIntervalMs
```
public int getDatabaseHistoryKafkaRecoveryPollIntervalMs()
```
  - setPollIntervalMs
```
public void setPollIntervalMs(long pollIntervalMs)
```
    Frequency in milliseconds to wait for new change events to appear after receiving no events. Defaults to 500ms.
  - getPollIntervalMs
```
public long getPollIntervalMs()
```
  - setHeartbeatTopicsPrefix
```
public void setHeartbeatTopicsPrefix(String heartbeatTopicsPrefix)
```
    The prefix that is used to name heartbeat topics.Defaults to __debezium-heartbeat.
  - getHeartbeatTopicsPrefix
```
public String getHeartbeatTopicsPrefix()
```
  - setTableIgnoreBuiltin
```
public void setTableIgnoreBuiltin(boolean tableIgnoreBuiltin)
```
    Flag specifying whether built-in tables should be ignored.
  - isTableIgnoreBuiltin
```
public boolean isTableIgnoreBuiltin()
```
  - setSnapshotFetchSize
```
public void setSnapshotFetchSize(int snapshotFetchSize)
```
    The maximum number of records that should be loaded into memory while performing a snapshot
  - getSnapshotFetchSize
```
public int getSnapshotFetchSize()
```
  - setSnapshotLockTimeoutMs
```
public void setSnapshotLockTimeoutMs(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
  - getSnapshotLockTimeoutMs
```
public long getSnapshotLockTimeoutMs()
```
  - setDatabaseHistoryFileFilename
```
public void setDatabaseHistoryFileFilename(String databaseHistoryFileFilename)
```
    The path to the file that will be used to record the database history
  - getDatabaseHistoryFileFilename
```
public String getDatabaseHistoryFileFilename()
```
  - setDatabaseDbname
```
public void setDatabaseDbname(String databaseDbname)
```
    The name of the database the connector should be monitoring. When working with a multi-tenant set-up, must be set to the CDB name.
  - getDatabaseDbname
```
public String getDatabaseDbname()
```
  - setDatabaseUser
```
public void setDatabaseUser(String databaseUser)
```
    Name of the SQL Server database user to be used when connecting to the database.
  - getDatabaseUser
```
public String getDatabaseUser()
```
  - setSnapshotSelectStatementOverrides
```
public void setSnapshotSelectStatementOverrides(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.
  - getSnapshotSelectStatementOverrides
```
public String getSnapshotSelectStatementOverrides()
```
  - setDatabaseHistoryKafkaBootstrapServers
```
public void setDatabaseHistoryKafkaBootstrapServers(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.
  - getDatabaseHistoryKafkaBootstrapServers
```
public String getDatabaseHistoryKafkaBootstrapServers()
```
  - setTimePrecisionMode
```
public void setTimePrecisionMode(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 .
  - getTimePrecisionMode
```
public String getTimePrecisionMode()
```
  - setDatabaseServerName
```
public void setDatabaseServerName(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.
  - getDatabaseServerName
```
public String getDatabaseServerName()
```
  - setHeartbeatIntervalMs
```
public void setHeartbeatIntervalMs(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.
  - getHeartbeatIntervalMs
```
public int getHeartbeatIntervalMs()
```
  - setSourceStructVersion
```
public void setSourceStructVersion(String sourceStructVersion)
```
    A version of the format of the publicly visible source part in the message
  - getSourceStructVersion
```
public String getSourceStructVersion()
```
  - setEventProcessingFailureHandlingMode
```
public void setEventProcessingFailureHandlingMode(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.
  - getEventProcessingFailureHandlingMode
```
public String getEventProcessingFailureHandlingMode()
```
  - setDatabasePort
```
public void setDatabasePort(int databasePort)
```
    Port of the SQL Server database server.
  - getDatabasePort
```
public int getDatabasePort()
```
  - setDatabaseHostname
```
public void setDatabaseHostname(String databaseHostname)
```
    Resolvable hostname or IP address of the SQL Server database server.
  - getDatabaseHostname
```
public String getDatabaseHostname()
```
  - setDatabasePassword
```
public void setDatabasePassword(String databasePassword)
```
    Password of the SQL Server database user to be used when connecting to the database.
  - getDatabasePassword
```
public String getDatabasePassword()
```
  - setMaxBatchSize
```
public void setMaxBatchSize(int maxBatchSize)
```
    Maximum size of each batch of source records. Defaults to 2048.
  - getMaxBatchSize
```
public int getMaxBatchSize()
```
  - setSnapshotMode
```
public void setSnapshotMode(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.
  - getSnapshotMode
```
public String getSnapshotMode()
```
  - setDatabaseHistory
```
public void setDatabaseHistory(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.
  - getDatabaseHistory
```
public String getDatabaseHistory()
```
  - createConnectorConfiguration
```
protected io.debezium.config.Configuration createConnectorConfiguration()
```
    Specified by:
    
    createConnectorConfiguration in class org.apache.camel.component.debezium.configuration.EmbeddedDebeziumConfiguration
  - configureConnectorClass
```
protected Class configureConnectorClass()
```
    Specified by:
    
    configureConnectorClass in class org.apache.camel.component.debezium.configuration.EmbeddedDebeziumConfiguration
  - validateConnectorConfiguration
```
protected org.apache.camel.component.debezium.configuration.ConfigurationValidation validateConnectorConfiguration()
```
    Specified by:
    
    validateConnectorConfiguration in class org.apache.camel.component.debezium.configuration.EmbeddedDebeziumConfiguration
  - getConnectorDatabaseType
```
public String getConnectorDatabaseType()
```
    Specified by:
    
    getConnectorDatabaseType in class org.apache.camel.component.debezium.configuration.EmbeddedDebeziumConfiguration

Class SqlServerConnectorEmbeddedDebeziumConfiguration

Constructor Summary

Method Summary

Methods inherited from class org.apache.camel.component.debezium.configuration.EmbeddedDebeziumConfiguration

Methods inherited from class java.lang.Object

Constructor Detail

SqlServerConnectorEmbeddedDebeziumConfiguration

Method Detail

setMessageKeyColumns

getMessageKeyColumns

setMaxQueueSize

getMaxQueueSize

setDatabaseHistoryKafkaTopic

getDatabaseHistoryKafkaTopic

setColumnBlacklist

getColumnBlacklist

setSnapshotDelayMs

getSnapshotDelayMs

setDatabaseHistoryKafkaRecoveryAttempts

getDatabaseHistoryKafkaRecoveryAttempts

setTableBlacklist

getTableBlacklist

setProvideTransactionMetadata

isProvideTransactionMetadata

setTableWhitelist

getTableWhitelist

setDatabaseServerTimezone

getDatabaseServerTimezone

setTombstonesOnDelete

isTombstonesOnDelete

setDecimalHandlingMode

getDecimalHandlingMode

setDatabaseHistoryKafkaRecoveryPollIntervalMs

getDatabaseHistoryKafkaRecoveryPollIntervalMs

setPollIntervalMs

getPollIntervalMs

setHeartbeatTopicsPrefix

getHeartbeatTopicsPrefix

setTableIgnoreBuiltin

isTableIgnoreBuiltin

setSnapshotFetchSize

getSnapshotFetchSize

setSnapshotLockTimeoutMs

getSnapshotLockTimeoutMs

setDatabaseHistoryFileFilename

getDatabaseHistoryFileFilename

setDatabaseDbname

getDatabaseDbname

setDatabaseUser

getDatabaseUser

setSnapshotSelectStatementOverrides

getSnapshotSelectStatementOverrides

setDatabaseHistoryKafkaBootstrapServers

getDatabaseHistoryKafkaBootstrapServers

setTimePrecisionMode

getTimePrecisionMode

setDatabaseServerName

getDatabaseServerName

setHeartbeatIntervalMs

getHeartbeatIntervalMs

setSourceStructVersion

getSourceStructVersion

setEventProcessingFailureHandlingMode

getEventProcessingFailureHandlingMode

setDatabasePort

getDatabasePort

setDatabaseHostname

getDatabaseHostname

setDatabasePassword

getDatabasePassword

setMaxBatchSize

getMaxBatchSize

setSnapshotMode

getSnapshotMode

setDatabaseHistory

getDatabaseHistory

createConnectorConfiguration

configureConnectorClass

validateConnectorConfiguration

getConnectorDatabaseType