Interface DebeziumOracleComponentBuilderFactory.DebeziumOracleComponentBuilder
- All Superinterfaces:
ComponentBuilder<org.apache.camel.component.debezium.DebeziumOracleComponent>
- All Known Implementing Classes:
DebeziumOracleComponentBuilderFactory.DebeziumOracleComponentBuilderImpl
- Enclosing interface:
- DebeziumOracleComponentBuilderFactory
public static interface DebeziumOracleComponentBuilderFactory.DebeziumOracleComponentBuilder
extends ComponentBuilder<org.apache.camel.component.debezium.DebeziumOracleComponent>
Builder for the Debezium Oracle Connector component.
-
Method Summary
Modifier and TypeMethodDescriptionadditionalProperties
(Map<String, Object> additionalProperties) Additional properties for debezium components in case they can't be set directly on the camel configurations (e.g: setting Kafka Connect properties needed by Debezium engine, for example setting KafkaOffsetBackingStore), the properties have to be prefixed with additionalProperties..autowiredEnabled
(boolean autowiredEnabled) Whether autowiring is enabled.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.bridgeErrorHandler
(boolean bridgeErrorHandler) Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler.columnExcludeList
(String columnExcludeList) Regular expressions matching columns to exclude from change events.columnIncludeList
(String columnIncludeList) Regular expressions matching columns to include in change events.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.configuration
(org.apache.camel.component.debezium.configuration.OracleConnectorEmbeddedDebeziumConfiguration configuration) Allow pre-configured Configurations to be set.converters
(String converters) Optional list of custom converters that would be used instead of default ones.databaseConnectionAdapter
(String databaseConnectionAdapter) The adapter to use when capturing changes from the database.databaseDbname
(String databaseDbname) The name of the database from which the connector should capture changes.databaseHostname
(String databaseHostname) Resolvable hostname or IP address of the database server.databaseOutServerName
(String databaseOutServerName) Name of the XStream Out server to connect to.databasePassword
(String databasePassword) Password of the database user to be used when connecting to the database.databasePdbName
(String databasePdbName) Name of the pluggable database when working with a multi-tenant set-up.databasePort
(int databasePort) Port of the database server.databaseUrl
(String databaseUrl) Complete JDBC URL as an alternative to specifying hostname, port and database provided as a way to support alternative connection scenarios.databaseUser
(String databaseUser) Name of the database user to be used when connecting to the database.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.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.errorsMaxRetries
(int errorsMaxRetries) The maximum number of retries on connection errors before failing (-1 = no limit, 0 = disabled, 0 = num of retries).eventProcessingFailureHandlingMode
(String eventProcessingFailureHandlingMode) Specify how failures during processing of events (i.e.heartbeatActionQuery
(String heartbeatActionQuery) The query executed with every heartbeat.heartbeatIntervalMs
(int heartbeatIntervalMs) Length of an interval in milli-seconds in in which the connector periodically sends heartbeat messages to a heartbeat topic.heartbeatTopicsPrefix
(String heartbeatTopicsPrefix) The prefix that is used to name heartbeat topics.Defaults to __debezium-heartbeat.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.includeSchemaComments
(boolean includeSchemaComments) Whether the connector parse table and column's comment to metadata object.internalKeyConverter
(String internalKeyConverter) The Converter class that should be used to serialize and deserialize key data for offsets.internalValueConverter
(String internalValueConverter) The Converter class that should be used to serialize and deserialize value data for offsets.intervalHandlingMode
(String intervalHandlingMode) Specify how INTERVAL columns should be represented in change events, including: 'string' represents values as an exact ISO formatted string; 'numeric' (default) represents values using the inexact conversion into microseconds.lobEnabled
(boolean lobEnabled) When set to 'false', the default, LOB fields will not be captured nor emitted.logMiningArchiveDestinationName
(String logMiningArchiveDestinationName) Sets the specific archive log destination as the source for reading archive logs.When not set, the connector will automatically select the first LOCAL and VALID destination.logMiningArchiveLogHours
(long logMiningArchiveLogHours) The number of hours in the past from SYSDATE to mine archive logs.logMiningArchiveLogOnlyMode
(boolean logMiningArchiveLogOnlyMode) When set to 'false', the default, the connector will mine both archive log and redo logs to emit change events.logMiningArchiveLogOnlyScnPollIntervalMs
(long logMiningArchiveLogOnlyScnPollIntervalMs) The interval in milliseconds to wait between polls checking to see if the SCN is in the archive logs.logMiningBatchSizeDefault
(long logMiningBatchSizeDefault) The starting SCN interval size that the connector will use for reading data from redo/archive logs.logMiningBatchSizeMax
(long logMiningBatchSizeMax) The maximum SCN interval size that this connector will use when reading from redo/archive logs.logMiningBatchSizeMin
(long logMiningBatchSizeMin) The minimum SCN interval size that this connector will try to read from redo/archive logs.logMiningBufferDropOnStop
(boolean logMiningBufferDropOnStop) When set to true the underlying buffer cache is not retained when the connector is stopped.logMiningBufferInfinispanCacheEvents
(String logMiningBufferInfinispanCacheEvents) Specifies the XML configuration for the Infinispan 'events' cache.logMiningBufferInfinispanCacheProcessedTransactions
(String logMiningBufferInfinispanCacheProcessedTransactions) Specifies the XML configuration for the Infinispan 'processed-transactions' cache.logMiningBufferInfinispanCacheSchemaChanges
(String logMiningBufferInfinispanCacheSchemaChanges) Specifies the XML configuration for the Infinispan 'schema-changes' cache.logMiningBufferInfinispanCacheTransactions
(String logMiningBufferInfinispanCacheTransactions) Specifies the XML configuration for the Infinispan 'transactions' cache.logMiningBufferTransactionEventsThreshold
(long logMiningBufferTransactionEventsThreshold) The number of events a transaction can include before the transaction is discarded.logMiningBufferType
(String logMiningBufferType) The buffer type controls how the connector manages buffering transaction data.logMiningFlushTableName
(String logMiningFlushTableName) The name of the flush table used by the connector, defaults to LOG_MINING_FLUSH.logMiningQueryFilterMode
(String logMiningQueryFilterMode) Specifies how the filter configuration is applied to the LogMiner database query.logMiningRestartConnection
(boolean logMiningRestartConnection) Debezium opens a database connection and keeps that connection open throughout the entire streaming phase.logMiningScnGapDetectionGapSizeMin
(long logMiningScnGapDetectionGapSizeMin) Used for SCN gap detection, if the difference between current SCN and previous end SCN is bigger than this value, and the time difference of current SCN and previous end SCN is smaller than log.mining.scn.gap.detection.time.interval.max.ms, consider it a SCN gap.logMiningScnGapDetectionTimeIntervalMaxMs
(long logMiningScnGapDetectionTimeIntervalMaxMs) Used for SCN gap detection, if the difference between current SCN and previous end SCN is bigger than log.mining.scn.gap.detection.gap.size.min, and the time difference of current SCN and previous end SCN is smaller than this value, consider it a SCN gap.logMiningSessionMaxMs
(long logMiningSessionMaxMs) The maximum number of milliseconds that a LogMiner session lives for before being restarted.logMiningSleepTimeDefaultMs
(long logMiningSleepTimeDefaultMs) The amount of time that the connector will sleep after reading data from redo/archive logs and before starting reading data again.logMiningSleepTimeIncrementMs
(long logMiningSleepTimeIncrementMs) The maximum amount of time that the connector will use to tune the optimal sleep time when reading data from LogMiner.logMiningSleepTimeMaxMs
(long logMiningSleepTimeMaxMs) The maximum amount of time that the connector will sleep after reading data from redo/archive logs and before starting reading data again.logMiningSleepTimeMinMs
(long logMiningSleepTimeMinMs) The minimum amount of time that the connector will sleep after reading data from redo/archive logs and before starting reading data again.logMiningStrategy
(String logMiningStrategy) There are strategies: Online catalog with faster mining but no captured DDL.logMiningTransactionRetentionMs
(long logMiningTransactionRetentionMs) Duration in milliseconds to keep long running transactions in transaction buffer between log mining sessions.logMiningUsernameExcludeList
(String logMiningUsernameExcludeList) Comma separated list of usernames to exclude from LogMiner query.logMiningUsernameIncludeList
(String logMiningUsernameIncludeList) Comma separated list of usernames to include from LogMiner query.maxBatchSize
(int maxBatchSize) Maximum size of each batch of source records.maxQueueSize
(int maxQueueSize) Maximum size of the queue for change events read from the database log but not yet recorded or forwarded.maxQueueSizeInBytes
(long maxQueueSizeInBytes) Maximum size of the queue in bytes for change events read from the database log but not yet recorded or forwarded.messageKeyColumns
(String messageKeyColumns) A semicolon-separated list of expressions that match fully-qualified tables and column(s) to be used as message key.notificationEnabledChannels
(String notificationEnabledChannels) List of notification channels names that are enabled.notificationSinkTopicName
(String notificationSinkTopicName) The name of the topic for the notifications.offsetCommitPolicy
(String offsetCommitPolicy) The name of the Java class of the commit policy.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.offsetFlushIntervalMs
(long offsetFlushIntervalMs) Interval at which to try committing offsets.offsetStorage
(String offsetStorage) The name of the Java class that is responsible for persistence of connector offsets.offsetStorageFileName
(String offsetStorageFileName) Path to file where offsets are to be stored.offsetStoragePartitions
(int offsetStoragePartitions) The number of partitions used when creating the offset storage topic.offsetStorageReplicationFactor
(int offsetStorageReplicationFactor) Replication factor used when creating the offset storage topic.offsetStorageTopic
(String offsetStorageTopic) The name of the Kafka topic where offsets are to be stored.pollIntervalMs
(long pollIntervalMs) Time to wait for new change events to appear after receiving no events, given in milliseconds.provideTransactionMetadata
(boolean provideTransactionMetadata) Enables transaction metadata extraction together with event counting.queryFetchSize
(int queryFetchSize) The maximum number of records that should be loaded into memory while streaming.A comma-separated list of RAC node hostnames or ip addresses.retriableRestartConnectorWaitMs
(long retriableRestartConnectorWaitMs) Time to wait before restarting connector after retriable exception occurs.schemaHistoryInternal
(String schemaHistoryInternal) The name of the SchemaHistory class that should be used to store and recover database schema changes.schemaHistoryInternalFileFilename
(String schemaHistoryInternalFileFilename) The path to the file that will be used to record the database schema history.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.schemaHistoryInternalStoreOnlyCapturedDatabasesDdl
(boolean schemaHistoryInternalStoreOnlyCapturedDatabasesDdl) Controls what DDL will Debezium store in database schema history.schemaHistoryInternalStoreOnlyCapturedTablesDdl
(boolean schemaHistoryInternalStoreOnlyCapturedTablesDdl) Controls what DDL will Debezium store in database schema history.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.signalDataCollection
(String signalDataCollection) The name of the data collection that is used to send signals/commands to Debezium.signalEnabledChannels
(String signalEnabledChannels) List of channels names that are enabled.signalPollIntervalMs
(long signalPollIntervalMs) Interval for looking for new signals in registered channels, given in milliseconds.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.snapshotDelayMs
(long snapshotDelayMs) A delay period before a snapshot will begin, given in milliseconds.snapshotEnhancePredicateScn
(String snapshotEnhancePredicateScn) A token to replace on snapshot predicate template.snapshotFetchSize
(int snapshotFetchSize) The maximum number of records that should be loaded into memory while performing a snapshot.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.snapshotLockingMode
(String snapshotLockingMode) Controls how the connector holds locks on tables while performing the schema snapshot.snapshotLockTimeoutMs
(long snapshotLockTimeoutMs) The maximum number of millis to wait for table locks at the beginning of a snapshot.snapshotMaxThreads
(int snapshotMaxThreads) The maximum number of threads used to perform the snapshot.snapshotMode
(String snapshotMode) The criteria for running a snapshot upon startup of the connector.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.snapshotTablesOrderByRowCount
(String snapshotTablesOrderByRowCount) Controls the order in which tables are processed in the initial snapshot.sourceinfoStructMaker
(String sourceinfoStructMaker) The name of the SourceInfoStructMaker class that returns SourceInfo schema and struct.tableExcludeList
(String tableExcludeList) A comma-separated list of regular expressions that match the fully-qualified names of tables to be excluded from monitoring.tableIncludeList
(String tableIncludeList) The tables for which changes are to be captured.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.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).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.topicPrefix
(String topicPrefix) Topic prefix that identifies and provides a namespace for the particular database server/cluster is capturing changes.unavailableValuePlaceholder
(String unavailableValuePlaceholder) Specify the constant that will be provided by Debezium to indicate that the original value is unavailable and not provided by the database.Methods inherited from interface org.apache.camel.builder.component.ComponentBuilder
build, build, doSetProperty, register
-
Method Details
-
additionalProperties
default DebeziumOracleComponentBuilderFactory.DebeziumOracleComponentBuilder additionalProperties(Map<String, Object> additionalProperties) Additional properties for debezium components in case they can't be set directly on the camel configurations (e.g: setting Kafka Connect properties needed by Debezium engine, for example setting KafkaOffsetBackingStore), the properties have to be prefixed with additionalProperties.. E.g: additionalProperties.transactional.id=12345&additionalProperties.schema.registry.url=http://localhost:8811/avro. The option is a: <code>java.util.Map<java.lang.String, java.lang.Object></code> type. Group: common- Parameters:
additionalProperties
- the value to set- Returns:
- the dsl builder
-
bridgeErrorHandler
default DebeziumOracleComponentBuilderFactory.DebeziumOracleComponentBuilder bridgeErrorHandler(boolean bridgeErrorHandler) Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored. The option is a: <code>boolean</code> type. Default: false Group: consumer- Parameters:
bridgeErrorHandler
- the value to set- Returns:
- the dsl builder
-
configuration
default DebeziumOracleComponentBuilderFactory.DebeziumOracleComponentBuilder configuration(org.apache.camel.component.debezium.configuration.OracleConnectorEmbeddedDebeziumConfiguration configuration) Allow pre-configured Configurations to be set. The option is a: <code>org.apache.camel.component.debezium.configuration.OracleConnectorEmbeddedDebeziumConfiguration</code> type. Group: consumer- Parameters:
configuration
- the value to set- Returns:
- the dsl builder
-
internalKeyConverter
default DebeziumOracleComponentBuilderFactory.DebeziumOracleComponentBuilder internalKeyConverter(String internalKeyConverter) The Converter class that should be used to serialize and deserialize key data for offsets. The default is JSON converter. The option is a: <code>java.lang.String</code> type. Default: org.apache.kafka.connect.json.JsonConverter Group: consumer- Parameters:
internalKeyConverter
- the value to set- Returns:
- the dsl builder
-
internalValueConverter
default DebeziumOracleComponentBuilderFactory.DebeziumOracleComponentBuilder internalValueConverter(String internalValueConverter) The Converter class that should be used to serialize and deserialize value data for offsets. The default is JSON converter. The option is a: <code>java.lang.String</code> type. Default: org.apache.kafka.connect.json.JsonConverter Group: consumer- Parameters:
internalValueConverter
- the value to set- Returns:
- the dsl builder
-
offsetCommitPolicy
default DebeziumOracleComponentBuilderFactory.DebeziumOracleComponentBuilder offsetCommitPolicy(String offsetCommitPolicy) The name of the Java class of the commit policy. It defines when offsets commit has to be triggered based on the number of events processed and the time elapsed since the last commit. This class must implement the interface 'OffsetCommitPolicy'. The default is a periodic commit policy based upon time intervals. The option is a: <code>java.lang.String</code> type. Group: consumer- Parameters:
offsetCommitPolicy
- the value to set- Returns:
- the dsl builder
-
offsetCommitTimeoutMs
default DebeziumOracleComponentBuilderFactory.DebeziumOracleComponentBuilder offsetCommitTimeoutMs(long offsetCommitTimeoutMs) Maximum number of milliseconds to wait for records to flush and partition offset data to be committed to offset storage before cancelling the process and restoring the offset data to be committed in a future attempt. The default is 5 seconds. The option is a: <code>long</code> type. Default: 5000 Group: consumer- Parameters:
offsetCommitTimeoutMs
- the value to set- Returns:
- the dsl builder
-
offsetFlushIntervalMs
default DebeziumOracleComponentBuilderFactory.DebeziumOracleComponentBuilder offsetFlushIntervalMs(long offsetFlushIntervalMs) Interval at which to try committing offsets. The default is 1 minute. The option is a: <code>long</code> type. Default: 60000 Group: consumer- Parameters:
offsetFlushIntervalMs
- the value to set- Returns:
- the dsl builder
-
offsetStorage
default DebeziumOracleComponentBuilderFactory.DebeziumOracleComponentBuilder offsetStorage(String offsetStorage) The name of the Java class that is responsible for persistence of connector offsets. The option is a: <code>java.lang.String</code> type. Default: org.apache.kafka.connect.storage.FileOffsetBackingStore Group: consumer- Parameters:
offsetStorage
- the value to set- Returns:
- the dsl builder
-
offsetStorageFileName
default DebeziumOracleComponentBuilderFactory.DebeziumOracleComponentBuilder offsetStorageFileName(String offsetStorageFileName) Path to file where offsets are to be stored. Required when offset.storage is set to the FileOffsetBackingStore. The option is a: <code>java.lang.String</code> type. Group: consumer- Parameters:
offsetStorageFileName
- the value to set- Returns:
- the dsl builder
-
offsetStoragePartitions
default DebeziumOracleComponentBuilderFactory.DebeziumOracleComponentBuilder offsetStoragePartitions(int offsetStoragePartitions) The number of partitions used when creating the offset storage topic. Required when offset.storage is set to the 'KafkaOffsetBackingStore'. The option is a: <code>int</code> type. Group: consumer- Parameters:
offsetStoragePartitions
- the value to set- Returns:
- the dsl builder
-
offsetStorageReplicationFactor
default DebeziumOracleComponentBuilderFactory.DebeziumOracleComponentBuilder offsetStorageReplicationFactor(int offsetStorageReplicationFactor) Replication factor used when creating the offset storage topic. Required when offset.storage is set to the KafkaOffsetBackingStore. The option is a: <code>int</code> type. Group: consumer- Parameters:
offsetStorageReplicationFactor
- the value to set- Returns:
- the dsl builder
-
offsetStorageTopic
default DebeziumOracleComponentBuilderFactory.DebeziumOracleComponentBuilder offsetStorageTopic(String offsetStorageTopic) The name of the Kafka topic where offsets are to be stored. Required when offset.storage is set to the KafkaOffsetBackingStore. The option is a: <code>java.lang.String</code> type. Group: consumer- Parameters:
offsetStorageTopic
- the value to set- Returns:
- the dsl builder
-
autowiredEnabled
default DebeziumOracleComponentBuilderFactory.DebeziumOracleComponentBuilder autowiredEnabled(boolean autowiredEnabled) Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc. The option is a: <code>boolean</code> type. Default: true Group: advanced- Parameters:
autowiredEnabled
- the value to set- Returns:
- the dsl builder
-
binaryHandlingMode
default DebeziumOracleComponentBuilderFactory.DebeziumOracleComponentBuilder 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: <code>java.lang.String</code> type. Default: bytes Group: oracle- Parameters:
binaryHandlingMode
- the value to set- Returns:
- the dsl builder
-
columnExcludeList
default DebeziumOracleComponentBuilderFactory.DebeziumOracleComponentBuilder columnExcludeList(String columnExcludeList) Regular expressions matching columns to exclude from change events. The option is a: <code>java.lang.String</code> type. Group: oracle- Parameters:
columnExcludeList
- the value to set- Returns:
- the dsl builder
-
columnIncludeList
default DebeziumOracleComponentBuilderFactory.DebeziumOracleComponentBuilder columnIncludeList(String columnIncludeList) Regular expressions matching columns to include in change events. The option is a: <code>java.lang.String</code> type. Group: oracle- Parameters:
columnIncludeList
- the value to set- Returns:
- the dsl builder
-
columnPropagateSourceType
default DebeziumOracleComponentBuilderFactory.DebeziumOracleComponentBuilder columnPropagateSourceType(String columnPropagateSourceType) A comma-separated list of regular expressions matching fully-qualified names of columns that adds the columns original type and original length as parameters to the corresponding field schemas in the emitted change records. The option is a: <code>java.lang.String</code> type. Group: oracle- Parameters:
columnPropagateSourceType
- the value to set- Returns:
- the dsl builder
-
converters
default DebeziumOracleComponentBuilderFactory.DebeziumOracleComponentBuilder converters(String converters) Optional list of custom converters that would be used instead of default ones. The converters are defined using '.type' config option and configured using options '.'. The option is a: <code>java.lang.String</code> type. Group: oracle- Parameters:
converters
- the value to set- Returns:
- the dsl builder
-
databaseConnectionAdapter
default DebeziumOracleComponentBuilderFactory.DebeziumOracleComponentBuilder databaseConnectionAdapter(String databaseConnectionAdapter) The adapter to use when capturing changes from the database. Options include: 'logminer': (the default) to capture changes using native Oracle LogMiner; 'xstream' to capture changes using Oracle XStreams. The option is a: <code>java.lang.String</code> type. Default: LogMiner Group: oracle- Parameters:
databaseConnectionAdapter
- the value to set- Returns:
- the dsl builder
-
databaseDbname
default DebeziumOracleComponentBuilderFactory.DebeziumOracleComponentBuilder databaseDbname(String databaseDbname) The name of the database from which the connector should capture changes. The option is a: <code>java.lang.String</code> type. Group: oracle- Parameters:
databaseDbname
- the value to set- Returns:
- the dsl builder
-
databaseHostname
default DebeziumOracleComponentBuilderFactory.DebeziumOracleComponentBuilder databaseHostname(String databaseHostname) Resolvable hostname or IP address of the database server. The option is a: <code>java.lang.String</code> type. Group: oracle- Parameters:
databaseHostname
- the value to set- Returns:
- the dsl builder
-
databaseOutServerName
default DebeziumOracleComponentBuilderFactory.DebeziumOracleComponentBuilder databaseOutServerName(String databaseOutServerName) Name of the XStream Out server to connect to. The option is a: <code>java.lang.String</code> type. Group: oracle- Parameters:
databaseOutServerName
- the value to set- Returns:
- the dsl builder
-
databasePassword
default DebeziumOracleComponentBuilderFactory.DebeziumOracleComponentBuilder databasePassword(String databasePassword) Password of the database user to be used when connecting to the database. The option is a: <code>java.lang.String</code> type. Group: oracle- Parameters:
databasePassword
- the value to set- Returns:
- the dsl builder
-
databasePdbName
default DebeziumOracleComponentBuilderFactory.DebeziumOracleComponentBuilder databasePdbName(String databasePdbName) Name of the pluggable database when working with a multi-tenant set-up. The CDB name must be given via database.dbname in this case. The option is a: <code>java.lang.String</code> type. Group: oracle- Parameters:
databasePdbName
- the value to set- Returns:
- the dsl builder
-
databasePort
default DebeziumOracleComponentBuilderFactory.DebeziumOracleComponentBuilder databasePort(int databasePort) Port of the database server. The option is a: <code>int</code> type. Default: 1528 Group: oracle- Parameters:
databasePort
- the value to set- Returns:
- the dsl builder
-
databaseUrl
default DebeziumOracleComponentBuilderFactory.DebeziumOracleComponentBuilder databaseUrl(String databaseUrl) Complete JDBC URL as an alternative to specifying hostname, port and database provided as a way to support alternative connection scenarios. The option is a: <code>java.lang.String</code> type. Group: oracle- Parameters:
databaseUrl
- the value to set- Returns:
- the dsl builder
-
databaseUser
default DebeziumOracleComponentBuilderFactory.DebeziumOracleComponentBuilder databaseUser(String databaseUser) Name of the database user to be used when connecting to the database. The option is a: <code>java.lang.String</code> type. Group: oracle- Parameters:
databaseUser
- the value to set- Returns:
- the dsl builder
-
datatypePropagateSourceType
default DebeziumOracleComponentBuilderFactory.DebeziumOracleComponentBuilder datatypePropagateSourceType(String datatypePropagateSourceType) A comma-separated list of regular expressions matching the database-specific data type names that adds the data type's original type and original length as parameters to the corresponding field schemas in the emitted change records. The option is a: <code>java.lang.String</code> type. Group: oracle- Parameters:
datatypePropagateSourceType
- the value to set- Returns:
- the dsl builder
-
decimalHandlingMode
default DebeziumOracleComponentBuilderFactory.DebeziumOracleComponentBuilder decimalHandlingMode(String decimalHandlingMode) Specify how DECIMAL and NUMERIC columns should be represented in change events, including: 'precise' (the default) uses java.math.BigDecimal to represent values, which are encoded in the change events using a binary representation and Kafka Connect's 'org.apache.kafka.connect.data.Decimal' type; 'string' uses string to represent values; 'double' represents values using Java's 'double', which may not offer the precision but will be far easier to use in consumers. The option is a: <code>java.lang.String</code> type. Default: precise Group: oracle- Parameters:
decimalHandlingMode
- the value to set- Returns:
- the dsl builder
-
errorsMaxRetries
default DebeziumOracleComponentBuilderFactory.DebeziumOracleComponentBuilder 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: <code>int</code> type. Default: -1 Group: oracle- Parameters:
errorsMaxRetries
- the value to set- Returns:
- the dsl builder
-
eventProcessingFailureHandlingMode
default DebeziumOracleComponentBuilderFactory.DebeziumOracleComponentBuilder eventProcessingFailureHandlingMode(String eventProcessingFailureHandlingMode) Specify how failures during processing of events (i.e. when encountering a corrupted event) should be handled, including: 'fail' (the default) an exception indicating the problematic event and its position is raised, causing the connector to be stopped; 'warn' the problematic event and its position will be logged and the event will be skipped; 'ignore' the problematic event will be skipped. The option is a: <code>java.lang.String</code> type. Default: fail Group: oracle- Parameters:
eventProcessingFailureHandlingMode
- the value to set- Returns:
- the dsl builder
-
heartbeatActionQuery
default DebeziumOracleComponentBuilderFactory.DebeziumOracleComponentBuilder heartbeatActionQuery(String heartbeatActionQuery) The query executed with every heartbeat. The option is a: <code>java.lang.String</code> type. Group: oracle- Parameters:
heartbeatActionQuery
- the value to set- Returns:
- the dsl builder
-
heartbeatIntervalMs
default DebeziumOracleComponentBuilderFactory.DebeziumOracleComponentBuilder heartbeatIntervalMs(int heartbeatIntervalMs) Length of an interval in milli-seconds in in which the connector periodically sends heartbeat messages to a heartbeat topic. Use 0 to disable heartbeat messages. Disabled by default. The option is a: <code>int</code> type. Default: 0ms Group: oracle- Parameters:
heartbeatIntervalMs
- the value to set- Returns:
- the dsl builder
-
heartbeatTopicsPrefix
default DebeziumOracleComponentBuilderFactory.DebeziumOracleComponentBuilder heartbeatTopicsPrefix(String heartbeatTopicsPrefix) The prefix that is used to name heartbeat topics.Defaults to __debezium-heartbeat. The option is a: <code>java.lang.String</code> type. Default: __debezium-heartbeat Group: oracle- Parameters:
heartbeatTopicsPrefix
- the value to set- Returns:
- the dsl builder
-
includeSchemaChanges
default DebeziumOracleComponentBuilderFactory.DebeziumOracleComponentBuilder 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: <code>boolean</code> type. Default: true Group: oracle- Parameters:
includeSchemaChanges
- the value to set- Returns:
- the dsl builder
-
includeSchemaComments
default DebeziumOracleComponentBuilderFactory.DebeziumOracleComponentBuilder includeSchemaComments(boolean includeSchemaComments) Whether the connector parse table and column's comment to metadata object. Note: Enable this option will bring the implications on memory usage. The number and size of ColumnImpl objects is what largely impacts how much memory is consumed by the Debezium connectors, and adding a String to each of them can potentially be quite heavy. The default is 'false'. The option is a: <code>boolean</code> type. Default: false Group: oracle- Parameters:
includeSchemaComments
- the value to set- Returns:
- the dsl builder
-
intervalHandlingMode
default DebeziumOracleComponentBuilderFactory.DebeziumOracleComponentBuilder intervalHandlingMode(String intervalHandlingMode) Specify how INTERVAL columns should be represented in change events, including: 'string' represents values as an exact ISO formatted string; 'numeric' (default) represents values using the inexact conversion into microseconds. The option is a: <code>java.lang.String</code> type. Default: numeric Group: oracle- Parameters:
intervalHandlingMode
- the value to set- Returns:
- the dsl builder
-
lobEnabled
default DebeziumOracleComponentBuilderFactory.DebeziumOracleComponentBuilder lobEnabled(boolean lobEnabled) When set to 'false', the default, LOB fields will not be captured nor emitted. When set to 'true', the connector will capture LOB fields and emit changes for those fields like any other column type. The option is a: <code>boolean</code> type. Default: false Group: oracle- Parameters:
lobEnabled
- the value to set- Returns:
- the dsl builder
-
logMiningArchiveDestinationName
default DebeziumOracleComponentBuilderFactory.DebeziumOracleComponentBuilder logMiningArchiveDestinationName(String logMiningArchiveDestinationName) Sets the specific archive log destination as the source for reading archive logs.When not set, the connector will automatically select the first LOCAL and VALID destination. The option is a: <code>java.lang.String</code> type. Group: oracle- Parameters:
logMiningArchiveDestinationName
- the value to set- Returns:
- the dsl builder
-
logMiningArchiveLogHours
default DebeziumOracleComponentBuilderFactory.DebeziumOracleComponentBuilder logMiningArchiveLogHours(long logMiningArchiveLogHours) The number of hours in the past from SYSDATE to mine archive logs. Using 0 mines all available archive logs. The option is a: <code>long</code> type. Default: 0 Group: oracle- Parameters:
logMiningArchiveLogHours
- the value to set- Returns:
- the dsl builder
-
logMiningArchiveLogOnlyMode
default DebeziumOracleComponentBuilderFactory.DebeziumOracleComponentBuilder logMiningArchiveLogOnlyMode(boolean logMiningArchiveLogOnlyMode) When set to 'false', the default, the connector will mine both archive log and redo logs to emit change events. When set to 'true', the connector will only mine archive logs. There are circumstances where its advantageous to only mine archive logs and accept latency in event emission due to frequent revolving redo logs. The option is a: <code>boolean</code> type. Default: false Group: oracle- Parameters:
logMiningArchiveLogOnlyMode
- the value to set- Returns:
- the dsl builder
-
logMiningArchiveLogOnlyScnPollIntervalMs
default DebeziumOracleComponentBuilderFactory.DebeziumOracleComponentBuilder logMiningArchiveLogOnlyScnPollIntervalMs(long logMiningArchiveLogOnlyScnPollIntervalMs) The interval in milliseconds to wait between polls checking to see if the SCN is in the archive logs. The option is a: <code>long</code> type. Default: 10s Group: oracle- Parameters:
logMiningArchiveLogOnlyScnPollIntervalMs
- the value to set- Returns:
- the dsl builder
-
logMiningBatchSizeDefault
default DebeziumOracleComponentBuilderFactory.DebeziumOracleComponentBuilder logMiningBatchSizeDefault(long logMiningBatchSizeDefault) The starting SCN interval size that the connector will use for reading data from redo/archive logs. The option is a: <code>long</code> type. Default: 20000 Group: oracle- Parameters:
logMiningBatchSizeDefault
- the value to set- Returns:
- the dsl builder
-
logMiningBatchSizeMax
default DebeziumOracleComponentBuilderFactory.DebeziumOracleComponentBuilder logMiningBatchSizeMax(long logMiningBatchSizeMax) The maximum SCN interval size that this connector will use when reading from redo/archive logs. The option is a: <code>long</code> type. Default: 100000 Group: oracle- Parameters:
logMiningBatchSizeMax
- the value to set- Returns:
- the dsl builder
-
logMiningBatchSizeMin
default DebeziumOracleComponentBuilderFactory.DebeziumOracleComponentBuilder logMiningBatchSizeMin(long logMiningBatchSizeMin) The minimum SCN interval size that this connector will try to read from redo/archive logs. Active batch size will be also increased/decreased by this amount for tuning connector throughput when needed. The option is a: <code>long</code> type. Default: 1000 Group: oracle- Parameters:
logMiningBatchSizeMin
- the value to set- Returns:
- the dsl builder
-
logMiningBufferDropOnStop
default DebeziumOracleComponentBuilderFactory.DebeziumOracleComponentBuilder logMiningBufferDropOnStop(boolean logMiningBufferDropOnStop) When set to true the underlying buffer cache is not retained when the connector is stopped. When set to false (the default), the buffer cache is retained across restarts. The option is a: <code>boolean</code> type. Default: false Group: oracle- Parameters:
logMiningBufferDropOnStop
- the value to set- Returns:
- the dsl builder
-
logMiningBufferInfinispanCacheEvents
default DebeziumOracleComponentBuilderFactory.DebeziumOracleComponentBuilder logMiningBufferInfinispanCacheEvents(String logMiningBufferInfinispanCacheEvents) Specifies the XML configuration for the Infinispan 'events' cache. The option is a: <code>java.lang.String</code> type. Group: oracle- Parameters:
logMiningBufferInfinispanCacheEvents
- the value to set- Returns:
- the dsl builder
-
logMiningBufferInfinispanCacheProcessedTransactions
default DebeziumOracleComponentBuilderFactory.DebeziumOracleComponentBuilder logMiningBufferInfinispanCacheProcessedTransactions(String logMiningBufferInfinispanCacheProcessedTransactions) Specifies the XML configuration for the Infinispan 'processed-transactions' cache. The option is a: <code>java.lang.String</code> type. Group: oracle- Parameters:
logMiningBufferInfinispanCacheProcessedTransactions
- the value to set- Returns:
- the dsl builder
-
logMiningBufferInfinispanCacheSchemaChanges
default DebeziumOracleComponentBuilderFactory.DebeziumOracleComponentBuilder logMiningBufferInfinispanCacheSchemaChanges(String logMiningBufferInfinispanCacheSchemaChanges) Specifies the XML configuration for the Infinispan 'schema-changes' cache. The option is a: <code>java.lang.String</code> type. Group: oracle- Parameters:
logMiningBufferInfinispanCacheSchemaChanges
- the value to set- Returns:
- the dsl builder
-
logMiningBufferInfinispanCacheTransactions
default DebeziumOracleComponentBuilderFactory.DebeziumOracleComponentBuilder logMiningBufferInfinispanCacheTransactions(String logMiningBufferInfinispanCacheTransactions) Specifies the XML configuration for the Infinispan 'transactions' cache. The option is a: <code>java.lang.String</code> type. Group: oracle- Parameters:
logMiningBufferInfinispanCacheTransactions
- the value to set- Returns:
- the dsl builder
-
logMiningBufferTransactionEventsThreshold
default DebeziumOracleComponentBuilderFactory.DebeziumOracleComponentBuilder logMiningBufferTransactionEventsThreshold(long logMiningBufferTransactionEventsThreshold) The number of events a transaction can include before the transaction is discarded. This is useful for managing buffer memory and/or space when dealing with very large transactions. Defaults to 0, meaning that no threshold is applied and transactions can have unlimited events. The option is a: <code>long</code> type. Default: 0 Group: oracle- Parameters:
logMiningBufferTransactionEventsThreshold
- the value to set- Returns:
- the dsl builder
-
logMiningBufferType
default DebeziumOracleComponentBuilderFactory.DebeziumOracleComponentBuilder logMiningBufferType(String logMiningBufferType) The buffer type controls how the connector manages buffering transaction data. memory - Uses the JVM process' heap to buffer all transaction data. infinispan_embedded - This option uses an embedded Infinispan cache to buffer transaction data and persist it to disk. infinispan_remote - This option uses a remote Infinispan cluster to buffer transaction data and persist it to disk. The option is a: <code>java.lang.String</code> type. Default: memory Group: oracle- Parameters:
logMiningBufferType
- the value to set- Returns:
- the dsl builder
-
logMiningFlushTableName
default DebeziumOracleComponentBuilderFactory.DebeziumOracleComponentBuilder logMiningFlushTableName(String logMiningFlushTableName) The name of the flush table used by the connector, defaults to LOG_MINING_FLUSH. The option is a: <code>java.lang.String</code> type. Default: LOG_MINING_FLUSH Group: oracle- Parameters:
logMiningFlushTableName
- the value to set- Returns:
- the dsl builder
-
logMiningQueryFilterMode
default DebeziumOracleComponentBuilderFactory.DebeziumOracleComponentBuilder logMiningQueryFilterMode(String logMiningQueryFilterMode) Specifies how the filter configuration is applied to the LogMiner database query. none - The query does not apply any schema or table filters, all filtering is at runtime by the connector. in - The query uses SQL in-clause expressions to specify the schema or table filters. regex - The query uses Oracle REGEXP_LIKE expressions to specify the schema or table filters. The option is a: <code>java.lang.String</code> type. Default: none Group: oracle- Parameters:
logMiningQueryFilterMode
- the value to set- Returns:
- the dsl builder
-
logMiningRestartConnection
default DebeziumOracleComponentBuilderFactory.DebeziumOracleComponentBuilder logMiningRestartConnection(boolean logMiningRestartConnection) Debezium opens a database connection and keeps that connection open throughout the entire streaming phase. In some situations, this can lead to excessive SGA memory usage. By setting this option to 'true' (the default is 'false'), the connector will close and re-open a database connection after every detected log switch or if the log.mining.session.max.ms has been reached. The option is a: <code>boolean</code> type. Default: false Group: oracle- Parameters:
logMiningRestartConnection
- the value to set- Returns:
- the dsl builder
-
logMiningScnGapDetectionGapSizeMin
default DebeziumOracleComponentBuilderFactory.DebeziumOracleComponentBuilder logMiningScnGapDetectionGapSizeMin(long logMiningScnGapDetectionGapSizeMin) Used for SCN gap detection, if the difference between current SCN and previous end SCN is bigger than this value, and the time difference of current SCN and previous end SCN is smaller than log.mining.scn.gap.detection.time.interval.max.ms, consider it a SCN gap. The option is a: <code>long</code> type. Default: 1000000 Group: oracle- Parameters:
logMiningScnGapDetectionGapSizeMin
- the value to set- Returns:
- the dsl builder
-
logMiningScnGapDetectionTimeIntervalMaxMs
default DebeziumOracleComponentBuilderFactory.DebeziumOracleComponentBuilder logMiningScnGapDetectionTimeIntervalMaxMs(long logMiningScnGapDetectionTimeIntervalMaxMs) Used for SCN gap detection, if the difference between current SCN and previous end SCN is bigger than log.mining.scn.gap.detection.gap.size.min, and the time difference of current SCN and previous end SCN is smaller than this value, consider it a SCN gap. The option is a: <code>long</code> type. Default: 20s Group: oracle- Parameters:
logMiningScnGapDetectionTimeIntervalMaxMs
- the value to set- Returns:
- the dsl builder
-
logMiningSessionMaxMs
default DebeziumOracleComponentBuilderFactory.DebeziumOracleComponentBuilder logMiningSessionMaxMs(long logMiningSessionMaxMs) The maximum number of milliseconds that a LogMiner session lives for before being restarted. Defaults to 0 (indefinite until a log switch occurs). The option is a: <code>long</code> type. Default: 0ms Group: oracle- Parameters:
logMiningSessionMaxMs
- the value to set- Returns:
- the dsl builder
-
logMiningSleepTimeDefaultMs
default DebeziumOracleComponentBuilderFactory.DebeziumOracleComponentBuilder logMiningSleepTimeDefaultMs(long logMiningSleepTimeDefaultMs) The amount of time that the connector will sleep after reading data from redo/archive logs and before starting reading data again. Value is in milliseconds. The option is a: <code>long</code> type. Default: 1s Group: oracle- Parameters:
logMiningSleepTimeDefaultMs
- the value to set- Returns:
- the dsl builder
-
logMiningSleepTimeIncrementMs
default DebeziumOracleComponentBuilderFactory.DebeziumOracleComponentBuilder logMiningSleepTimeIncrementMs(long logMiningSleepTimeIncrementMs) The maximum amount of time that the connector will use to tune the optimal sleep time when reading data from LogMiner. Value is in milliseconds. The option is a: <code>long</code> type. Default: 200ms Group: oracle- Parameters:
logMiningSleepTimeIncrementMs
- the value to set- Returns:
- the dsl builder
-
logMiningSleepTimeMaxMs
default DebeziumOracleComponentBuilderFactory.DebeziumOracleComponentBuilder logMiningSleepTimeMaxMs(long logMiningSleepTimeMaxMs) The maximum amount of time that the connector will sleep after reading data from redo/archive logs and before starting reading data again. Value is in milliseconds. The option is a: <code>long</code> type. Default: 3s Group: oracle- Parameters:
logMiningSleepTimeMaxMs
- the value to set- Returns:
- the dsl builder
-
logMiningSleepTimeMinMs
default DebeziumOracleComponentBuilderFactory.DebeziumOracleComponentBuilder logMiningSleepTimeMinMs(long logMiningSleepTimeMinMs) The minimum amount of time that the connector will sleep after reading data from redo/archive logs and before starting reading data again. Value is in milliseconds. The option is a: <code>long</code> type. Default: 0ms Group: oracle- Parameters:
logMiningSleepTimeMinMs
- the value to set- Returns:
- the dsl builder
-
logMiningStrategy
default DebeziumOracleComponentBuilderFactory.DebeziumOracleComponentBuilder logMiningStrategy(String logMiningStrategy) There are strategies: Online catalog with faster mining but no captured DDL. Another - with data dictionary loaded into REDO LOG files. The option is a: <code>java.lang.String</code> type. Default: redo_log_catalog Group: oracle- Parameters:
logMiningStrategy
- the value to set- Returns:
- the dsl builder
-
logMiningTransactionRetentionMs
default DebeziumOracleComponentBuilderFactory.DebeziumOracleComponentBuilder logMiningTransactionRetentionMs(long logMiningTransactionRetentionMs) Duration in milliseconds to keep long running transactions in transaction buffer between log mining sessions. By default, all transactions are retained. The option is a: <code>long</code> type. Default: 0ms Group: oracle- Parameters:
logMiningTransactionRetentionMs
- the value to set- Returns:
- the dsl builder
-
logMiningUsernameExcludeList
default DebeziumOracleComponentBuilderFactory.DebeziumOracleComponentBuilder logMiningUsernameExcludeList(String logMiningUsernameExcludeList) Comma separated list of usernames to exclude from LogMiner query. The option is a: <code>java.lang.String</code> type. Group: oracle- Parameters:
logMiningUsernameExcludeList
- the value to set- Returns:
- the dsl builder
-
logMiningUsernameIncludeList
default DebeziumOracleComponentBuilderFactory.DebeziumOracleComponentBuilder logMiningUsernameIncludeList(String logMiningUsernameIncludeList) Comma separated list of usernames to include from LogMiner query. The option is a: <code>java.lang.String</code> type. Group: oracle- Parameters:
logMiningUsernameIncludeList
- the value to set- Returns:
- the dsl builder
-
maxBatchSize
default DebeziumOracleComponentBuilderFactory.DebeziumOracleComponentBuilder maxBatchSize(int maxBatchSize) Maximum size of each batch of source records. Defaults to 2048. The option is a: <code>int</code> type. Default: 2048 Group: oracle- Parameters:
maxBatchSize
- the value to set- Returns:
- the dsl builder
-
maxQueueSize
default DebeziumOracleComponentBuilderFactory.DebeziumOracleComponentBuilder maxQueueSize(int maxQueueSize) Maximum size of the queue for change events read from the database log but not yet recorded or forwarded. Defaults to 8192, and should always be larger than the maximum batch size. The option is a: <code>int</code> type. Default: 8192 Group: oracle- Parameters:
maxQueueSize
- the value to set- Returns:
- the dsl builder
-
maxQueueSizeInBytes
default DebeziumOracleComponentBuilderFactory.DebeziumOracleComponentBuilder maxQueueSizeInBytes(long maxQueueSizeInBytes) Maximum size of the queue in bytes for change events read from the database log but not yet recorded or forwarded. Defaults to 0. Mean the feature is not enabled. The option is a: <code>long</code> type. Default: 0 Group: oracle- Parameters:
maxQueueSizeInBytes
- the value to set- Returns:
- the dsl builder
-
messageKeyColumns
default DebeziumOracleComponentBuilderFactory.DebeziumOracleComponentBuilder messageKeyColumns(String messageKeyColumns) A semicolon-separated list of expressions that match fully-qualified tables and column(s) to be used as message key. Each expression must match the pattern ':', where the table names could be defined as (DB_NAME.TABLE_NAME) or (SCHEMA_NAME.TABLE_NAME), depending on the specific connector, and the key columns are a comma-separated list of columns representing the custom key. For any table without an explicit key configuration the table's primary key column(s) will be used as message key. Example: dbserver1.inventory.orderlines:orderId,orderLineId;dbserver1.inventory.orders:id. The option is a: <code>java.lang.String</code> type. Group: oracle- Parameters:
messageKeyColumns
- the value to set- Returns:
- the dsl builder
-
notificationEnabledChannels
default DebeziumOracleComponentBuilderFactory.DebeziumOracleComponentBuilder notificationEnabledChannels(String notificationEnabledChannels) List of notification channels names that are enabled. The option is a: <code>java.lang.String</code> type. Group: oracle- Parameters:
notificationEnabledChannels
- the value to set- Returns:
- the dsl builder
-
notificationSinkTopicName
default DebeziumOracleComponentBuilderFactory.DebeziumOracleComponentBuilder 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: <code>java.lang.String</code> type. Group: oracle- Parameters:
notificationSinkTopicName
- the value to set- Returns:
- the dsl builder
-
pollIntervalMs
default DebeziumOracleComponentBuilderFactory.DebeziumOracleComponentBuilder pollIntervalMs(long pollIntervalMs) Time to wait for new change events to appear after receiving no events, given in milliseconds. Defaults to 500 ms. The option is a: <code>long</code> type. Default: 500ms Group: oracle- Parameters:
pollIntervalMs
- the value to set- Returns:
- the dsl builder
-
provideTransactionMetadata
default DebeziumOracleComponentBuilderFactory.DebeziumOracleComponentBuilder provideTransactionMetadata(boolean provideTransactionMetadata) Enables transaction metadata extraction together with event counting. The option is a: <code>boolean</code> type. Default: false Group: oracle- Parameters:
provideTransactionMetadata
- the value to set- Returns:
- the dsl builder
-
queryFetchSize
default DebeziumOracleComponentBuilderFactory.DebeziumOracleComponentBuilder queryFetchSize(int queryFetchSize) The maximum number of records that should be loaded into memory while streaming. A value of '0' uses the default JDBC fetch size, defaults to '2000'. The option is a: <code>int</code> type. Default: 10000 Group: oracle- Parameters:
queryFetchSize
- the value to set- Returns:
- the dsl builder
-
racNodes
default DebeziumOracleComponentBuilderFactory.DebeziumOracleComponentBuilder racNodes(String racNodes) A comma-separated list of RAC node hostnames or ip addresses. The option is a: <code>java.lang.String</code> type. Group: oracle- Parameters:
racNodes
- the value to set- Returns:
- the dsl builder
-
retriableRestartConnectorWaitMs
default DebeziumOracleComponentBuilderFactory.DebeziumOracleComponentBuilder retriableRestartConnectorWaitMs(long retriableRestartConnectorWaitMs) Time to wait before restarting connector after retriable exception occurs. Defaults to 10000ms. The option is a: <code>long</code> type. Default: 10s Group: oracle- Parameters:
retriableRestartConnectorWaitMs
- the value to set- Returns:
- the dsl builder
-
schemaHistoryInternal
default DebeziumOracleComponentBuilderFactory.DebeziumOracleComponentBuilder 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: <code>java.lang.String</code> type. Default: io.debezium.storage.kafka.history.KafkaSchemaHistory Group: oracle- Parameters:
schemaHistoryInternal
- the value to set- Returns:
- the dsl builder
-
schemaHistoryInternalFileFilename
default DebeziumOracleComponentBuilderFactory.DebeziumOracleComponentBuilder schemaHistoryInternalFileFilename(String schemaHistoryInternalFileFilename) The path to the file that will be used to record the database schema history. The option is a: <code>java.lang.String</code> type. Group: oracle- Parameters:
schemaHistoryInternalFileFilename
- the value to set- Returns:
- the dsl builder
-
schemaHistoryInternalSkipUnparseableDdl
default DebeziumOracleComponentBuilderFactory.DebeziumOracleComponentBuilder 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: <code>boolean</code> type. Default: false Group: oracle- Parameters:
schemaHistoryInternalSkipUnparseableDdl
- the value to set- Returns:
- the dsl builder
-
schemaHistoryInternalStoreOnlyCapturedDatabasesDdl
default DebeziumOracleComponentBuilderFactory.DebeziumOracleComponentBuilder 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: <code>boolean</code> type. Default: false Group: oracle- Parameters:
schemaHistoryInternalStoreOnlyCapturedDatabasesDdl
- the value to set- Returns:
- the dsl builder
-
schemaHistoryInternalStoreOnlyCapturedTablesDdl
default DebeziumOracleComponentBuilderFactory.DebeziumOracleComponentBuilder 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: <code>boolean</code> type. Default: false Group: oracle- Parameters:
schemaHistoryInternalStoreOnlyCapturedTablesDdl
- the value to set- Returns:
- the dsl builder
-
schemaNameAdjustmentMode
default DebeziumOracleComponentBuilderFactory.DebeziumOracleComponentBuilder 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: <code>java.lang.String</code> type. Default: none Group: oracle- Parameters:
schemaNameAdjustmentMode
- the value to set- Returns:
- the dsl builder
-
signalDataCollection
default DebeziumOracleComponentBuilderFactory.DebeziumOracleComponentBuilder signalDataCollection(String signalDataCollection) The name of the data collection that is used to send signals/commands to Debezium. Signaling is disabled when not set. The option is a: <code>java.lang.String</code> type. Group: oracle- Parameters:
signalDataCollection
- the value to set- Returns:
- the dsl builder
-
signalEnabledChannels
default DebeziumOracleComponentBuilderFactory.DebeziumOracleComponentBuilder signalEnabledChannels(String signalEnabledChannels) List of channels names that are enabled. Source channel is enabled by default. The option is a: <code>java.lang.String</code> type. Default: source Group: oracle- Parameters:
signalEnabledChannels
- the value to set- Returns:
- the dsl builder
-
signalPollIntervalMs
default DebeziumOracleComponentBuilderFactory.DebeziumOracleComponentBuilder signalPollIntervalMs(long signalPollIntervalMs) Interval for looking for new signals in registered channels, given in milliseconds. Defaults to 5 seconds. The option is a: <code>long</code> type. Default: 5s Group: oracle- Parameters:
signalPollIntervalMs
- the value to set- Returns:
- the dsl builder
-
skippedOperations
default DebeziumOracleComponentBuilderFactory.DebeziumOracleComponentBuilder 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: <code>java.lang.String</code> type. Default: t Group: oracle- Parameters:
skippedOperations
- the value to set- Returns:
- the dsl builder
-
snapshotDelayMs
default DebeziumOracleComponentBuilderFactory.DebeziumOracleComponentBuilder snapshotDelayMs(long snapshotDelayMs) A delay period before a snapshot will begin, given in milliseconds. Defaults to 0 ms. The option is a: <code>long</code> type. Default: 0ms Group: oracle- Parameters:
snapshotDelayMs
- the value to set- Returns:
- the dsl builder
-
snapshotEnhancePredicateScn
default DebeziumOracleComponentBuilderFactory.DebeziumOracleComponentBuilder snapshotEnhancePredicateScn(String snapshotEnhancePredicateScn) A token to replace on snapshot predicate template. The option is a: <code>java.lang.String</code> type. Group: oracle- Parameters:
snapshotEnhancePredicateScn
- the value to set- Returns:
- the dsl builder
-
snapshotFetchSize
default DebeziumOracleComponentBuilderFactory.DebeziumOracleComponentBuilder snapshotFetchSize(int snapshotFetchSize) The maximum number of records that should be loaded into memory while performing a snapshot. The option is a: <code>int</code> type. Group: oracle- Parameters:
snapshotFetchSize
- the value to set- Returns:
- the dsl builder
-
snapshotIncludeCollectionList
default DebeziumOracleComponentBuilderFactory.DebeziumOracleComponentBuilder snapshotIncludeCollectionList(String snapshotIncludeCollectionList) This setting must be set to specify a list of tables/collections whose snapshot must be taken on creating or restarting the connector. The option is a: <code>java.lang.String</code> type. Group: oracle- Parameters:
snapshotIncludeCollectionList
- the value to set- Returns:
- the dsl builder
-
snapshotLockingMode
default DebeziumOracleComponentBuilderFactory.DebeziumOracleComponentBuilder snapshotLockingMode(String snapshotLockingMode) Controls how the connector holds locks on tables while performing the schema snapshot. The default is 'shared', which means the connector will hold a table lock that prevents exclusive table access for just the initial portion of the snapshot while the database schemas and other metadata are being read. The remaining work in a snapshot involves selecting all rows from each table, and this is done using a flashback query that requires no locks. However, in some cases it may be desirable to avoid locks entirely which can be done by specifying 'none'. This mode is only safe to use if no schema changes are happening while the snapshot is taken. The option is a: <code>java.lang.String</code> type. Default: shared Group: oracle- Parameters:
snapshotLockingMode
- the value to set- Returns:
- the dsl builder
-
snapshotLockTimeoutMs
default DebeziumOracleComponentBuilderFactory.DebeziumOracleComponentBuilder snapshotLockTimeoutMs(long snapshotLockTimeoutMs) The maximum number of millis to wait for table locks at the beginning of a snapshot. If locks cannot be acquired in this time frame, the snapshot will be aborted. Defaults to 10 seconds. The option is a: <code>long</code> type. Default: 10s Group: oracle- Parameters:
snapshotLockTimeoutMs
- the value to set- Returns:
- the dsl builder
-
snapshotMaxThreads
default DebeziumOracleComponentBuilderFactory.DebeziumOracleComponentBuilder snapshotMaxThreads(int snapshotMaxThreads) The maximum number of threads used to perform the snapshot. Defaults to 1. The option is a: <code>int</code> type. Default: 1 Group: oracle- Parameters:
snapshotMaxThreads
- the value to set- Returns:
- the dsl builder
-
snapshotMode
default DebeziumOracleComponentBuilderFactory.DebeziumOracleComponentBuilder snapshotMode(String snapshotMode) The criteria for running a snapshot upon startup of the connector. Select one of the following snapshot options: 'always': The connector runs a snapshot every time that it starts. After the snapshot completes, the connector begins to stream changes from the redo logs.; '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 redo logs. '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 redo logs.; '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 redo logs.; 'schema_only_recovery': The connector performs a snapshot that captures only the database schema history. The connector then transitions to streaming from the redo logs. Use this setting to restore a corrupted or lost database schema history topic. Do not use if the database schema was modified after the connector stopped. The option is a: <code>java.lang.String</code> type. Default: initial Group: oracle- Parameters:
snapshotMode
- the value to set- Returns:
- the dsl builder
-
snapshotSelectStatementOverrides
default DebeziumOracleComponentBuilderFactory.DebeziumOracleComponentBuilder 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: <code>java.lang.String</code> type. Group: oracle- Parameters:
snapshotSelectStatementOverrides
- the value to set- Returns:
- the dsl builder
-
snapshotTablesOrderByRowCount
default DebeziumOracleComponentBuilderFactory.DebeziumOracleComponentBuilder 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: <code>java.lang.String</code> type. Default: disabled Group: oracle- Parameters:
snapshotTablesOrderByRowCount
- the value to set- Returns:
- the dsl builder
-
sourceinfoStructMaker
default DebeziumOracleComponentBuilderFactory.DebeziumOracleComponentBuilder sourceinfoStructMaker(String sourceinfoStructMaker) The name of the SourceInfoStructMaker class that returns SourceInfo schema and struct. The option is a: <code>java.lang.String</code> type. Default: io.debezium.connector.oracle.OracleSourceInfoStructMaker Group: oracle- Parameters:
sourceinfoStructMaker
- the value to set- Returns:
- the dsl builder
-
tableExcludeList
default DebeziumOracleComponentBuilderFactory.DebeziumOracleComponentBuilder tableExcludeList(String tableExcludeList) A comma-separated list of regular expressions that match the fully-qualified names of tables to be excluded from monitoring. The option is a: <code>java.lang.String</code> type. Group: oracle- Parameters:
tableExcludeList
- the value to set- Returns:
- the dsl builder
-
tableIncludeList
default DebeziumOracleComponentBuilderFactory.DebeziumOracleComponentBuilder tableIncludeList(String tableIncludeList) The tables for which changes are to be captured. The option is a: <code>java.lang.String</code> type. Group: oracle- Parameters:
tableIncludeList
- the value to set- Returns:
- the dsl builder
-
timePrecisionMode
default DebeziumOracleComponentBuilderFactory.DebeziumOracleComponentBuilder timePrecisionMode(String timePrecisionMode) Time, date, and timestamps can be represented with different kinds of precisions, including: 'adaptive' (the default) bases the precision of time, date, and timestamp values on the database column's precision; 'adaptive_time_microseconds' like 'adaptive' mode, but TIME fields always use microseconds precision; 'connect' always represents time, date, and timestamp values using Kafka Connect's built-in representations for Time, Date, and Timestamp, which uses millisecond precision regardless of the database columns' precision. The option is a: <code>java.lang.String</code> type. Default: adaptive Group: oracle- Parameters:
timePrecisionMode
- the value to set- Returns:
- the dsl builder
-
tombstonesOnDelete
default DebeziumOracleComponentBuilderFactory.DebeziumOracleComponentBuilder 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: <code>boolean</code> type. Default: false Group: oracle- Parameters:
tombstonesOnDelete
- the value to set- Returns:
- the dsl builder
-
topicNamingStrategy
default DebeziumOracleComponentBuilderFactory.DebeziumOracleComponentBuilder 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: <code>java.lang.String</code> type. Default: io.debezium.schema.SchemaTopicNamingStrategy Group: oracle- Parameters:
topicNamingStrategy
- the value to set- Returns:
- the dsl builder
-
topicPrefix
default DebeziumOracleComponentBuilderFactory.DebeziumOracleComponentBuilder 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: <code>java.lang.String</code> type. Group: oracle- Parameters:
topicPrefix
- the value to set- Returns:
- the dsl builder
-