Package org.apache.camel.builder.component.dsl

Interface DebeziumMysqlComponentBuilderFactory.DebeziumMysqlComponentBuilder

    • Method Detail

      • additionalProperties

        default DebeziumMysqlComponentBuilderFactory.DebeziumMysqlComponentBuilder 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&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. Group: common
        Parameters:
        additionalProperties - the value to set
        Returns:
        the dsl builder

      • bridgeErrorHandler

        default DebeziumMysqlComponentBuilderFactory.DebeziumMysqlComponentBuilder 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 DebeziumMysqlComponentBuilderFactory.DebeziumMysqlComponentBuilder configuration​(org.apache.camel.component.debezium.configuration.MySqlConnectorEmbeddedDebeziumConfiguration configuration)
        Allow pre-configured Configurations to be set. The option is a: <code>org.apache.camel.component.debezium.configuration.MySqlConnectorEmbeddedDebeziumConfiguration</code> type. Group: consumer
        Parameters:
        configuration - the value to set
        Returns:
        the dsl builder

      • internalKeyConverter

        default DebeziumMysqlComponentBuilderFactory.DebeziumMysqlComponentBuilder 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 DebeziumMysqlComponentBuilderFactory.DebeziumMysqlComponentBuilder 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 DebeziumMysqlComponentBuilderFactory.DebeziumMysqlComponentBuilder 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. Default: io.debezium.embedded.spi.OffsetCommitPolicy.PeriodicCommitOffsetPolicy Group: consumer
        Parameters:
        offsetCommitPolicy - the value to set
        Returns:
        the dsl builder

      • offsetCommitTimeoutMs

        default DebeziumMysqlComponentBuilderFactory.DebeziumMysqlComponentBuilder 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 DebeziumMysqlComponentBuilderFactory.DebeziumMysqlComponentBuilder 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 DebeziumMysqlComponentBuilderFactory.DebeziumMysqlComponentBuilder 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 DebeziumMysqlComponentBuilderFactory.DebeziumMysqlComponentBuilder 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 DebeziumMysqlComponentBuilderFactory.DebeziumMysqlComponentBuilder 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 DebeziumMysqlComponentBuilderFactory.DebeziumMysqlComponentBuilder 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 DebeziumMysqlComponentBuilderFactory.DebeziumMysqlComponentBuilder 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 DebeziumMysqlComponentBuilderFactory.DebeziumMysqlComponentBuilder 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

      • bigintUnsignedHandlingMode

        default DebeziumMysqlComponentBuilderFactory.DebeziumMysqlComponentBuilder bigintUnsignedHandlingMode​(String bigintUnsignedHandlingMode)
        Specify how BIGINT UNSIGNED columns should be represented in change events, including:'precise' 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; 'long' (the default) represents values using Java's 'long', 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: long Group: mysql
        Parameters:
        bigintUnsignedHandlingMode - the value to set
        Returns:
        the dsl builder

      • binaryHandlingMode

        default DebeziumMysqlComponentBuilderFactory.DebeziumMysqlComponentBuilder 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: mysql
        Parameters:
        binaryHandlingMode - the value to set
        Returns:
        the dsl builder

      • binlogBufferSize

        default DebeziumMysqlComponentBuilderFactory.DebeziumMysqlComponentBuilder binlogBufferSize​(int binlogBufferSize)
        The size of a look-ahead buffer used by the binlog reader to decide whether the transaction in progress is going to be committed or rolled back. Use 0 to disable look-ahead buffering. Defaults to 0 (i.e. buffering is disabled). The option is a: <code>int</code> type. Default: 0 Group: mysql
        Parameters:
        binlogBufferSize - the value to set
        Returns:
        the dsl builder

      • columnBlacklist

        default DebeziumMysqlComponentBuilderFactory.DebeziumMysqlComponentBuilder 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: mysql
        Parameters:
        columnBlacklist - the value to set
        Returns:
        the dsl builder

      • columnPropagateSourceType

        default DebeziumMysqlComponentBuilderFactory.DebeziumMysqlComponentBuilder 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: mysql
        Parameters:
        columnPropagateSourceType - the value to set
        Returns:
        the dsl builder

      • columnWhitelist

        default DebeziumMysqlComponentBuilderFactory.DebeziumMysqlComponentBuilder 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: mysql
        Parameters:
        columnWhitelist - the value to set
        Returns:
        the dsl builder

      • connectKeepAlive

        default DebeziumMysqlComponentBuilderFactory.DebeziumMysqlComponentBuilder connectKeepAlive​(boolean connectKeepAlive)
        Whether a separate thread should be used to ensure the connection is kept alive. The option is a: <code>boolean</code> type. Default: true Group: mysql
        Parameters:
        connectKeepAlive - the value to set
        Returns:
        the dsl builder

      • connectKeepAliveIntervalMs

        default DebeziumMysqlComponentBuilderFactory.DebeziumMysqlComponentBuilder connectKeepAliveIntervalMs​(long connectKeepAliveIntervalMs)
        Interval for connection checking if keep alive thread is used, given in milliseconds Defaults to 1 minute (60,000 ms). The option is a: <code>long</code> type. Default: 1m Group: mysql
        Parameters:
        connectKeepAliveIntervalMs - the value to set
        Returns:
        the dsl builder

      • connectTimeoutMs

        default DebeziumMysqlComponentBuilderFactory.DebeziumMysqlComponentBuilder connectTimeoutMs​(int connectTimeoutMs)
        Maximum time to wait after trying to connect to the database before timing out, given in milliseconds. Defaults to 30 seconds (30,000 ms). The option is a: <code>int</code> type. Default: 30s Group: mysql
        Parameters:
        connectTimeoutMs - the value to set
        Returns:
        the dsl builder

      • converters

        default DebeziumMysqlComponentBuilderFactory.DebeziumMysqlComponentBuilder 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: mysql
        Parameters:
        converters - the value to set
        Returns:
        the dsl builder

      • databaseExcludeList

        default DebeziumMysqlComponentBuilderFactory.DebeziumMysqlComponentBuilder databaseExcludeList​(String databaseExcludeList)
        A comma-separated list of regular expressions that match database names to be excluded from monitoring. The option is a: <code>java.lang.String</code> type. Group: mysql
        Parameters:
        databaseExcludeList - the value to set
        Returns:
        the dsl builder

      • databaseHistory

        default DebeziumMysqlComponentBuilderFactory.DebeziumMysqlComponentBuilder 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.FileDatabaseHistory Group: mysql
        Parameters:
        databaseHistory - the value to set
        Returns:
        the dsl builder

      • databaseHistoryFileFilename

        default DebeziumMysqlComponentBuilderFactory.DebeziumMysqlComponentBuilder 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: mysql
        Parameters:
        databaseHistoryFileFilename - the value to set
        Returns:
        the dsl builder

      • databaseHistoryKafkaBootstrapServers

        default DebeziumMysqlComponentBuilderFactory.DebeziumMysqlComponentBuilder 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: mysql
        Parameters:
        databaseHistoryKafkaBootstrapServers - the value to set
        Returns:
        the dsl builder

      • databaseHistoryKafkaQueryTimeoutMs

        default DebeziumMysqlComponentBuilderFactory.DebeziumMysqlComponentBuilder 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: mysql
        Parameters:
        databaseHistoryKafkaQueryTimeoutMs - the value to set
        Returns:
        the dsl builder

      • databaseHistoryKafkaRecoveryAttempts

        default DebeziumMysqlComponentBuilderFactory.DebeziumMysqlComponentBuilder 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: mysql
        Parameters:
        databaseHistoryKafkaRecoveryAttempts - the value to set
        Returns:
        the dsl builder

      • databaseHistoryKafkaRecoveryPollIntervalMs

        default DebeziumMysqlComponentBuilderFactory.DebeziumMysqlComponentBuilder 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: mysql
        Parameters:
        databaseHistoryKafkaRecoveryPollIntervalMs - the value to set
        Returns:
        the dsl builder

      • databaseHistoryKafkaTopic

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

      • databaseHistorySkipUnparseableDdl

        default DebeziumMysqlComponentBuilderFactory.DebeziumMysqlComponentBuilder 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: mysql
        Parameters:
        databaseHistorySkipUnparseableDdl - the value to set
        Returns:
        the dsl builder

      • databaseHistoryStoreOnlyCapturedTablesDdl

        default DebeziumMysqlComponentBuilderFactory.DebeziumMysqlComponentBuilder 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: mysql
        Parameters:
        databaseHistoryStoreOnlyCapturedTablesDdl - the value to set
        Returns:
        the dsl builder

      • databaseHistoryStoreOnlyMonitoredTablesDdl

        default DebeziumMysqlComponentBuilderFactory.DebeziumMysqlComponentBuilder 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: mysql
        Parameters:
        databaseHistoryStoreOnlyMonitoredTablesDdl - the value to set
        Returns:
        the dsl builder

      • databaseInitialStatements

        default DebeziumMysqlComponentBuilderFactory.DebeziumMysqlComponentBuilder databaseInitialStatements​(String databaseInitialStatements)
        A semicolon separated list of SQL statements to be executed when a JDBC connection (not binlog reading connection) to the database is established. Note that the connector may establish JDBC connections at its own discretion, so this should typically be used for configuration of session parameters only,but not for executing DML statements. Use doubled semicolon (';;') to use a semicolon as a character and not as a delimiter. The option is a: <code>java.lang.String</code> type. Group: mysql
        Parameters:
        databaseInitialStatements - the value to set
        Returns:
        the dsl builder

      • databaseJdbcDriver

        default DebeziumMysqlComponentBuilderFactory.DebeziumMysqlComponentBuilder databaseJdbcDriver​(String databaseJdbcDriver)
        JDBC Driver class name used to connect to the MySQL database server. The option is a: <code>java.lang.String</code> type. Default: com.mysql.cj.jdbc.Driver Group: mysql
        Parameters:
        databaseJdbcDriver - the value to set
        Returns:
        the dsl builder

      • databaseServerId

        default DebeziumMysqlComponentBuilderFactory.DebeziumMysqlComponentBuilder databaseServerId​(long databaseServerId)
        A numeric ID of this database client, which must be unique across all currently-running database processes in the cluster. This connector joins the MySQL database cluster as another server (with this unique ID) so it can read the binlog. By default, a random number is generated between 5400 and 6400. The option is a: <code>long</code> type. Group: mysql
        Parameters:
        databaseServerId - the value to set
        Returns:
        the dsl builder

      • databaseServerIdOffset

        default DebeziumMysqlComponentBuilderFactory.DebeziumMysqlComponentBuilder databaseServerIdOffset​(long databaseServerIdOffset)
        Only relevant if parallel snapshotting is configured. During parallel snapshotting, multiple (4) connections open to the database client, and they each need their own unique connection ID. This offset is used to generate those IDs from the base configured cluster ID. The option is a: <code>long</code> type. Default: 10000 Group: mysql
        Parameters:
        databaseServerIdOffset - the value to set
        Returns:
        the dsl builder

      • databaseServerName

        default DebeziumMysqlComponentBuilderFactory.DebeziumMysqlComponentBuilder 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. Group: mysql
        Parameters:
        databaseServerName - the value to set
        Returns:
        the dsl builder

      • databaseSslKeystore

        default DebeziumMysqlComponentBuilderFactory.DebeziumMysqlComponentBuilder databaseSslKeystore​(String databaseSslKeystore)
        The location of the key store file. This is optional and can be used for two-way authentication between the client and the MySQL Server. The option is a: <code>java.lang.String</code> type. Group: mysql
        Parameters:
        databaseSslKeystore - the value to set
        Returns:
        the dsl builder

      • databaseSslKeystorePassword

        default DebeziumMysqlComponentBuilderFactory.DebeziumMysqlComponentBuilder databaseSslKeystorePassword​(String databaseSslKeystorePassword)
        The password for the key store file. This is optional and only needed if 'database.ssl.keystore' is configured. The option is a: <code>java.lang.String</code> type. Group: mysql
        Parameters:
        databaseSslKeystorePassword - the value to set
        Returns:
        the dsl builder

      • databaseSslMode

        default DebeziumMysqlComponentBuilderFactory.DebeziumMysqlComponentBuilder databaseSslMode​(String databaseSslMode)
        Whether to use an encrypted connection to MySQL. Options include'disabled' (the default) to use an unencrypted connection; 'preferred' to establish a secure (encrypted) connection if the server supports secure connections, but fall back to an unencrypted connection otherwise; 'required' to use a secure (encrypted) connection, and fail if one cannot be established; 'verify_ca' like 'required' but additionally verify the server TLS certificate against the configured Certificate Authority (CA) certificates, or fail if no valid matching CA certificates are found; or'verify_identity' like 'verify_ca' but additionally verify that the server certificate matches the host to which the connection is attempted. The option is a: <code>java.lang.String</code> type. Default: disabled Group: mysql
        Parameters:
        databaseSslMode - the value to set
        Returns:
        the dsl builder

      • databaseSslTruststore

        default DebeziumMysqlComponentBuilderFactory.DebeziumMysqlComponentBuilder databaseSslTruststore​(String databaseSslTruststore)
        The location of the trust store file for the server certificate verification. The option is a: <code>java.lang.String</code> type. Group: mysql
        Parameters:
        databaseSslTruststore - the value to set
        Returns:
        the dsl builder

      • databaseSslTruststorePassword

        default DebeziumMysqlComponentBuilderFactory.DebeziumMysqlComponentBuilder databaseSslTruststorePassword​(String databaseSslTruststorePassword)
        The password for the trust store file. Used to check the integrity of the truststore, and unlock the truststore. The option is a: <code>java.lang.String</code> type. Group: mysql
        Parameters:
        databaseSslTruststorePassword - the value to set
        Returns:
        the dsl builder

      • datatypePropagateSourceType

        default DebeziumMysqlComponentBuilderFactory.DebeziumMysqlComponentBuilder 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: mysql
        Parameters:
        datatypePropagateSourceType - the value to set
        Returns:
        the dsl builder

      • decimalHandlingMode

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

      • enableTimeAdjuster

        default DebeziumMysqlComponentBuilderFactory.DebeziumMysqlComponentBuilder enableTimeAdjuster​(boolean enableTimeAdjuster)
        MySQL allows user to insert year value as either 2-digit or 4-digit. In case of two digit the value is automatically mapped into 1970 - 2069.false - delegates the implicit conversion to the databasetrue - (the default) Debezium makes the conversion. The option is a: <code>boolean</code> type. Default: true Group: mysql
        Parameters:
        enableTimeAdjuster - the value to set
        Returns:
        the dsl builder

      • eventDeserializationFailureHandlingMode

        default DebeziumMysqlComponentBuilderFactory.DebeziumMysqlComponentBuilder eventDeserializationFailureHandlingMode​(String eventDeserializationFailureHandlingMode)
        Specify how failures during deserialization of binlog events (i.e. when encountering a corrupted event) should be handled, including:'fail' (the default) an exception indicating the problematic event and its binlog position is raised, causing the connector to be stopped; 'warn' the problematic event and its binlog 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: mysql
        Parameters:
        eventDeserializationFailureHandlingMode - the value to set
        Returns:
        the dsl builder

      • eventProcessingFailureHandlingMode

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

      • gtidSourceExcludes

        default DebeziumMysqlComponentBuilderFactory.DebeziumMysqlComponentBuilder gtidSourceExcludes​(String gtidSourceExcludes)
        The source UUIDs used to exclude GTID ranges when determine the starting position in the MySQL server's binlog. The option is a: <code>java.lang.String</code> type. Group: mysql
        Parameters:
        gtidSourceExcludes - the value to set
        Returns:
        the dsl builder

      • gtidSourceFilterDmlEvents

        default DebeziumMysqlComponentBuilderFactory.DebeziumMysqlComponentBuilder gtidSourceFilterDmlEvents​(boolean gtidSourceFilterDmlEvents)
        If set to true, we will only produce DML events into Kafka for transactions that were written on mysql servers with UUIDs matching the filters defined by the gtid.source.includes or gtid.source.excludes configuration options, if they are specified. The option is a: <code>boolean</code> type. Default: true Group: mysql
        Parameters:
        gtidSourceFilterDmlEvents - the value to set
        Returns:
        the dsl builder

      • gtidSourceIncludes

        default DebeziumMysqlComponentBuilderFactory.DebeziumMysqlComponentBuilder gtidSourceIncludes​(String gtidSourceIncludes)
        The source UUIDs used to include GTID ranges when determine the starting position in the MySQL server's binlog. The option is a: <code>java.lang.String</code> type. Group: mysql
        Parameters:
        gtidSourceIncludes - the value to set
        Returns:
        the dsl builder

      • heartbeatIntervalMs

        default DebeziumMysqlComponentBuilderFactory.DebeziumMysqlComponentBuilder 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: mysql
        Parameters:
        heartbeatIntervalMs - the value to set
        Returns:
        the dsl builder

      • heartbeatTopicsPrefix

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

      • includeQuery

        default DebeziumMysqlComponentBuilderFactory.DebeziumMysqlComponentBuilder includeQuery​(boolean includeQuery)
        Whether the connector should include the original SQL query that generated the change event. Note: This option requires MySQL be configured with the binlog_rows_query_log_events option set to ON. Query will not be present for events generated from snapshot. WARNING: Enabling this option may expose tables or fields explicitly blacklisted or masked by including the original SQL statement in the change event. For this reason the default value is 'false'. The option is a: <code>boolean</code> type. Default: false Group: mysql
        Parameters:
        includeQuery - the value to set
        Returns:
        the dsl builder

      • includeSchemaChanges

        default DebeziumMysqlComponentBuilderFactory.DebeziumMysqlComponentBuilder 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: mysql
        Parameters:
        includeSchemaChanges - the value to set
        Returns:
        the dsl builder

      • includeSchemaComments

        default DebeziumMysqlComponentBuilderFactory.DebeziumMysqlComponentBuilder 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: mysql
        Parameters:
        includeSchemaComments - the value to set
        Returns:
        the dsl builder

      • inconsistentSchemaHandlingMode

        default DebeziumMysqlComponentBuilderFactory.DebeziumMysqlComponentBuilder inconsistentSchemaHandlingMode​(String inconsistentSchemaHandlingMode)
        Specify how binlog events that belong to a table missing from internal schema representation (i.e. internal representation is not consistent with database) should be handled, including:'fail' (the default) an exception indicating the problematic event and its binlog position is raised, causing the connector to be stopped; 'warn' the problematic event and its binlog position will be logged and the event will be skipped;'skip' the problematic event will be skipped. The option is a: <code>java.lang.String</code> type. Default: fail Group: mysql
        Parameters:
        inconsistentSchemaHandlingMode - the value to set
        Returns:
        the dsl builder

      • incrementalSnapshotAllowSchemaChanges

        default DebeziumMysqlComponentBuilderFactory.DebeziumMysqlComponentBuilder incrementalSnapshotAllowSchemaChanges​(boolean incrementalSnapshotAllowSchemaChanges)
        Detect schema change during an incremental snapshot and re-select a current chunk to avoid locking DDLs. Note that changes to a primary key are not supported and can cause incorrect results if performed during an incremental snapshot. Another limitation is that if a schema change affects only columns' default values, then the change won't be detected until the DDL is processed from the binlog stream. This doesn't affect the snapshot events' values, but the schema of snapshot events may have outdated defaults. The option is a: <code>boolean</code> type. Default: false Group: mysql
        Parameters:
        incrementalSnapshotAllowSchemaChanges - the value to set
        Returns:
        the dsl builder

      • incrementalSnapshotChunkSize

        default DebeziumMysqlComponentBuilderFactory.DebeziumMysqlComponentBuilder incrementalSnapshotChunkSize​(int incrementalSnapshotChunkSize)
        The maximum size of chunk for incremental snapshotting. The option is a: <code>int</code> type. Default: 1024 Group: mysql
        Parameters:
        incrementalSnapshotChunkSize - the value to set
        Returns:
        the dsl builder

      • maxQueueSize

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

      • maxQueueSizeInBytes

        default DebeziumMysqlComponentBuilderFactory.DebeziumMysqlComponentBuilder 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: mysql
        Parameters:
        maxQueueSizeInBytes - the value to set
        Returns:
        the dsl builder

      • messageKeyColumns

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

      • minRowCountToStreamResults

        default DebeziumMysqlComponentBuilderFactory.DebeziumMysqlComponentBuilder minRowCountToStreamResults​(int minRowCountToStreamResults)
        The number of rows a table must contain to stream results rather than pull all into memory during snapshots. Defaults to 1,000. Use 0 to stream all results and completely avoid checking the size of each table. The option is a: <code>int</code> type. Default: 1000 Group: mysql
        Parameters:
        minRowCountToStreamResults - the value to set
        Returns:
        the dsl builder

      • pollIntervalMs

        default DebeziumMysqlComponentBuilderFactory.DebeziumMysqlComponentBuilder 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: mysql
        Parameters:
        pollIntervalMs - the value to set
        Returns:
        the dsl builder

      • provideTransactionMetadata

        default DebeziumMysqlComponentBuilderFactory.DebeziumMysqlComponentBuilder provideTransactionMetadata​(boolean provideTransactionMetadata)
        Enables transaction metadata extraction together with event counting. The option is a: <code>boolean</code> type. Default: false Group: mysql
        Parameters:
        provideTransactionMetadata - the value to set
        Returns:
        the dsl builder

      • queryFetchSize

        default DebeziumMysqlComponentBuilderFactory.DebeziumMysqlComponentBuilder 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: mysql
        Parameters:
        queryFetchSize - the value to set
        Returns:
        the dsl builder

      • retriableRestartConnectorWaitMs

        default DebeziumMysqlComponentBuilderFactory.DebeziumMysqlComponentBuilder 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: mysql
        Parameters:
        retriableRestartConnectorWaitMs - the value to set
        Returns:
        the dsl builder

      • sanitizeFieldNames

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

      • schemaNameAdjustmentMode

        default DebeziumMysqlComponentBuilderFactory.DebeziumMysqlComponentBuilder 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: mysql
        Parameters:
        schemaNameAdjustmentMode - the value to set
        Returns:
        the dsl builder

      • signalDataCollection

        default DebeziumMysqlComponentBuilderFactory.DebeziumMysqlComponentBuilder 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: mysql
        Parameters:
        signalDataCollection - the value to set
        Returns:
        the dsl builder

      • skippedOperations

        default DebeziumMysqlComponentBuilderFactory.DebeziumMysqlComponentBuilder 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: mysql
        Parameters:
        skippedOperations - the value to set
        Returns:
        the dsl builder

      • snapshotDelayMs

        default DebeziumMysqlComponentBuilderFactory.DebeziumMysqlComponentBuilder 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: mysql
        Parameters:
        snapshotDelayMs - the value to set
        Returns:
        the dsl builder

      • snapshotFetchSize

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

      • snapshotIncludeCollectionList

        default DebeziumMysqlComponentBuilderFactory.DebeziumMysqlComponentBuilder 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: mysql
        Parameters:
        snapshotIncludeCollectionList - the value to set
        Returns:
        the dsl builder

      • snapshotLockingMode

        default DebeziumMysqlComponentBuilderFactory.DebeziumMysqlComponentBuilder snapshotLockingMode​(String snapshotLockingMode)
        Controls how long the connector holds onto the global read lock while it is performing a snapshot. The default is 'minimal', which means the connector holds the global read lock (and thus prevents any updates) 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 can be done using the snapshot process' REPEATABLE READ transaction even when the lock is no longer held and other operations are updating the database. However, in some cases it may be desirable to block all writes for the entire duration of the snapshot; in such cases set this property to 'extended'. Using a value of 'none' will prevent the connector from acquiring any table locks during the snapshot process. This mode can only be used in combination with snapshot.mode values of 'schema_only' or 'schema_only_recovery' and 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: minimal Group: mysql
        Parameters:
        snapshotLockingMode - the value to set
        Returns:
        the dsl builder

      • snapshotLockTimeoutMs

        default DebeziumMysqlComponentBuilderFactory.DebeziumMysqlComponentBuilder 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: mysql
        Parameters:
        snapshotLockTimeoutMs - the value to set
        Returns:
        the dsl builder

      • snapshotMaxThreads

        default DebeziumMysqlComponentBuilderFactory.DebeziumMysqlComponentBuilder 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: mysql
        Parameters:
        snapshotMaxThreads - the value to set
        Returns:
        the dsl builder

      • snapshotMode

        default DebeziumMysqlComponentBuilderFactory.DebeziumMysqlComponentBuilder snapshotMode​(String snapshotMode)
        The criteria for running a snapshot upon startup of the connector. Options include: 'when_needed' to specify that the connector run a snapshot upon startup whenever it deems it necessary; 'schema_only' to only take a snapshot of the schema (table structures) but no actual data; 'initial' (the default) to specify the connector can run a snapshot only when no offsets are available for the logical server name; 'initial_only' same as 'initial' except the connector should stop after completing the snapshot and before it would normally read the binlog; and'never' to specify the connector should never run a snapshot and that upon first startup the connector should read from the beginning of the binlog. The 'never' mode should be used with care, and only when the binlog is known to contain all history. The option is a: <code>java.lang.String</code> type. Default: initial Group: mysql
        Parameters:
        snapshotMode - the value to set
        Returns:
        the dsl builder

      • snapshotNewTables

        default DebeziumMysqlComponentBuilderFactory.DebeziumMysqlComponentBuilder snapshotNewTables​(String snapshotNewTables)
        BETA FEATURE: On connector restart, the connector will check if there have been any new tables added to the configuration, and snapshot them. There is presently only two options:'off': Default behavior. Do not snapshot new tables.'parallel': The snapshot of the new tables will occur in parallel to the continued binlog reading of the old tables. When the snapshot completes, an independent binlog reader will begin reading the events for the new tables until it catches up to present time. At this point, both old and new binlog readers will be momentarily halted and new binlog reader will start that will read the binlog for all configured tables. The parallel binlog reader will have a configured server id of 10000 the primary binlog reader's server id. The option is a: <code>java.lang.String</code> type. Default: off Group: mysql
        Parameters:
        snapshotNewTables - the value to set
        Returns:
        the dsl builder

      • snapshotSelectStatementOverrides

        default DebeziumMysqlComponentBuilderFactory.DebeziumMysqlComponentBuilder 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: mysql
        Parameters:
        snapshotSelectStatementOverrides - the value to set
        Returns:
        the dsl builder

      • sourceStructVersion

        default DebeziumMysqlComponentBuilderFactory.DebeziumMysqlComponentBuilder 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: mysql
        Parameters:
        sourceStructVersion - the value to set
        Returns:
        the dsl builder

      • tableBlacklist

        default DebeziumMysqlComponentBuilderFactory.DebeziumMysqlComponentBuilder 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: mysql
        Parameters:
        tableBlacklist - the value to set
        Returns:
        the dsl builder

      • tableExcludeList

        default DebeziumMysqlComponentBuilderFactory.DebeziumMysqlComponentBuilder 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: mysql
        Parameters:
        tableExcludeList - the value to set
        Returns:
        the dsl builder

      • tableIgnoreBuiltin

        default DebeziumMysqlComponentBuilderFactory.DebeziumMysqlComponentBuilder tableIgnoreBuiltin​(boolean tableIgnoreBuiltin)
        Flag specifying whether built-in tables should be ignored. The option is a: <code>boolean</code> type. Default: true Group: mysql
        Parameters:
        tableIgnoreBuiltin - the value to set
        Returns:
        the dsl builder

      • tableWhitelist

        default DebeziumMysqlComponentBuilderFactory.DebeziumMysqlComponentBuilder 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: mysql
        Parameters:
        tableWhitelist - the value to set
        Returns:
        the dsl builder

      • timePrecisionMode

        default DebeziumMysqlComponentBuilderFactory.DebeziumMysqlComponentBuilder timePrecisionMode​(String timePrecisionMode)
        Time, date and timestamps can be represented with different kinds of precisions, including:'adaptive_time_microseconds': the precision of date and timestamp values is based the database column's precision; 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_time_microseconds Group: mysql
        Parameters:
        timePrecisionMode - the value to set
        Returns:
        the dsl builder

      • tombstonesOnDelete

        default DebeziumMysqlComponentBuilderFactory.DebeziumMysqlComponentBuilder 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: mysql
        Parameters:
        tombstonesOnDelete - the value to set
        Returns:
        the dsl builder

      • transactionTopic

        default DebeziumMysqlComponentBuilderFactory.DebeziumMysqlComponentBuilder 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: mysql
        Parameters:
        transactionTopic - the value to set
        Returns:
        the dsl builder