@UriParams
public class SqlServerConnectorEmbeddedDebeziumConfiguration
extends org.apache.camel.component.debezium.configuration.EmbeddedDebeziumConfiguration
| Constructor and Description |
|---|
SqlServerConnectorEmbeddedDebeziumConfiguration() |
| Modifier and Type | Method and Description |
|---|---|
protected Class |
configureConnectorClass() |
protected io.debezium.config.Configuration |
createConnectorConfiguration() |
String |
getBinaryHandlingMode() |
String |
getColumnBlacklist() |
String |
getColumnExcludeList() |
String |
getColumnIncludeList() |
String |
getColumnPropagateSourceType() |
String |
getColumnWhitelist() |
String |
getConnectorDatabaseType() |
String |
getConverters() |
String |
getDatabaseDbname() |
String |
getDatabaseHistory() |
String |
getDatabaseHistoryFileFilename() |
String |
getDatabaseHistoryKafkaBootstrapServers() |
int |
getDatabaseHistoryKafkaRecoveryAttempts() |
int |
getDatabaseHistoryKafkaRecoveryPollIntervalMs() |
String |
getDatabaseHistoryKafkaTopic() |
String |
getDatabaseHostname() |
String |
getDatabaseInstance() |
String |
getDatabasePassword() |
int |
getDatabasePort() |
String |
getDatabaseServerName() |
String |
getDatabaseServerTimezone() |
String |
getDatabaseUser() |
String |
getDatatypePropagateSourceType() |
String |
getDecimalHandlingMode() |
String |
getEventProcessingFailureHandlingMode() |
int |
getHeartbeatIntervalMs() |
String |
getHeartbeatTopicsPrefix() |
int |
getMaxBatchSize() |
int |
getMaxQueueSize() |
long |
getMaxQueueSizeInBytes() |
String |
getMessageKeyColumns() |
long |
getPollIntervalMs() |
int |
getQueryFetchSize() |
long |
getRetriableRestartConnectorWaitMs() |
String |
getSignalDataCollection() |
String |
getSkippedOperations() |
long |
getSnapshotDelayMs() |
int |
getSnapshotFetchSize() |
String |
getSnapshotIncludeCollectionList() |
String |
getSnapshotIsolationMode() |
long |
getSnapshotLockTimeoutMs() |
int |
getSnapshotMaxThreads() |
String |
getSnapshotMode() |
String |
getSnapshotSelectStatementOverrides() |
String |
getSourceStructVersion() |
String |
getSourceTimestampMode() |
String |
getTableBlacklist() |
String |
getTableExcludeList() |
String |
getTableIncludeList() |
String |
getTableWhitelist() |
String |
getTimePrecisionMode() |
boolean |
isIncludeSchemaChanges() |
boolean |
isProvideTransactionMetadata() |
boolean |
isSanitizeFieldNames() |
boolean |
isTableIgnoreBuiltin() |
boolean |
isTombstonesOnDelete() |
void |
setBinaryHandlingMode(String binaryHandlingMode)
Specify how binary (blob, binary, etc.) columns should be represented in
change events, including:'bytes' represents binary data as byte array
(default)'base64' represents binary data as base64-encoded string'hex'
represents binary data as hex-encoded (base16) string
|
void |
setColumnBlacklist(String columnBlacklist)
Regular expressions matching columns to exclude from change events
(deprecated, use "column.exclude.list" instead)
|
void |
setColumnExcludeList(String columnExcludeList)
Regular expressions matching columns to exclude from change events
|
void |
setColumnIncludeList(String columnIncludeList)
Regular expressions matching columns to include in change events
|
void |
setColumnPropagateSourceType(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.
|
void |
setColumnWhitelist(String columnWhitelist)
Regular expressions matching columns to include in change events
(deprecated, use "column.include.list" instead)
|
void |
setConverters(String converters)
Optional list of custom converters that would be used instead of default
ones.
|
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 database server.
|
void |
setDatabaseInstance(String databaseInstance)
The SQL Server instance name
|
void |
setDatabasePassword(String databasePassword)
Password of the database user to be used when connecting to the database.
|
void |
setDatabasePort(int databasePort)
Port of the 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 database user to be used when connecting to the database.
|
void |
setDatatypePropagateSourceType(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.
|
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 |
setIncludeSchemaChanges(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.
|
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 |
setMaxQueueSizeInBytes(long maxQueueSizeInBytes)
Maximum size of the queue in bytes 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)
Time to wait for new change events to appear after receiving no events,
given in milliseconds.
|
void |
setProvideTransactionMetadata(boolean provideTransactionMetadata)
Enables transaction metadata extraction together with event counting
|
void |
setQueryFetchSize(int queryFetchSize)
The maximum number of records that should be loaded into memory while
streaming.
|
void |
setRetriableRestartConnectorWaitMs(long retriableRestartConnectorWaitMs)
Time to wait before restarting connector after retriable exception
occurs.
|
void |
setSanitizeFieldNames(boolean sanitizeFieldNames)
Whether field names will be sanitized to Avro naming conventions
|
void |
setSignalDataCollection(String signalDataCollection)
The name of the data collection that is used to send signals/commands to
Debezium.
|
void |
setSkippedOperations(String skippedOperations)
The comma-separated list of operations to skip during streaming, defined
as: 'c' for inserts/create; 'u' for updates; 'd' for deletes.
|
void |
setSnapshotDelayMs(long snapshotDelayMs)
A delay period before a snapshot will begin, given in milliseconds.
|
void |
setSnapshotFetchSize(int snapshotFetchSize)
The maximum number of records that should be loaded into memory while
performing a snapshot
|
void |
setSnapshotIncludeCollectionList(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.
|
void |
setSnapshotIsolationMode(String snapshotIsolationMode)
Controls which transaction isolation level is used and how long the
connector locks the monitored tables.
|
void |
setSnapshotLockTimeoutMs(long snapshotLockTimeoutMs)
The maximum number of millis to wait for table locks at the beginning of
a snapshot.
|
void |
setSnapshotMaxThreads(int snapshotMaxThreads)
The maximum number of threads used to perform the 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 |
setSourceTimestampMode(String sourceTimestampMode)
Configures the criteria of the attached timestamp within the source
record (ts_ms).Options include:'commit', (default) the source timestamp
is set to the instant where the record was committed in the
database'processing', the source timestamp is set to the instant where
the record was processed by Debezium.
|
void |
setTableBlacklist(String tableBlacklist)
A comma-separated list of regular expressions that match the
fully-qualified names of tables to be excluded from monitoring
(deprecated, use "table.exclude.list" instead)
|
void |
setTableExcludeList(String tableExcludeList)
A comma-separated list of regular expressions that match the
fully-qualified names of tables to be excluded from monitoring
|
void |
setTableIgnoreBuiltin(boolean tableIgnoreBuiltin)
Flag specifying whether built-in tables should be ignored.
|
void |
setTableIncludeList(String tableIncludeList)
The tables for which changes are to be captured
|
void |
setTableWhitelist(String tableWhitelist)
The tables for which changes are to be captured (deprecated, use
"table.include.list" instead)
|
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() |
addPropertyIfNotNull, addPropertyIfNotNull, copy, 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, validateConfigurationpublic SqlServerConnectorEmbeddedDebeziumConfiguration()
public void setMessageKeyColumns(String messageKeyColumns)
public String getMessageKeyColumns()
public void setQueryFetchSize(int queryFetchSize)
public int getQueryFetchSize()
public void setColumnBlacklist(String columnBlacklist)
public String getColumnBlacklist()
public void setDatabaseInstance(String databaseInstance)
public String getDatabaseInstance()
public void setTableBlacklist(String tableBlacklist)
public String getTableBlacklist()
public void setIncludeSchemaChanges(boolean includeSchemaChanges)
public boolean isIncludeSchemaChanges()
public void setPollIntervalMs(long pollIntervalMs)
public long getPollIntervalMs()
public void setDatabaseHistoryKafkaRecoveryPollIntervalMs(int databaseHistoryKafkaRecoveryPollIntervalMs)
public int getDatabaseHistoryKafkaRecoveryPollIntervalMs()
public void setSignalDataCollection(String signalDataCollection)
public String getSignalDataCollection()
public void setConverters(String converters)
public String getConverters()
public void setHeartbeatTopicsPrefix(String heartbeatTopicsPrefix)
public String getHeartbeatTopicsPrefix()
public void setSnapshotFetchSize(int snapshotFetchSize)
public int getSnapshotFetchSize()
public void setSnapshotLockTimeoutMs(long snapshotLockTimeoutMs)
public long getSnapshotLockTimeoutMs()
public void setSourceTimestampMode(String sourceTimestampMode)
public String getSourceTimestampMode()
public void setDatabaseDbname(String databaseDbname)
public String getDatabaseDbname()
public void setDatabaseUser(String databaseUser)
public String getDatabaseUser()
public void setDatatypePropagateSourceType(String datatypePropagateSourceType)
public String getDatatypePropagateSourceType()
public void setSanitizeFieldNames(boolean sanitizeFieldNames)
public boolean isSanitizeFieldNames()
public void setSnapshotSelectStatementOverrides(String snapshotSelectStatementOverrides)
public String getSnapshotSelectStatementOverrides()
public void setDatabaseHistoryKafkaBootstrapServers(String databaseHistoryKafkaBootstrapServers)
public String getDatabaseHistoryKafkaBootstrapServers()
public void setSourceStructVersion(String sourceStructVersion)
public String getSourceStructVersion()
public void setHeartbeatIntervalMs(int heartbeatIntervalMs)
public int getHeartbeatIntervalMs()
public void setColumnWhitelist(String columnWhitelist)
public String getColumnWhitelist()
public void setColumnIncludeList(String columnIncludeList)
public String getColumnIncludeList()
public void setColumnPropagateSourceType(String columnPropagateSourceType)
public String getColumnPropagateSourceType()
public void setTableExcludeList(String tableExcludeList)
public String getTableExcludeList()
public void setDatabasePassword(String databasePassword)
public String getDatabasePassword()
public void setMaxBatchSize(int maxBatchSize)
public int getMaxBatchSize()
public void setSkippedOperations(String skippedOperations)
public String getSkippedOperations()
public void setSnapshotMode(String snapshotMode)
public String getSnapshotMode()
public void setDatabaseHistory(String databaseHistory)
public String getDatabaseHistory()
public void setMaxQueueSize(int maxQueueSize)
public int getMaxQueueSize()
public void setDatabaseHistoryKafkaTopic(String databaseHistoryKafkaTopic)
public String getDatabaseHistoryKafkaTopic()
public void setRetriableRestartConnectorWaitMs(long retriableRestartConnectorWaitMs)
public long getRetriableRestartConnectorWaitMs()
public void setSnapshotDelayMs(long snapshotDelayMs)
public long getSnapshotDelayMs()
public void setDatabaseHistoryKafkaRecoveryAttempts(int databaseHistoryKafkaRecoveryAttempts)
public int getDatabaseHistoryKafkaRecoveryAttempts()
public void setProvideTransactionMetadata(boolean provideTransactionMetadata)
public boolean isProvideTransactionMetadata()
public void setTableWhitelist(String tableWhitelist)
public String getTableWhitelist()
public void setDatabaseServerTimezone(String databaseServerTimezone)
public String getDatabaseServerTimezone()
public void setTombstonesOnDelete(boolean tombstonesOnDelete)
public boolean isTombstonesOnDelete()
public void setDecimalHandlingMode(String decimalHandlingMode)
public String getDecimalHandlingMode()
public void setBinaryHandlingMode(String binaryHandlingMode)
public String getBinaryHandlingMode()
public void setTableIgnoreBuiltin(boolean tableIgnoreBuiltin)
public boolean isTableIgnoreBuiltin()
public void setSnapshotIncludeCollectionList(String snapshotIncludeCollectionList)
public String getSnapshotIncludeCollectionList()
public void setDatabaseHistoryFileFilename(String databaseHistoryFileFilename)
public String getDatabaseHistoryFileFilename()
public void setMaxQueueSizeInBytes(long maxQueueSizeInBytes)
public long getMaxQueueSizeInBytes()
public void setTimePrecisionMode(String timePrecisionMode)
public String getTimePrecisionMode()
public void setDatabaseServerName(String databaseServerName)
public String getDatabaseServerName()
public void setEventProcessingFailureHandlingMode(String eventProcessingFailureHandlingMode)
public String getEventProcessingFailureHandlingMode()
public void setSnapshotIsolationMode(String snapshotIsolationMode)
public String getSnapshotIsolationMode()
public void setSnapshotMaxThreads(int snapshotMaxThreads)
public int getSnapshotMaxThreads()
public void setDatabasePort(int databasePort)
public int getDatabasePort()
public void setColumnExcludeList(String columnExcludeList)
public String getColumnExcludeList()
public void setDatabaseHostname(String databaseHostname)
public String getDatabaseHostname()
public void setTableIncludeList(String tableIncludeList)
public String getTableIncludeList()
protected io.debezium.config.Configuration createConnectorConfiguration()
createConnectorConfiguration in class org.apache.camel.component.debezium.configuration.EmbeddedDebeziumConfigurationprotected Class configureConnectorClass()
configureConnectorClass in class org.apache.camel.component.debezium.configuration.EmbeddedDebeziumConfigurationprotected org.apache.camel.component.debezium.configuration.ConfigurationValidation validateConnectorConfiguration()
validateConnectorConfiguration in class org.apache.camel.component.debezium.configuration.EmbeddedDebeziumConfigurationpublic String getConnectorDatabaseType()
getConnectorDatabaseType in class org.apache.camel.component.debezium.configuration.EmbeddedDebeziumConfigurationApache Camel