Interface DebeziumOracleEndpointBuilderFactory.DebeziumOracleEndpointBuilder

  • All Superinterfaces:
    org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver
    Enclosing interface:
    DebeziumOracleEndpointBuilderFactory

    public static interface DebeziumOracleEndpointBuilderFactory.DebeziumOracleEndpointBuilder
    extends org.apache.camel.builder.EndpointConsumerBuilder
    Builder for endpoint for the Debezium Oracle Connector component.
    • Method Detail

      • additionalProperties

        default DebeziumOracleEndpointBuilderFactory.DebeziumOracleEndpointBuilder additionalProperties​(String key,
                                                                                                        Object value)
        Additional properties for debezium components in case they can't be set directly on the camel configurations (e.g: setting Kafka Connect properties needed by Debezium engine, for example setting KafkaOffsetBackingStore), the properties have to be prefixed with additionalProperties.. E.g: additionalProperties.transactional.id=12345&amp;additionalProperties.schema.registry.url=http://localhost:8811/avro. The option is a: <code>java.util.Map&lt;java.lang.String, java.lang.Object&gt;</code> type. The option is multivalued, and you can use the additionalProperties(String, Object) method to add a value (call the method multiple times to set more values). Group: common
        Parameters:
        key - the option key
        value - the option value
        Returns:
        the dsl builder
      • additionalProperties

        default DebeziumOracleEndpointBuilderFactory.DebeziumOracleEndpointBuilder additionalProperties​(Map values)
        Additional properties for debezium components in case they can't be set directly on the camel configurations (e.g: setting Kafka Connect properties needed by Debezium engine, for example setting KafkaOffsetBackingStore), the properties have to be prefixed with additionalProperties.. E.g: additionalProperties.transactional.id=12345&amp;additionalProperties.schema.registry.url=http://localhost:8811/avro. The option is a: <code>java.util.Map&lt;java.lang.String, java.lang.Object&gt;</code> type. The option is multivalued, and you can use the additionalProperties(String, Object) method to add a value (call the method multiple times to set more values). Group: common
        Parameters:
        values - the values
        Returns:
        the dsl builder
      • internalKeyConverter

        default DebeziumOracleEndpointBuilderFactory.DebeziumOracleEndpointBuilder 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 DebeziumOracleEndpointBuilderFactory.DebeziumOracleEndpointBuilder 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 DebeziumOracleEndpointBuilderFactory.DebeziumOracleEndpointBuilder 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 DebeziumOracleEndpointBuilderFactory.DebeziumOracleEndpointBuilder 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
      • offsetCommitTimeoutMs

        default DebeziumOracleEndpointBuilderFactory.DebeziumOracleEndpointBuilder offsetCommitTimeoutMs​(String offsetCommitTimeoutMs)
        Maximum number of milliseconds to wait for records to flush and partition offset data to be committed to offset storage before cancelling the process and restoring the offset data to be committed in a future attempt. The default is 5 seconds. The option will be converted to a <code>long</code> type. Default: 5000 Group: consumer
        Parameters:
        offsetCommitTimeoutMs - the value to set
        Returns:
        the dsl builder
      • offsetFlushIntervalMs

        default DebeziumOracleEndpointBuilderFactory.DebeziumOracleEndpointBuilder 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
      • offsetFlushIntervalMs

        default DebeziumOracleEndpointBuilderFactory.DebeziumOracleEndpointBuilder offsetFlushIntervalMs​(String offsetFlushIntervalMs)
        Interval at which to try committing offsets. The default is 1 minute. The option will be converted to a <code>long</code> type. Default: 60000 Group: consumer
        Parameters:
        offsetFlushIntervalMs - the value to set
        Returns:
        the dsl builder
      • offsetStorage

        default DebeziumOracleEndpointBuilderFactory.DebeziumOracleEndpointBuilder 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 DebeziumOracleEndpointBuilderFactory.DebeziumOracleEndpointBuilder 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 DebeziumOracleEndpointBuilderFactory.DebeziumOracleEndpointBuilder 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
      • offsetStoragePartitions

        default DebeziumOracleEndpointBuilderFactory.DebeziumOracleEndpointBuilder offsetStoragePartitions​(String offsetStoragePartitions)
        The number of partitions used when creating the offset storage topic. Required when offset.storage is set to the 'KafkaOffsetBackingStore'. The option will be converted to a <code>int</code> type. Group: consumer
        Parameters:
        offsetStoragePartitions - the value to set
        Returns:
        the dsl builder
      • offsetStorageReplicationFactor

        default DebeziumOracleEndpointBuilderFactory.DebeziumOracleEndpointBuilder 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
      • offsetStorageReplicationFactor

        default DebeziumOracleEndpointBuilderFactory.DebeziumOracleEndpointBuilder offsetStorageReplicationFactor​(String offsetStorageReplicationFactor)
        Replication factor used when creating the offset storage topic. Required when offset.storage is set to the KafkaOffsetBackingStore. The option will be converted to a <code>int</code> type. Group: consumer
        Parameters:
        offsetStorageReplicationFactor - the value to set
        Returns:
        the dsl builder
      • offsetStorageTopic

        default DebeziumOracleEndpointBuilderFactory.DebeziumOracleEndpointBuilder 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
      • binaryHandlingMode

        default DebeziumOracleEndpointBuilderFactory.DebeziumOracleEndpointBuilder binaryHandlingMode​(String binaryHandlingMode)
        Specify how binary (blob, binary, etc.) columns should be represented in change events, including:'bytes' represents binary data as byte array (default)'base64' represents binary data as base64-encoded string'hex' represents binary data as hex-encoded (base16) string. The option is a: <code>java.lang.String</code> type. Default: bytes Group: oracle
        Parameters:
        binaryHandlingMode - the value to set
        Returns:
        the dsl builder
      • columnBlacklist

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

        default DebeziumOracleEndpointBuilderFactory.DebeziumOracleEndpointBuilder 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
      • columnWhitelist

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

        default DebeziumOracleEndpointBuilderFactory.DebeziumOracleEndpointBuilder 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 DebeziumOracleEndpointBuilderFactory.DebeziumOracleEndpointBuilder 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
      • databaseHistory

        default DebeziumOracleEndpointBuilderFactory.DebeziumOracleEndpointBuilder databaseHistory​(String databaseHistory)
        The name of the DatabaseHistory class that should be used to store and recover database schema changes. The configuration properties for the history are prefixed with the 'database.history.' string. The option is a: <code>java.lang.String</code> type. Default: io.debezium.relational.history.KafkaDatabaseHistory Group: oracle
        Parameters:
        databaseHistory - the value to set
        Returns:
        the dsl builder
      • databaseHistoryFileFilename

        default DebeziumOracleEndpointBuilderFactory.DebeziumOracleEndpointBuilder databaseHistoryFileFilename​(String databaseHistoryFileFilename)
        The path to the file that will be used to record the database history. The option is a: <code>java.lang.String</code> type. Group: oracle
        Parameters:
        databaseHistoryFileFilename - the value to set
        Returns:
        the dsl builder
      • databaseHistoryKafkaBootstrapServers

        default DebeziumOracleEndpointBuilderFactory.DebeziumOracleEndpointBuilder databaseHistoryKafkaBootstrapServers​(String databaseHistoryKafkaBootstrapServers)
        A list of host/port pairs that the connector will use for establishing the initial connection to the Kafka cluster for retrieving database schema history previously stored by the connector. This should point to the same Kafka cluster used by the Kafka Connect process. The option is a: <code>java.lang.String</code> type. Group: oracle
        Parameters:
        databaseHistoryKafkaBootstrapServers - the value to set
        Returns:
        the dsl builder
      • databaseHistoryKafkaQueryTimeoutMs

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

        default DebeziumOracleEndpointBuilderFactory.DebeziumOracleEndpointBuilder databaseHistoryKafkaQueryTimeoutMs​(String databaseHistoryKafkaQueryTimeoutMs)
        The number of milliseconds to wait while fetching cluster information using Kafka admin client. The option will be converted to a <code>long</code> type. Default: 3s Group: oracle
        Parameters:
        databaseHistoryKafkaQueryTimeoutMs - the value to set
        Returns:
        the dsl builder
      • databaseHistoryKafkaRecoveryAttempts

        default DebeziumOracleEndpointBuilderFactory.DebeziumOracleEndpointBuilder databaseHistoryKafkaRecoveryAttempts​(int databaseHistoryKafkaRecoveryAttempts)
        The number of attempts in a row that no data are returned from Kafka before recover completes. The maximum amount of time to wait after receiving no data is (recovery.attempts) x (recovery.poll.interval.ms). The option is a: <code>int</code> type. Default: 100 Group: oracle
        Parameters:
        databaseHistoryKafkaRecoveryAttempts - the value to set
        Returns:
        the dsl builder
      • databaseHistoryKafkaRecoveryAttempts

        default DebeziumOracleEndpointBuilderFactory.DebeziumOracleEndpointBuilder databaseHistoryKafkaRecoveryAttempts​(String databaseHistoryKafkaRecoveryAttempts)
        The number of attempts in a row that no data are returned from Kafka before recover completes. The maximum amount of time to wait after receiving no data is (recovery.attempts) x (recovery.poll.interval.ms). The option will be converted to a <code>int</code> type. Default: 100 Group: oracle
        Parameters:
        databaseHistoryKafkaRecoveryAttempts - the value to set
        Returns:
        the dsl builder
      • databaseHistoryKafkaRecoveryPollIntervalMs

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

        default DebeziumOracleEndpointBuilderFactory.DebeziumOracleEndpointBuilder databaseHistoryKafkaRecoveryPollIntervalMs​(String databaseHistoryKafkaRecoveryPollIntervalMs)
        The number of milliseconds to wait while polling for persisted data during recovery. The option will be converted to a <code>int</code> type. Default: 100ms Group: oracle
        Parameters:
        databaseHistoryKafkaRecoveryPollIntervalMs - the value to set
        Returns:
        the dsl builder
      • databaseHistoryKafkaTopic

        default DebeziumOracleEndpointBuilderFactory.DebeziumOracleEndpointBuilder databaseHistoryKafkaTopic​(String databaseHistoryKafkaTopic)
        The name of the topic for the database schema history. The option is a: <code>java.lang.String</code> type. Group: oracle
        Parameters:
        databaseHistoryKafkaTopic - the value to set
        Returns:
        the dsl builder
      • databaseHistorySkipUnparseableDdl

        default DebeziumOracleEndpointBuilderFactory.DebeziumOracleEndpointBuilder databaseHistorySkipUnparseableDdl​(boolean databaseHistorySkipUnparseableDdl)
        Controls the action Debezium will take when it meets a DDL statement in binlog, that it cannot parse.By default the connector will stop operating but by changing the setting it can ignore the statements which it cannot parse. If skipping is enabled then Debezium can miss metadata changes. The option is a: <code>boolean</code> type. Default: false Group: oracle
        Parameters:
        databaseHistorySkipUnparseableDdl - the value to set
        Returns:
        the dsl builder
      • databaseHistorySkipUnparseableDdl

        default DebeziumOracleEndpointBuilderFactory.DebeziumOracleEndpointBuilder databaseHistorySkipUnparseableDdl​(String databaseHistorySkipUnparseableDdl)
        Controls the action Debezium will take when it meets a DDL statement in binlog, that it cannot parse.By default the connector will stop operating but by changing the setting it can ignore the statements which it cannot parse. If skipping is enabled then Debezium can miss metadata changes. The option will be converted to a <code>boolean</code> type. Default: false Group: oracle
        Parameters:
        databaseHistorySkipUnparseableDdl - the value to set
        Returns:
        the dsl builder
      • databaseHistoryStoreOnlyCapturedTablesDdl

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

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

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

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

        default DebeziumOracleEndpointBuilderFactory.DebeziumOracleEndpointBuilder 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. Required: true Group: oracle
        Parameters:
        databasePassword - the value to set
        Returns:
        the dsl builder
      • databasePdbName

        default DebeziumOracleEndpointBuilderFactory.DebeziumOracleEndpointBuilder 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
      • databaseServerName

        default DebeziumOracleEndpointBuilderFactory.DebeziumOracleEndpointBuilder databaseServerName​(String databaseServerName)
        Unique name that identifies the database server and all recorded offsets, and that is used as a prefix for all schemas and topics. Each distinct installation should have a separate namespace and be monitored by at most one Debezium connector. The option is a: <code>java.lang.String</code> type. Required: true Group: oracle
        Parameters:
        databaseServerName - the value to set
        Returns:
        the dsl builder
      • databaseUrl

        default DebeziumOracleEndpointBuilderFactory.DebeziumOracleEndpointBuilder 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
      • datatypePropagateSourceType

        default DebeziumOracleEndpointBuilderFactory.DebeziumOracleEndpointBuilder 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 DebeziumOracleEndpointBuilderFactory.DebeziumOracleEndpointBuilder 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
      • eventProcessingFailureHandlingMode

        default DebeziumOracleEndpointBuilderFactory.DebeziumOracleEndpointBuilder 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
      • heartbeatIntervalMs

        default DebeziumOracleEndpointBuilderFactory.DebeziumOracleEndpointBuilder 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
      • heartbeatIntervalMs

        default DebeziumOracleEndpointBuilderFactory.DebeziumOracleEndpointBuilder heartbeatIntervalMs​(String heartbeatIntervalMs)
        Length of an interval in milli-seconds in in which the connector periodically sends heartbeat messages to a heartbeat topic. Use 0 to disable heartbeat messages. Disabled by default. The option will be converted to a <code>int</code> type. Default: 0ms Group: oracle
        Parameters:
        heartbeatIntervalMs - the value to set
        Returns:
        the dsl builder
      • heartbeatTopicsPrefix

        default DebeziumOracleEndpointBuilderFactory.DebeziumOracleEndpointBuilder 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 DebeziumOracleEndpointBuilderFactory.DebeziumOracleEndpointBuilder includeSchemaChanges​(boolean includeSchemaChanges)
        Whether the connector should publish changes in the database schema to a Kafka topic with the same name as the database server ID. Each schema change will be recorded using a key that contains the database name and whose value include logical description of the new schema and optionally the DDL statement(s).The default is 'true'. This is independent of how the connector internally records database history. The option is a: <code>boolean</code> type. Default: true Group: oracle
        Parameters:
        includeSchemaChanges - the value to set
        Returns:
        the dsl builder
      • includeSchemaChanges

        default DebeziumOracleEndpointBuilderFactory.DebeziumOracleEndpointBuilder includeSchemaChanges​(String includeSchemaChanges)
        Whether the connector should publish changes in the database schema to a Kafka topic with the same name as the database server ID. Each schema change will be recorded using a key that contains the database name and whose value include logical description of the new schema and optionally the DDL statement(s).The default is 'true'. This is independent of how the connector internally records database history. The option will be converted to a <code>boolean</code> type. Default: true Group: oracle
        Parameters:
        includeSchemaChanges - the value to set
        Returns:
        the dsl builder
      • includeSchemaComments

        default DebeziumOracleEndpointBuilderFactory.DebeziumOracleEndpointBuilder 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
      • includeSchemaComments

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

        default DebeziumOracleEndpointBuilderFactory.DebeziumOracleEndpointBuilder 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 DebeziumOracleEndpointBuilderFactory.DebeziumOracleEndpointBuilder 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
      • lobEnabled

        default DebeziumOracleEndpointBuilderFactory.DebeziumOracleEndpointBuilder lobEnabled​(String 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 will be converted to a <code>boolean</code> type. Default: false Group: oracle
        Parameters:
        lobEnabled - the value to set
        Returns:
        the dsl builder
      • logMiningArchiveDestinationName

        default DebeziumOracleEndpointBuilderFactory.DebeziumOracleEndpointBuilder 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 DebeziumOracleEndpointBuilderFactory.DebeziumOracleEndpointBuilder 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
      • logMiningArchiveLogHours

        default DebeziumOracleEndpointBuilderFactory.DebeziumOracleEndpointBuilder logMiningArchiveLogHours​(String logMiningArchiveLogHours)
        The number of hours in the past from SYSDATE to mine archive logs. Using 0 mines all available archive logs. The option will be converted to a <code>long</code> type. Default: 0 Group: oracle
        Parameters:
        logMiningArchiveLogHours - the value to set
        Returns:
        the dsl builder
      • logMiningArchiveLogOnlyMode

        default DebeziumOracleEndpointBuilderFactory.DebeziumOracleEndpointBuilder 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
      • logMiningArchiveLogOnlyMode

        default DebeziumOracleEndpointBuilderFactory.DebeziumOracleEndpointBuilder logMiningArchiveLogOnlyMode​(String 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 will be converted to a <code>boolean</code> type. Default: false Group: oracle
        Parameters:
        logMiningArchiveLogOnlyMode - the value to set
        Returns:
        the dsl builder
      • logMiningArchiveLogOnlyScnPollIntervalMs

        default DebeziumOracleEndpointBuilderFactory.DebeziumOracleEndpointBuilder 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
      • logMiningArchiveLogOnlyScnPollIntervalMs

        default DebeziumOracleEndpointBuilderFactory.DebeziumOracleEndpointBuilder logMiningArchiveLogOnlyScnPollIntervalMs​(String logMiningArchiveLogOnlyScnPollIntervalMs)
        The interval in milliseconds to wait between polls checking to see if the SCN is in the archive logs. The option will be converted to a <code>long</code> type. Default: 10s Group: oracle
        Parameters:
        logMiningArchiveLogOnlyScnPollIntervalMs - the value to set
        Returns:
        the dsl builder
      • logMiningBatchSizeDefault

        default DebeziumOracleEndpointBuilderFactory.DebeziumOracleEndpointBuilder 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
      • logMiningBatchSizeDefault

        default DebeziumOracleEndpointBuilderFactory.DebeziumOracleEndpointBuilder logMiningBatchSizeDefault​(String logMiningBatchSizeDefault)
        The starting SCN interval size that the connector will use for reading data from redo/archive logs. The option will be converted to a <code>long</code> type. Default: 20000 Group: oracle
        Parameters:
        logMiningBatchSizeDefault - the value to set
        Returns:
        the dsl builder
      • logMiningBatchSizeMax

        default DebeziumOracleEndpointBuilderFactory.DebeziumOracleEndpointBuilder 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
      • logMiningBatchSizeMax

        default DebeziumOracleEndpointBuilderFactory.DebeziumOracleEndpointBuilder logMiningBatchSizeMax​(String logMiningBatchSizeMax)
        The maximum SCN interval size that this connector will use when reading from redo/archive logs. The option will be converted to a <code>long</code> type. Default: 100000 Group: oracle
        Parameters:
        logMiningBatchSizeMax - the value to set
        Returns:
        the dsl builder
      • logMiningBatchSizeMin

        default DebeziumOracleEndpointBuilderFactory.DebeziumOracleEndpointBuilder 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
      • logMiningBatchSizeMin

        default DebeziumOracleEndpointBuilderFactory.DebeziumOracleEndpointBuilder logMiningBatchSizeMin​(String 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 will be converted to a <code>long</code> type. Default: 1000 Group: oracle
        Parameters:
        logMiningBatchSizeMin - the value to set
        Returns:
        the dsl builder
      • logMiningBufferDropOnStop

        default DebeziumOracleEndpointBuilderFactory.DebeziumOracleEndpointBuilder 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
      • logMiningBufferDropOnStop

        default DebeziumOracleEndpointBuilderFactory.DebeziumOracleEndpointBuilder logMiningBufferDropOnStop​(String 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 will be converted to a <code>boolean</code> type. Default: false Group: oracle
        Parameters:
        logMiningBufferDropOnStop - the value to set
        Returns:
        the dsl builder
      • logMiningBufferInfinispanCacheEvents

        default DebeziumOracleEndpointBuilderFactory.DebeziumOracleEndpointBuilder 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 DebeziumOracleEndpointBuilderFactory.DebeziumOracleEndpointBuilder 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 DebeziumOracleEndpointBuilderFactory.DebeziumOracleEndpointBuilder 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 DebeziumOracleEndpointBuilderFactory.DebeziumOracleEndpointBuilder 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
      • logMiningBufferType

        default DebeziumOracleEndpointBuilderFactory.DebeziumOracleEndpointBuilder 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
      • logMiningScnGapDetectionGapSizeMin

        default DebeziumOracleEndpointBuilderFactory.DebeziumOracleEndpointBuilder 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
      • logMiningScnGapDetectionGapSizeMin

        default DebeziumOracleEndpointBuilderFactory.DebeziumOracleEndpointBuilder logMiningScnGapDetectionGapSizeMin​(String 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 will be converted to a <code>long</code> type. Default: 1000000 Group: oracle
        Parameters:
        logMiningScnGapDetectionGapSizeMin - the value to set
        Returns:
        the dsl builder
      • logMiningScnGapDetectionTimeIntervalMaxMs

        default DebeziumOracleEndpointBuilderFactory.DebeziumOracleEndpointBuilder 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
      • logMiningScnGapDetectionTimeIntervalMaxMs

        default DebeziumOracleEndpointBuilderFactory.DebeziumOracleEndpointBuilder logMiningScnGapDetectionTimeIntervalMaxMs​(String 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 will be converted to a <code>long</code> type. Default: 20s Group: oracle
        Parameters:
        logMiningScnGapDetectionTimeIntervalMaxMs - the value to set
        Returns:
        the dsl builder
      • logMiningSessionMaxMs

        default DebeziumOracleEndpointBuilderFactory.DebeziumOracleEndpointBuilder 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
      • logMiningSessionMaxMs

        default DebeziumOracleEndpointBuilderFactory.DebeziumOracleEndpointBuilder logMiningSessionMaxMs​(String 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 will be converted to a <code>long</code> type. Default: 0ms Group: oracle
        Parameters:
        logMiningSessionMaxMs - the value to set
        Returns:
        the dsl builder
      • logMiningSleepTimeDefaultMs

        default DebeziumOracleEndpointBuilderFactory.DebeziumOracleEndpointBuilder 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
      • logMiningSleepTimeDefaultMs

        default DebeziumOracleEndpointBuilderFactory.DebeziumOracleEndpointBuilder logMiningSleepTimeDefaultMs​(String 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 will be converted to a <code>long</code> type. Default: 1s Group: oracle
        Parameters:
        logMiningSleepTimeDefaultMs - the value to set
        Returns:
        the dsl builder
      • logMiningSleepTimeIncrementMs

        default DebeziumOracleEndpointBuilderFactory.DebeziumOracleEndpointBuilder 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
      • logMiningSleepTimeIncrementMs

        default DebeziumOracleEndpointBuilderFactory.DebeziumOracleEndpointBuilder logMiningSleepTimeIncrementMs​(String 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 will be converted to a <code>long</code> type. Default: 200ms Group: oracle
        Parameters:
        logMiningSleepTimeIncrementMs - the value to set
        Returns:
        the dsl builder
      • logMiningSleepTimeMaxMs

        default DebeziumOracleEndpointBuilderFactory.DebeziumOracleEndpointBuilder 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
      • logMiningSleepTimeMaxMs

        default DebeziumOracleEndpointBuilderFactory.DebeziumOracleEndpointBuilder logMiningSleepTimeMaxMs​(String 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 will be converted to a <code>long</code> type. Default: 3s Group: oracle
        Parameters:
        logMiningSleepTimeMaxMs - the value to set
        Returns:
        the dsl builder
      • logMiningSleepTimeMinMs

        default DebeziumOracleEndpointBuilderFactory.DebeziumOracleEndpointBuilder 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
      • logMiningSleepTimeMinMs

        default DebeziumOracleEndpointBuilderFactory.DebeziumOracleEndpointBuilder logMiningSleepTimeMinMs​(String 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 will be converted to a <code>long</code> type. Default: 0ms Group: oracle
        Parameters:
        logMiningSleepTimeMinMs - the value to set
        Returns:
        the dsl builder
      • logMiningStrategy

        default DebeziumOracleEndpointBuilderFactory.DebeziumOracleEndpointBuilder 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
      • logMiningTransactionRetentionHours

        default DebeziumOracleEndpointBuilderFactory.DebeziumOracleEndpointBuilder logMiningTransactionRetentionHours​(long logMiningTransactionRetentionHours)
        Hours 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: 0 Group: oracle
        Parameters:
        logMiningTransactionRetentionHours - the value to set
        Returns:
        the dsl builder
      • logMiningTransactionRetentionHours

        default DebeziumOracleEndpointBuilderFactory.DebeziumOracleEndpointBuilder logMiningTransactionRetentionHours​(String logMiningTransactionRetentionHours)
        Hours to keep long running transactions in transaction buffer between log mining sessions. By default, all transactions are retained. The option will be converted to a <code>long</code> type. Default: 0 Group: oracle
        Parameters:
        logMiningTransactionRetentionHours - the value to set
        Returns:
        the dsl builder
      • logMiningUsernameExcludeList

        default DebeziumOracleEndpointBuilderFactory.DebeziumOracleEndpointBuilder 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
      • maxQueueSize

        default DebeziumOracleEndpointBuilderFactory.DebeziumOracleEndpointBuilder 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
      • maxQueueSize

        default DebeziumOracleEndpointBuilderFactory.DebeziumOracleEndpointBuilder maxQueueSize​(String maxQueueSize)
        Maximum size of the queue for change events read from the database log but not yet recorded or forwarded. Defaults to 8192, and should always be larger than the maximum batch size. The option will be converted to a <code>int</code> type. Default: 8192 Group: oracle
        Parameters:
        maxQueueSize - the value to set
        Returns:
        the dsl builder
      • maxQueueSizeInBytes

        default DebeziumOracleEndpointBuilderFactory.DebeziumOracleEndpointBuilder 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
      • maxQueueSizeInBytes

        default DebeziumOracleEndpointBuilderFactory.DebeziumOracleEndpointBuilder maxQueueSizeInBytes​(String maxQueueSizeInBytes)
        Maximum size of the queue in bytes for change events read from the database log but not yet recorded or forwarded. Defaults to 0. Mean the feature is not enabled. The option will be converted to a <code>long</code> type. Default: 0 Group: oracle
        Parameters:
        maxQueueSizeInBytes - the value to set
        Returns:
        the dsl builder
      • messageKeyColumns

        default DebeziumOracleEndpointBuilderFactory.DebeziumOracleEndpointBuilder 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
      • pollIntervalMs

        default DebeziumOracleEndpointBuilderFactory.DebeziumOracleEndpointBuilder 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
      • pollIntervalMs

        default DebeziumOracleEndpointBuilderFactory.DebeziumOracleEndpointBuilder pollIntervalMs​(String pollIntervalMs)
        Time to wait for new change events to appear after receiving no events, given in milliseconds. Defaults to 500 ms. The option will be converted to a <code>long</code> type. Default: 500ms Group: oracle
        Parameters:
        pollIntervalMs - the value to set
        Returns:
        the dsl builder
      • provideTransactionMetadata

        default DebeziumOracleEndpointBuilderFactory.DebeziumOracleEndpointBuilder 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
      • provideTransactionMetadata

        default DebeziumOracleEndpointBuilderFactory.DebeziumOracleEndpointBuilder provideTransactionMetadata​(String provideTransactionMetadata)
        Enables transaction metadata extraction together with event counting. The option will be converted to a <code>boolean</code> type. Default: false Group: oracle
        Parameters:
        provideTransactionMetadata - the value to set
        Returns:
        the dsl builder
      • queryFetchSize

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

        default DebeziumOracleEndpointBuilderFactory.DebeziumOracleEndpointBuilder queryFetchSize​(String queryFetchSize)
        The maximum number of records that should be loaded into memory while streaming. A value of 0 uses the default JDBC fetch size. The option will be converted to a <code>int</code> type. Default: 0 Group: oracle
        Parameters:
        queryFetchSize - the value to set
        Returns:
        the dsl builder
      • retriableRestartConnectorWaitMs

        default DebeziumOracleEndpointBuilderFactory.DebeziumOracleEndpointBuilder 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
      • retriableRestartConnectorWaitMs

        default DebeziumOracleEndpointBuilderFactory.DebeziumOracleEndpointBuilder retriableRestartConnectorWaitMs​(String retriableRestartConnectorWaitMs)
        Time to wait before restarting connector after retriable exception occurs. Defaults to 10000ms. The option will be converted to a <code>long</code> type. Default: 10s Group: oracle
        Parameters:
        retriableRestartConnectorWaitMs - the value to set
        Returns:
        the dsl builder
      • sanitizeFieldNames

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

        default DebeziumOracleEndpointBuilderFactory.DebeziumOracleEndpointBuilder sanitizeFieldNames​(String sanitizeFieldNames)
        Whether field names will be sanitized to Avro naming conventions. The option will be converted to a <code>boolean</code> type. Default: false Group: oracle
        Parameters:
        sanitizeFieldNames - the value to set
        Returns:
        the dsl builder
      • schemaNameAdjustmentMode

        default DebeziumOracleEndpointBuilderFactory.DebeziumOracleEndpointBuilder schemaNameAdjustmentMode​(String schemaNameAdjustmentMode)
        Specify how schema names should be adjusted for compatibility with the message converter used by the connector, including:'avro' replaces the characters that cannot be used in the Avro type name with underscore (default)'none' does not apply any adjustment. The option is a: <code>java.lang.String</code> type. Default: avro Group: oracle
        Parameters:
        schemaNameAdjustmentMode - the value to set
        Returns:
        the dsl builder
      • signalDataCollection

        default DebeziumOracleEndpointBuilderFactory.DebeziumOracleEndpointBuilder 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
      • skippedOperations

        default DebeziumOracleEndpointBuilderFactory.DebeziumOracleEndpointBuilder skippedOperations​(String skippedOperations)
        The comma-separated list of operations to skip during streaming, defined as: 'c' for inserts/create; 'u' for updates; 'd' for deletes, 't' for truncates, and 'none' to indicate nothing skipped. By default, no operations will be skipped. The option is a: <code>java.lang.String</code> type. Group: oracle
        Parameters:
        skippedOperations - the value to set
        Returns:
        the dsl builder
      • snapshotDelayMs

        default DebeziumOracleEndpointBuilderFactory.DebeziumOracleEndpointBuilder 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
      • snapshotDelayMs

        default DebeziumOracleEndpointBuilderFactory.DebeziumOracleEndpointBuilder snapshotDelayMs​(String snapshotDelayMs)
        A delay period before a snapshot will begin, given in milliseconds. Defaults to 0 ms. The option will be converted to a <code>long</code> type. Default: 0ms Group: oracle
        Parameters:
        snapshotDelayMs - the value to set
        Returns:
        the dsl builder
      • snapshotEnhancePredicateScn

        default DebeziumOracleEndpointBuilderFactory.DebeziumOracleEndpointBuilder 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 DebeziumOracleEndpointBuilderFactory.DebeziumOracleEndpointBuilder 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
      • snapshotFetchSize

        default DebeziumOracleEndpointBuilderFactory.DebeziumOracleEndpointBuilder snapshotFetchSize​(String snapshotFetchSize)
        The maximum number of records that should be loaded into memory while performing a snapshot. The option will be converted to a <code>int</code> type. Group: oracle
        Parameters:
        snapshotFetchSize - the value to set
        Returns:
        the dsl builder
      • snapshotIncludeCollectionList

        default DebeziumOracleEndpointBuilderFactory.DebeziumOracleEndpointBuilder 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 DebeziumOracleEndpointBuilderFactory.DebeziumOracleEndpointBuilder 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 DebeziumOracleEndpointBuilderFactory.DebeziumOracleEndpointBuilder 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
      • snapshotLockTimeoutMs

        default DebeziumOracleEndpointBuilderFactory.DebeziumOracleEndpointBuilder snapshotLockTimeoutMs​(String snapshotLockTimeoutMs)
        The maximum number of millis to wait for table locks at the beginning of a snapshot. If locks cannot be acquired in this time frame, the snapshot will be aborted. Defaults to 10 seconds. The option will be converted to a <code>long</code> type. Default: 10s Group: oracle
        Parameters:
        snapshotLockTimeoutMs - the value to set
        Returns:
        the dsl builder
      • snapshotMaxThreads

        default DebeziumOracleEndpointBuilderFactory.DebeziumOracleEndpointBuilder 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
      • snapshotMaxThreads

        default DebeziumOracleEndpointBuilderFactory.DebeziumOracleEndpointBuilder snapshotMaxThreads​(String snapshotMaxThreads)
        The maximum number of threads used to perform the snapshot. Defaults to 1. The option will be converted to a <code>int</code> type. Default: 1 Group: oracle
        Parameters:
        snapshotMaxThreads - the value to set
        Returns:
        the dsl builder
      • snapshotMode

        default DebeziumOracleEndpointBuilderFactory.DebeziumOracleEndpointBuilder snapshotMode​(String snapshotMode)
        The criteria for running a snapshot upon startup of the connector. Options include: 'initial' (the default) to specify the connector should run a snapshot only when no offsets are available for the logical server name; 'schema_only' to specify the connector should run a snapshot of the schema when no offsets are available for the logical server name. The option is a: <code>java.lang.String</code> type. Default: initial Group: oracle
        Parameters:
        snapshotMode - the value to set
        Returns:
        the dsl builder
      • snapshotSelectStatementOverrides

        default DebeziumOracleEndpointBuilderFactory.DebeziumOracleEndpointBuilder snapshotSelectStatementOverrides​(String snapshotSelectStatementOverrides)
        This property contains a comma-separated list of fully-qualified tables (DB_NAME.TABLE_NAME) or (SCHEMA_NAME.TABLE_NAME), depending on thespecific connectors. Select statements for the individual tables are specified in further configuration properties, one for each table, identified by the id 'snapshot.select.statement.overrides.DB_NAME.TABLE_NAME' or 'snapshot.select.statement.overrides.SCHEMA_NAME.TABLE_NAME', respectively. The value of those properties is the select statement to use when retrieving data from the specific table during snapshotting. A possible use case for large append-only tables is setting a specific point where to start (resume) snapshotting, in case a previous snapshotting was interrupted. The option is a: <code>java.lang.String</code> type. Group: oracle
        Parameters:
        snapshotSelectStatementOverrides - the value to set
        Returns:
        the dsl builder
      • sourceStructVersion

        default DebeziumOracleEndpointBuilderFactory.DebeziumOracleEndpointBuilder sourceStructVersion​(String sourceStructVersion)
        A version of the format of the publicly visible source part in the message. The option is a: <code>java.lang.String</code> type. Default: v2 Group: oracle
        Parameters:
        sourceStructVersion - the value to set
        Returns:
        the dsl builder
      • tableBlacklist

        default DebeziumOracleEndpointBuilderFactory.DebeziumOracleEndpointBuilder tableBlacklist​(String tableBlacklist)
        A comma-separated list of regular expressions that match the fully-qualified names of tables to be excluded from monitoring (deprecated, use table.exclude.list instead). The option is a: <code>java.lang.String</code> type. Group: oracle
        Parameters:
        tableBlacklist - the value to set
        Returns:
        the dsl builder
      • tableExcludeList

        default DebeziumOracleEndpointBuilderFactory.DebeziumOracleEndpointBuilder 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
      • tableWhitelist

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

        default DebeziumOracleEndpointBuilderFactory.DebeziumOracleEndpointBuilder 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 DebeziumOracleEndpointBuilderFactory.DebeziumOracleEndpointBuilder tombstonesOnDelete​(boolean tombstonesOnDelete)
        Whether delete operations should be represented by a delete event and a subsquenttombstone event (true) or only by a delete event (false). Emitting the tombstone event (the default behavior) allows Kafka to completely delete all events pertaining to the given key once the source record got deleted. The option is a: <code>boolean</code> type. Default: false Group: oracle
        Parameters:
        tombstonesOnDelete - the value to set
        Returns:
        the dsl builder
      • tombstonesOnDelete

        default DebeziumOracleEndpointBuilderFactory.DebeziumOracleEndpointBuilder tombstonesOnDelete​(String tombstonesOnDelete)
        Whether delete operations should be represented by a delete event and a subsquenttombstone event (true) or only by a delete event (false). Emitting the tombstone event (the default behavior) allows Kafka to completely delete all events pertaining to the given key once the source record got deleted. The option will be converted to a <code>boolean</code> type. Default: false Group: oracle
        Parameters:
        tombstonesOnDelete - the value to set
        Returns:
        the dsl builder
      • transactionTopic

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

        default DebeziumOracleEndpointBuilderFactory.DebeziumOracleEndpointBuilder 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. The option is a: <code>java.lang.String</code> type. Default: __debezium_unavailable_value Group: oracle
        Parameters:
        unavailableValuePlaceholder - the value to set
        Returns:
        the dsl builder