Package org.apache.camel.builder.endpoint.dsl

Interface DebeziumMySqlEndpointBuilderFactory.DebeziumMySqlEndpointBuilder

All Superinterfaces:
org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver
Enclosing interface:
DebeziumMySqlEndpointBuilderFactory
public static interface DebeziumMySqlEndpointBuilderFactory.DebeziumMySqlEndpointBuilder extends org.apache.camel.builder.EndpointConsumerBuilder
Builder for endpoint for the Debezium MySQL Connector component.

  • Method Details

    • advanced

      default DebeziumMySqlEndpointBuilderFactory.AdvancedDebeziumMySqlEndpointBuilder advanced()

    • additionalProperties

      default DebeziumMySqlEndpointBuilderFactory.DebeziumMySqlEndpointBuilder 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&additionalProperties.schema.registry.url=http://localhost:8811/avro. The option is a: java.util.Map<java.lang.String, java.lang.Object> 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 DebeziumMySqlEndpointBuilderFactory.DebeziumMySqlEndpointBuilder 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&additionalProperties.schema.registry.url=http://localhost:8811/avro. The option is a: java.util.Map<java.lang.String, java.lang.Object> 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 DebeziumMySqlEndpointBuilderFactory.DebeziumMySqlEndpointBuilder 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: java.lang.String type. Default: org.apache.kafka.connect.json.JsonConverter Group: consumer
      Parameters:
      internalKeyConverter - the value to set
      Returns:
      the dsl builder

    • internalValueConverter

      default DebeziumMySqlEndpointBuilderFactory.DebeziumMySqlEndpointBuilder 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: java.lang.String type. Default: org.apache.kafka.connect.json.JsonConverter Group: consumer
      Parameters:
      internalValueConverter - the value to set
      Returns:
      the dsl builder

    • offsetCommitPolicy

      default DebeziumMySqlEndpointBuilderFactory.DebeziumMySqlEndpointBuilder 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: java.lang.String type. Group: consumer
      Parameters:
      offsetCommitPolicy - the value to set
      Returns:
      the dsl builder

    • offsetCommitTimeoutMs

      default DebeziumMySqlEndpointBuilderFactory.DebeziumMySqlEndpointBuilder 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: long type. Default: 5000 Group: consumer
      Parameters:
      offsetCommitTimeoutMs - the value to set
      Returns:
      the dsl builder

    • offsetCommitTimeoutMs

      default DebeziumMySqlEndpointBuilderFactory.DebeziumMySqlEndpointBuilder 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 long type. Default: 5000 Group: consumer
      Parameters:
      offsetCommitTimeoutMs - the value to set
      Returns:
      the dsl builder

    • offsetFlushIntervalMs

      default DebeziumMySqlEndpointBuilderFactory.DebeziumMySqlEndpointBuilder offsetFlushIntervalMs(long offsetFlushIntervalMs)
      Interval at which to try committing offsets. The default is 1 minute. The option is a: long type. Default: 60000 Group: consumer
      Parameters:
      offsetFlushIntervalMs - the value to set
      Returns:
      the dsl builder

    • offsetFlushIntervalMs

      default DebeziumMySqlEndpointBuilderFactory.DebeziumMySqlEndpointBuilder offsetFlushIntervalMs(String offsetFlushIntervalMs)
      Interval at which to try committing offsets. The default is 1 minute. The option will be converted to a long type. Default: 60000 Group: consumer
      Parameters:
      offsetFlushIntervalMs - the value to set
      Returns:
      the dsl builder

    • offsetStorage

      default DebeziumMySqlEndpointBuilderFactory.DebeziumMySqlEndpointBuilder offsetStorage(String offsetStorage)
      The name of the Java class that is responsible for persistence of connector offsets. The option is a: java.lang.String type. Default: org.apache.kafka.connect.storage.FileOffsetBackingStore Group: consumer
      Parameters:
      offsetStorage - the value to set
      Returns:
      the dsl builder

    • offsetStorageFileName

      default DebeziumMySqlEndpointBuilderFactory.DebeziumMySqlEndpointBuilder 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: java.lang.String type. Group: consumer
      Parameters:
      offsetStorageFileName - the value to set
      Returns:
      the dsl builder

    • offsetStoragePartitions

      default DebeziumMySqlEndpointBuilderFactory.DebeziumMySqlEndpointBuilder 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: int type. Group: consumer
      Parameters:
      offsetStoragePartitions - the value to set
      Returns:
      the dsl builder

    • offsetStoragePartitions

      default DebeziumMySqlEndpointBuilderFactory.DebeziumMySqlEndpointBuilder 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 int type. Group: consumer
      Parameters:
      offsetStoragePartitions - the value to set
      Returns:
      the dsl builder

    • offsetStorageReplicationFactor

      default DebeziumMySqlEndpointBuilderFactory.DebeziumMySqlEndpointBuilder 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: int type. Group: consumer
      Parameters:
      offsetStorageReplicationFactor - the value to set
      Returns:
      the dsl builder

    • offsetStorageReplicationFactor

      default DebeziumMySqlEndpointBuilderFactory.DebeziumMySqlEndpointBuilder 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 int type. Group: consumer
      Parameters:
      offsetStorageReplicationFactor - the value to set
      Returns:
      the dsl builder

    • offsetStorageTopic

      default DebeziumMySqlEndpointBuilderFactory.DebeziumMySqlEndpointBuilder 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: java.lang.String type. Group: consumer
      Parameters:
      offsetStorageTopic - the value to set
      Returns:
      the dsl builder

    • bigintUnsignedHandlingMode

      default DebeziumMySqlEndpointBuilderFactory.DebeziumMySqlEndpointBuilder 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: java.lang.String type. Default: long Group: mysql
      Parameters:
      bigintUnsignedHandlingMode - the value to set
      Returns:
      the dsl builder

    • binlogBufferSize

      default DebeziumMySqlEndpointBuilderFactory.DebeziumMySqlEndpointBuilder 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: int type. Default: 0 Group: mysql
      Parameters:
      binlogBufferSize - the value to set
      Returns:
      the dsl builder

    • binlogBufferSize

      default DebeziumMySqlEndpointBuilderFactory.DebeziumMySqlEndpointBuilder binlogBufferSize(String 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 will be converted to a int type. Default: 0 Group: mysql
      Parameters:
      binlogBufferSize - the value to set
      Returns:
      the dsl builder

    • columnExcludeList

      default DebeziumMySqlEndpointBuilderFactory.DebeziumMySqlEndpointBuilder columnExcludeList(String columnExcludeList)
      Regular expressions matching columns to exclude from change events. The option is a: java.lang.String type. Group: mysql
      Parameters:
      columnExcludeList - the value to set
      Returns:
      the dsl builder

    • columnIncludeList

      default DebeziumMySqlEndpointBuilderFactory.DebeziumMySqlEndpointBuilder columnIncludeList(String columnIncludeList)
      Regular expressions matching columns to include in change events. The option is a: java.lang.String type. Group: mysql
      Parameters:
      columnIncludeList - the value to set
      Returns:
      the dsl builder

    • columnPropagateSourceType

      default DebeziumMySqlEndpointBuilderFactory.DebeziumMySqlEndpointBuilder 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: java.lang.String type. Group: mysql
      Parameters:
      columnPropagateSourceType - the value to set
      Returns:
      the dsl builder

    • connectKeepAlive

      default DebeziumMySqlEndpointBuilderFactory.DebeziumMySqlEndpointBuilder connectKeepAlive(boolean connectKeepAlive)
      Whether a separate thread should be used to ensure the connection is kept alive. The option is a: boolean type. Default: true Group: mysql
      Parameters:
      connectKeepAlive - the value to set
      Returns:
      the dsl builder

    • connectKeepAlive

      default DebeziumMySqlEndpointBuilderFactory.DebeziumMySqlEndpointBuilder connectKeepAlive(String connectKeepAlive)
      Whether a separate thread should be used to ensure the connection is kept alive. The option will be converted to a boolean type. Default: true Group: mysql
      Parameters:
      connectKeepAlive - the value to set
      Returns:
      the dsl builder

    • connectKeepAliveIntervalMs

      default DebeziumMySqlEndpointBuilderFactory.DebeziumMySqlEndpointBuilder 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: long type. Default: 1m Group: mysql
      Parameters:
      connectKeepAliveIntervalMs - the value to set
      Returns:
      the dsl builder

    • connectKeepAliveIntervalMs

      default DebeziumMySqlEndpointBuilderFactory.DebeziumMySqlEndpointBuilder connectKeepAliveIntervalMs(String connectKeepAliveIntervalMs)
      Interval for connection checking if keep alive thread is used, given in milliseconds Defaults to 1 minute (60,000 ms). The option will be converted to a long type. Default: 1m Group: mysql
      Parameters:
      connectKeepAliveIntervalMs - the value to set
      Returns:
      the dsl builder

    • connectTimeoutMs

      default DebeziumMySqlEndpointBuilderFactory.DebeziumMySqlEndpointBuilder 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: int type. Default: 30s Group: mysql
      Parameters:
      connectTimeoutMs - the value to set
      Returns:
      the dsl builder

    • connectTimeoutMs

      default DebeziumMySqlEndpointBuilderFactory.DebeziumMySqlEndpointBuilder connectTimeoutMs(String 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 will be converted to a int type. Default: 30s Group: mysql
      Parameters:
      connectTimeoutMs - the value to set
      Returns:
      the dsl builder

    • converters

      default DebeziumMySqlEndpointBuilderFactory.DebeziumMySqlEndpointBuilder 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: java.lang.String type. Group: mysql
      Parameters:
      converters - the value to set
      Returns:
      the dsl builder

    • customMetricTags

      default DebeziumMySqlEndpointBuilderFactory.DebeziumMySqlEndpointBuilder customMetricTags(String customMetricTags)
      The custom metric tags will accept key-value pairs to customize the MBean object name which should be appended the end of regular name, each key would represent a tag for the MBean object name, and the corresponding value would be the value of that tag the key is. For example: k1=v1,k2=v2. The option is a: java.lang.String type. Group: mysql
      Parameters:
      customMetricTags - the value to set
      Returns:
      the dsl builder

    • databaseExcludeList

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

    • databaseHostname

      default DebeziumMySqlEndpointBuilderFactory.DebeziumMySqlEndpointBuilder databaseHostname(String databaseHostname)
      Resolvable hostname or IP address of the database server. The option is a: java.lang.String type. Group: mysql
      Parameters:
      databaseHostname - the value to set
      Returns:
      the dsl builder

    • databaseIncludeList

      default DebeziumMySqlEndpointBuilderFactory.DebeziumMySqlEndpointBuilder databaseIncludeList(String databaseIncludeList)
      The databases for which changes are to be captured. The option is a: java.lang.String type. Group: mysql
      Parameters:
      databaseIncludeList - the value to set
      Returns:
      the dsl builder

    • databaseInitialStatements

      default DebeziumMySqlEndpointBuilderFactory.DebeziumMySqlEndpointBuilder 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: java.lang.String type. Group: mysql
      Parameters:
      databaseInitialStatements - the value to set
      Returns:
      the dsl builder

    • databaseJdbcDriver

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

    • databasePassword

      default DebeziumMySqlEndpointBuilderFactory.DebeziumMySqlEndpointBuilder databasePassword(String databasePassword)
      Password of the database user to be used when connecting to the database. The option is a: java.lang.String type. Required: true Group: mysql
      Parameters:
      databasePassword - the value to set
      Returns:
      the dsl builder

    • databasePort

      default DebeziumMySqlEndpointBuilderFactory.DebeziumMySqlEndpointBuilder databasePort(int databasePort)
      Port of the database server. The option is a: int type. Default: 3306 Group: mysql
      Parameters:
      databasePort - the value to set
      Returns:
      the dsl builder

    • databasePort

      default DebeziumMySqlEndpointBuilderFactory.DebeziumMySqlEndpointBuilder databasePort(String databasePort)
      Port of the database server. The option will be converted to a int type. Default: 3306 Group: mysql
      Parameters:
      databasePort - the value to set
      Returns:
      the dsl builder

    • databaseProtocol

      default DebeziumMySqlEndpointBuilderFactory.DebeziumMySqlEndpointBuilder databaseProtocol(String databaseProtocol)
      JDBC protocol to use with the driver. The option is a: java.lang.String type. Default: jdbc:mysql Group: mysql
      Parameters:
      databaseProtocol - the value to set
      Returns:
      the dsl builder

    • databaseQueryTimeoutMs

      default DebeziumMySqlEndpointBuilderFactory.DebeziumMySqlEndpointBuilder databaseQueryTimeoutMs(int databaseQueryTimeoutMs)
      Time to wait for a query to execute, given in milliseconds. Defaults to 600 seconds (600,000 ms); zero means there is no limit. The option is a: int type. Default: 10m Group: mysql
      Parameters:
      databaseQueryTimeoutMs - the value to set
      Returns:
      the dsl builder

    • databaseQueryTimeoutMs

      default DebeziumMySqlEndpointBuilderFactory.DebeziumMySqlEndpointBuilder databaseQueryTimeoutMs(String databaseQueryTimeoutMs)
      Time to wait for a query to execute, given in milliseconds. Defaults to 600 seconds (600,000 ms); zero means there is no limit. The option will be converted to a int type. Default: 10m Group: mysql
      Parameters:
      databaseQueryTimeoutMs - the value to set
      Returns:
      the dsl builder

    • databaseServerId

      default DebeziumMySqlEndpointBuilderFactory.DebeziumMySqlEndpointBuilder 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 database cluster as another server (with this unique ID) so it can read the binlog. The option is a: long type. Group: mysql
      Parameters:
      databaseServerId - the value to set
      Returns:
      the dsl builder

    • databaseServerId

      default DebeziumMySqlEndpointBuilderFactory.DebeziumMySqlEndpointBuilder databaseServerId(String 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 database cluster as another server (with this unique ID) so it can read the binlog. The option will be converted to a long type. Group: mysql
      Parameters:
      databaseServerId - the value to set
      Returns:
      the dsl builder

    • databaseServerIdOffset

      default DebeziumMySqlEndpointBuilderFactory.DebeziumMySqlEndpointBuilder 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: long type. Default: 10000 Group: mysql
      Parameters:
      databaseServerIdOffset - the value to set
      Returns:
      the dsl builder

    • databaseServerIdOffset

      default DebeziumMySqlEndpointBuilderFactory.DebeziumMySqlEndpointBuilder databaseServerIdOffset(String 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 will be converted to a long type. Default: 10000 Group: mysql
      Parameters:
      databaseServerIdOffset - the value to set
      Returns:
      the dsl builder

    • databaseSslKeystore

      default DebeziumMySqlEndpointBuilderFactory.DebeziumMySqlEndpointBuilder 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 database. The option is a: java.lang.String type. Group: mysql
      Parameters:
      databaseSslKeystore - the value to set
      Returns:
      the dsl builder

    • databaseSslKeystorePassword

      default DebeziumMySqlEndpointBuilderFactory.DebeziumMySqlEndpointBuilder 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: java.lang.String type. Group: mysql
      Parameters:
      databaseSslKeystorePassword - the value to set
      Returns:
      the dsl builder

    • databaseSslMode

      default DebeziumMySqlEndpointBuilderFactory.DebeziumMySqlEndpointBuilder databaseSslMode(String databaseSslMode)
      Whether to use an encrypted connection to the database. Options include: 'disabled' to use an unencrypted connection; 'preferred' (the default) 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: java.lang.String type. Default: preferred Group: mysql
      Parameters:
      databaseSslMode - the value to set
      Returns:
      the dsl builder

    • databaseSslTruststore

      default DebeziumMySqlEndpointBuilderFactory.DebeziumMySqlEndpointBuilder databaseSslTruststore(String databaseSslTruststore)
      The location of the trust store file for the server certificate verification. The option is a: java.lang.String type. Group: mysql
      Parameters:
      databaseSslTruststore - the value to set
      Returns:
      the dsl builder

    • databaseSslTruststorePassword

      default DebeziumMySqlEndpointBuilderFactory.DebeziumMySqlEndpointBuilder 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: java.lang.String type. Group: mysql
      Parameters:
      databaseSslTruststorePassword - the value to set
      Returns:
      the dsl builder

    • databaseUser

      default DebeziumMySqlEndpointBuilderFactory.DebeziumMySqlEndpointBuilder databaseUser(String databaseUser)
      Name of the database user to be used when connecting to the database. The option is a: java.lang.String type. Group: mysql
      Parameters:
      databaseUser - the value to set
      Returns:
      the dsl builder

    • datatypePropagateSourceType

      default DebeziumMySqlEndpointBuilderFactory.DebeziumMySqlEndpointBuilder 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: java.lang.String type. Group: mysql
      Parameters:
      datatypePropagateSourceType - the value to set
      Returns:
      the dsl builder

    • decimalHandlingMode

      default DebeziumMySqlEndpointBuilderFactory.DebeziumMySqlEndpointBuilder 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: java.lang.String type. Default: precise Group: mysql
      Parameters:
      decimalHandlingMode - the value to set
      Returns:
      the dsl builder

    • enableTimeAdjuster

      default DebeziumMySqlEndpointBuilderFactory.DebeziumMySqlEndpointBuilder enableTimeAdjuster(boolean enableTimeAdjuster)
      The database allows the 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 database; true - (the default) Debezium makes the conversion. The option is a: boolean type. Default: true Group: mysql
      Parameters:
      enableTimeAdjuster - the value to set
      Returns:
      the dsl builder

    • enableTimeAdjuster

      default DebeziumMySqlEndpointBuilderFactory.DebeziumMySqlEndpointBuilder enableTimeAdjuster(String enableTimeAdjuster)
      The database allows the 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 database; true - (the default) Debezium makes the conversion. The option will be converted to a boolean type. Default: true Group: mysql
      Parameters:
      enableTimeAdjuster - the value to set
      Returns:
      the dsl builder

    • errorsMaxRetries

      default DebeziumMySqlEndpointBuilderFactory.DebeziumMySqlEndpointBuilder errorsMaxRetries(int errorsMaxRetries)
      The maximum number of retries on connection errors before failing (-1 = no limit, 0 = disabled, 0 = num of retries). The option is a: int type. Default: -1 Group: mysql
      Parameters:
      errorsMaxRetries - the value to set
      Returns:
      the dsl builder

    • errorsMaxRetries

      default DebeziumMySqlEndpointBuilderFactory.DebeziumMySqlEndpointBuilder errorsMaxRetries(String errorsMaxRetries)
      The maximum number of retries on connection errors before failing (-1 = no limit, 0 = disabled, 0 = num of retries). The option will be converted to a int type. Default: -1 Group: mysql
      Parameters:
      errorsMaxRetries - the value to set
      Returns:
      the dsl builder

    • eventDeserializationFailureHandlingMode

      default DebeziumMySqlEndpointBuilderFactory.DebeziumMySqlEndpointBuilder 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: java.lang.String type. Default: fail Group: mysql
      Parameters:
      eventDeserializationFailureHandlingMode - the value to set
      Returns:
      the dsl builder

    • eventProcessingFailureHandlingMode

      default DebeziumMySqlEndpointBuilderFactory.DebeziumMySqlEndpointBuilder 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: java.lang.String type. Default: fail Group: mysql
      Parameters:
      eventProcessingFailureHandlingMode - the value to set
      Returns:
      the dsl builder

    • gtidSourceExcludes

      default DebeziumMySqlEndpointBuilderFactory.DebeziumMySqlEndpointBuilder 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: java.lang.String type. Group: mysql
      Parameters:
      gtidSourceExcludes - the value to set
      Returns:
      the dsl builder

    • gtidSourceFilterDmlEvents

      default DebeziumMySqlEndpointBuilderFactory.DebeziumMySqlEndpointBuilder gtidSourceFilterDmlEvents(boolean gtidSourceFilterDmlEvents)
      When set to true, only produce DML events for transactions that were written on the server with matching GTIDs defined by the gtid.source.includes or gtid.source.excludes, if they were specified. The option is a: boolean type. Default: true Group: mysql
      Parameters:
      gtidSourceFilterDmlEvents - the value to set
      Returns:
      the dsl builder

    • gtidSourceFilterDmlEvents

      default DebeziumMySqlEndpointBuilderFactory.DebeziumMySqlEndpointBuilder gtidSourceFilterDmlEvents(String gtidSourceFilterDmlEvents)
      When set to true, only produce DML events for transactions that were written on the server with matching GTIDs defined by the gtid.source.includes or gtid.source.excludes, if they were specified. The option will be converted to a boolean type. Default: true Group: mysql
      Parameters:
      gtidSourceFilterDmlEvents - the value to set
      Returns:
      the dsl builder

    • gtidSourceIncludes

      default DebeziumMySqlEndpointBuilderFactory.DebeziumMySqlEndpointBuilder 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: java.lang.String type. Group: mysql
      Parameters:
      gtidSourceIncludes - the value to set
      Returns:
      the dsl builder

    • heartbeatActionQuery

      default DebeziumMySqlEndpointBuilderFactory.DebeziumMySqlEndpointBuilder heartbeatActionQuery(String heartbeatActionQuery)
      The query executed with every heartbeat. The option is a: java.lang.String type. Group: mysql
      Parameters:
      heartbeatActionQuery - the value to set
      Returns:
      the dsl builder

    • heartbeatIntervalMs

      default DebeziumMySqlEndpointBuilderFactory.DebeziumMySqlEndpointBuilder 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: int type. Default: 0ms Group: mysql
      Parameters:
      heartbeatIntervalMs - the value to set
      Returns:
      the dsl builder

    • heartbeatIntervalMs

      default DebeziumMySqlEndpointBuilderFactory.DebeziumMySqlEndpointBuilder 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 int type. Default: 0ms Group: mysql
      Parameters:
      heartbeatIntervalMs - the value to set
      Returns:
      the dsl builder

    • heartbeatTopicsPrefix

      default DebeziumMySqlEndpointBuilderFactory.DebeziumMySqlEndpointBuilder heartbeatTopicsPrefix(String heartbeatTopicsPrefix)
      The prefix that is used to name heartbeat topics.Defaults to __debezium-heartbeat. The option is a: java.lang.String type. Default: __debezium-heartbeat Group: mysql
      Parameters:
      heartbeatTopicsPrefix - the value to set
      Returns:
      the dsl builder

    • includeQuery

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

    • includeQuery

      default DebeziumMySqlEndpointBuilderFactory.DebeziumMySqlEndpointBuilder includeQuery(String includeQuery)
      Whether the connector should include the original SQL query that generated the change event. Note: This option requires the database to be configured using the server option binlog_rows_query_log_events (MySQL) or binlog_annotate_row_events (MariaDB) set to ON.Query will not be present for events generated from snapshot. WARNING: Enabling this option may expose tables or fields explicitly excluded or masked by including the original SQL statement in the change event. For this reason the default value is 'false'. The option will be converted to a boolean type. Default: false Group: mysql
      Parameters:
      includeQuery - the value to set
      Returns:
      the dsl builder

    • includeSchemaChanges

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

    • includeSchemaChanges

      default DebeziumMySqlEndpointBuilderFactory.DebeziumMySqlEndpointBuilder 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 schema history. The option will be converted to a boolean type. Default: true Group: mysql
      Parameters:
      includeSchemaChanges - the value to set
      Returns:
      the dsl builder

    • includeSchemaComments

      default DebeziumMySqlEndpointBuilderFactory.DebeziumMySqlEndpointBuilder 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: boolean type. Default: false Group: mysql
      Parameters:
      includeSchemaComments - the value to set
      Returns:
      the dsl builder

    • includeSchemaComments

      default DebeziumMySqlEndpointBuilderFactory.DebeziumMySqlEndpointBuilder 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 boolean type. Default: false Group: mysql
      Parameters:
      includeSchemaComments - the value to set
      Returns:
      the dsl builder

    • inconsistentSchemaHandlingMode

      default DebeziumMySqlEndpointBuilderFactory.DebeziumMySqlEndpointBuilder 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: java.lang.String type. Default: fail Group: mysql
      Parameters:
      inconsistentSchemaHandlingMode - the value to set
      Returns:
      the dsl builder

    • incrementalSnapshotAllowSchemaChanges

      default DebeziumMySqlEndpointBuilderFactory.DebeziumMySqlEndpointBuilder 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: boolean type. Default: false Group: mysql
      Parameters:
      incrementalSnapshotAllowSchemaChanges - the value to set
      Returns:
      the dsl builder

    • incrementalSnapshotAllowSchemaChanges

      default DebeziumMySqlEndpointBuilderFactory.DebeziumMySqlEndpointBuilder incrementalSnapshotAllowSchemaChanges(String 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 will be converted to a boolean type. Default: false Group: mysql
      Parameters:
      incrementalSnapshotAllowSchemaChanges - the value to set
      Returns:
      the dsl builder

    • incrementalSnapshotChunkSize

      default DebeziumMySqlEndpointBuilderFactory.DebeziumMySqlEndpointBuilder incrementalSnapshotChunkSize(int incrementalSnapshotChunkSize)
      The maximum size of chunk (number of documents/rows) for incremental snapshotting. The option is a: int type. Default: 1024 Group: mysql
      Parameters:
      incrementalSnapshotChunkSize - the value to set
      Returns:
      the dsl builder

    • incrementalSnapshotChunkSize

      default DebeziumMySqlEndpointBuilderFactory.DebeziumMySqlEndpointBuilder incrementalSnapshotChunkSize(String incrementalSnapshotChunkSize)
      The maximum size of chunk (number of documents/rows) for incremental snapshotting. The option will be converted to a int type. Default: 1024 Group: mysql
      Parameters:
      incrementalSnapshotChunkSize - the value to set
      Returns:
      the dsl builder

    • incrementalSnapshotWatermarkingStrategy

      default DebeziumMySqlEndpointBuilderFactory.DebeziumMySqlEndpointBuilder incrementalSnapshotWatermarkingStrategy(String incrementalSnapshotWatermarkingStrategy)
      Specify the strategy used for watermarking during an incremental snapshot: 'insert_insert' both open and close signal is written into signal data collection (default); 'insert_delete' only open signal is written on signal data collection, the close will delete the relative open signal;. The option is a: java.lang.String type. Default: INSERT_INSERT Group: mysql
      Parameters:
      incrementalSnapshotWatermarkingStrategy - the value to set
      Returns:
      the dsl builder

    • maxBatchSize

      default DebeziumMySqlEndpointBuilderFactory.DebeziumMySqlEndpointBuilder maxBatchSize(int maxBatchSize)
      Maximum size of each batch of source records. Defaults to 2048. The option is a: int type. Default: 2048 Group: mysql
      Parameters:
      maxBatchSize - the value to set
      Returns:
      the dsl builder

    • maxBatchSize

      default DebeziumMySqlEndpointBuilderFactory.DebeziumMySqlEndpointBuilder maxBatchSize(String maxBatchSize)
      Maximum size of each batch of source records. Defaults to 2048. The option will be converted to a int type. Default: 2048 Group: mysql
      Parameters:
      maxBatchSize - the value to set
      Returns:
      the dsl builder

    • maxQueueSize

      default DebeziumMySqlEndpointBuilderFactory.DebeziumMySqlEndpointBuilder 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: int type. Default: 8192 Group: mysql
      Parameters:
      maxQueueSize - the value to set
      Returns:
      the dsl builder

    • maxQueueSize

      default DebeziumMySqlEndpointBuilderFactory.DebeziumMySqlEndpointBuilder 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 int type. Default: 8192 Group: mysql
      Parameters:
      maxQueueSize - the value to set
      Returns:
      the dsl builder

    • maxQueueSizeInBytes

      default DebeziumMySqlEndpointBuilderFactory.DebeziumMySqlEndpointBuilder 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: long type. Default: 0 Group: mysql
      Parameters:
      maxQueueSizeInBytes - the value to set
      Returns:
      the dsl builder

    • maxQueueSizeInBytes

      default DebeziumMySqlEndpointBuilderFactory.DebeziumMySqlEndpointBuilder 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 long type. Default: 0 Group: mysql
      Parameters:
      maxQueueSizeInBytes - the value to set
      Returns:
      the dsl builder

    • messageKeyColumns

      default DebeziumMySqlEndpointBuilderFactory.DebeziumMySqlEndpointBuilder 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: java.lang.String type. Group: mysql
      Parameters:
      messageKeyColumns - the value to set
      Returns:
      the dsl builder

    • minRowCountToStreamResults

      default DebeziumMySqlEndpointBuilderFactory.DebeziumMySqlEndpointBuilder 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: int type. Default: 1000 Group: mysql
      Parameters:
      minRowCountToStreamResults - the value to set
      Returns:
      the dsl builder

    • minRowCountToStreamResults

      default DebeziumMySqlEndpointBuilderFactory.DebeziumMySqlEndpointBuilder minRowCountToStreamResults(String 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 will be converted to a int type. Default: 1000 Group: mysql
      Parameters:
      minRowCountToStreamResults - the value to set
      Returns:
      the dsl builder

    • notificationEnabledChannels

      default DebeziumMySqlEndpointBuilderFactory.DebeziumMySqlEndpointBuilder notificationEnabledChannels(String notificationEnabledChannels)
      List of notification channels names that are enabled. The option is a: java.lang.String type. Group: mysql
      Parameters:
      notificationEnabledChannels - the value to set
      Returns:
      the dsl builder

    • notificationSinkTopicName

      default DebeziumMySqlEndpointBuilderFactory.DebeziumMySqlEndpointBuilder notificationSinkTopicName(String notificationSinkTopicName)
      The name of the topic for the notifications. This is required in case 'sink' is in the list of enabled channels. The option is a: java.lang.String type. Group: mysql
      Parameters:
      notificationSinkTopicName - the value to set
      Returns:
      the dsl builder

    • pollIntervalMs

      default DebeziumMySqlEndpointBuilderFactory.DebeziumMySqlEndpointBuilder 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: long type. Default: 500ms Group: mysql
      Parameters:
      pollIntervalMs - the value to set
      Returns:
      the dsl builder

    • pollIntervalMs

      default DebeziumMySqlEndpointBuilderFactory.DebeziumMySqlEndpointBuilder 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 long type. Default: 500ms Group: mysql
      Parameters:
      pollIntervalMs - the value to set
      Returns:
      the dsl builder

    • postProcessors

      default DebeziumMySqlEndpointBuilderFactory.DebeziumMySqlEndpointBuilder postProcessors(String postProcessors)
      Optional list of post processors. The processors are defined using '.type' config option and configured using options ''. The option is a: java.lang.String type. Group: mysql
      Parameters:
      postProcessors - the value to set
      Returns:
      the dsl builder

    • provideTransactionMetadata

      default DebeziumMySqlEndpointBuilderFactory.DebeziumMySqlEndpointBuilder provideTransactionMetadata(boolean provideTransactionMetadata)
      Enables transaction metadata extraction together with event counting. The option is a: boolean type. Default: false Group: mysql
      Parameters:
      provideTransactionMetadata - the value to set
      Returns:
      the dsl builder

    • provideTransactionMetadata

      default DebeziumMySqlEndpointBuilderFactory.DebeziumMySqlEndpointBuilder provideTransactionMetadata(String provideTransactionMetadata)
      Enables transaction metadata extraction together with event counting. The option will be converted to a boolean type. Default: false Group: mysql
      Parameters:
      provideTransactionMetadata - the value to set
      Returns:
      the dsl builder

    • queryFetchSize

      default DebeziumMySqlEndpointBuilderFactory.DebeziumMySqlEndpointBuilder 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: int type. Default: 0 Group: mysql
      Parameters:
      queryFetchSize - the value to set
      Returns:
      the dsl builder

    • queryFetchSize

      default DebeziumMySqlEndpointBuilderFactory.DebeziumMySqlEndpointBuilder 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 int type. Default: 0 Group: mysql
      Parameters:
      queryFetchSize - the value to set
      Returns:
      the dsl builder

    • retriableRestartConnectorWaitMs

      default DebeziumMySqlEndpointBuilderFactory.DebeziumMySqlEndpointBuilder retriableRestartConnectorWaitMs(long retriableRestartConnectorWaitMs)
      Time to wait before restarting connector after retriable exception occurs. Defaults to 10000ms. The option is a: long type. Default: 10s Group: mysql
      Parameters:
      retriableRestartConnectorWaitMs - the value to set
      Returns:
      the dsl builder

    • retriableRestartConnectorWaitMs

      default DebeziumMySqlEndpointBuilderFactory.DebeziumMySqlEndpointBuilder retriableRestartConnectorWaitMs(String retriableRestartConnectorWaitMs)
      Time to wait before restarting connector after retriable exception occurs. Defaults to 10000ms. The option will be converted to a long type. Default: 10s Group: mysql
      Parameters:
      retriableRestartConnectorWaitMs - the value to set
      Returns:
      the dsl builder

    • schemaHistoryInternal

      default DebeziumMySqlEndpointBuilderFactory.DebeziumMySqlEndpointBuilder schemaHistoryInternal(String schemaHistoryInternal)
      The name of the SchemaHistory class that should be used to store and recover database schema changes. The configuration properties for the history are prefixed with the 'schema.history.internal.' string. The option is a: java.lang.String type. Default: io.debezium.storage.kafka.history.KafkaSchemaHistory Group: mysql
      Parameters:
      schemaHistoryInternal - the value to set
      Returns:
      the dsl builder

    • schemaHistoryInternalFileFilename

      default DebeziumMySqlEndpointBuilderFactory.DebeziumMySqlEndpointBuilder schemaHistoryInternalFileFilename(String schemaHistoryInternalFileFilename)
      The path to the file that will be used to record the database schema history. The option is a: java.lang.String type. Group: mysql
      Parameters:
      schemaHistoryInternalFileFilename - the value to set
      Returns:
      the dsl builder

    • schemaHistoryInternalSkipUnparseableDdl

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

    • schemaHistoryInternalSkipUnparseableDdl

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

    • schemaHistoryInternalStoreOnlyCapturedDatabasesDdl

      default DebeziumMySqlEndpointBuilderFactory.DebeziumMySqlEndpointBuilder schemaHistoryInternalStoreOnlyCapturedDatabasesDdl(boolean schemaHistoryInternalStoreOnlyCapturedDatabasesDdl)
      Controls what DDL will Debezium store in database schema history. By default (true) only DDL that manipulates a table from captured schema/database will be stored. If set to false, then Debezium will store all incoming DDL statements. The option is a: boolean type. Default: true Group: mysql
      Parameters:
      schemaHistoryInternalStoreOnlyCapturedDatabasesDdl - the value to set
      Returns:
      the dsl builder

    • schemaHistoryInternalStoreOnlyCapturedDatabasesDdl

      default DebeziumMySqlEndpointBuilderFactory.DebeziumMySqlEndpointBuilder schemaHistoryInternalStoreOnlyCapturedDatabasesDdl(String schemaHistoryInternalStoreOnlyCapturedDatabasesDdl)
      Controls what DDL will Debezium store in database schema history. By default (true) only DDL that manipulates a table from captured schema/database will be stored. If set to false, then Debezium will store all incoming DDL statements. The option will be converted to a boolean type. Default: true Group: mysql
      Parameters:
      schemaHistoryInternalStoreOnlyCapturedDatabasesDdl - the value to set
      Returns:
      the dsl builder

    • schemaHistoryInternalStoreOnlyCapturedTablesDdl

      default DebeziumMySqlEndpointBuilderFactory.DebeziumMySqlEndpointBuilder schemaHistoryInternalStoreOnlyCapturedTablesDdl(boolean schemaHistoryInternalStoreOnlyCapturedTablesDdl)
      Controls what DDL will Debezium store in database schema history. By default (false) Debezium will store all incoming DDL statements. If set to true, then only DDL that manipulates a captured table will be stored. The option is a: boolean type. Default: false Group: mysql
      Parameters:
      schemaHistoryInternalStoreOnlyCapturedTablesDdl - the value to set
      Returns:
      the dsl builder

    • schemaHistoryInternalStoreOnlyCapturedTablesDdl

      default DebeziumMySqlEndpointBuilderFactory.DebeziumMySqlEndpointBuilder schemaHistoryInternalStoreOnlyCapturedTablesDdl(String schemaHistoryInternalStoreOnlyCapturedTablesDdl)
      Controls what DDL will Debezium store in database schema history. By default (false) Debezium will store all incoming DDL statements. If set to true, then only DDL that manipulates a captured table will be stored. The option will be converted to a boolean type. Default: false Group: mysql
      Parameters:
      schemaHistoryInternalStoreOnlyCapturedTablesDdl - the value to set
      Returns:
      the dsl builder

    • schemaNameAdjustmentMode

      default DebeziumMySqlEndpointBuilderFactory.DebeziumMySqlEndpointBuilder schemaNameAdjustmentMode(String schemaNameAdjustmentMode)
      Specify how schema names should be adjusted for compatibility with the message converter used by the connector, including: 'avro' replaces the characters that cannot be used in the Avro type name with underscore; 'avro_unicode' replaces the underscore or characters that cannot be used in the Avro type name with corresponding unicode like _uxxxx. Note: _ is an escape sequence like backslash in Java;'none' does not apply any adjustment (default). The option is a: java.lang.String type. Default: none Group: mysql
      Parameters:
      schemaNameAdjustmentMode - the value to set
      Returns:
      the dsl builder

    • signalDataCollection

      default DebeziumMySqlEndpointBuilderFactory.DebeziumMySqlEndpointBuilder 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: java.lang.String type. Group: mysql
      Parameters:
      signalDataCollection - the value to set
      Returns:
      the dsl builder

    • signalEnabledChannels

      default DebeziumMySqlEndpointBuilderFactory.DebeziumMySqlEndpointBuilder signalEnabledChannels(String signalEnabledChannels)
      List of channels names that are enabled. Source channel is enabled by default. The option is a: java.lang.String type. Default: source Group: mysql
      Parameters:
      signalEnabledChannels - the value to set
      Returns:
      the dsl builder

    • signalPollIntervalMs

      default DebeziumMySqlEndpointBuilderFactory.DebeziumMySqlEndpointBuilder signalPollIntervalMs(long signalPollIntervalMs)
      Interval for looking for new signals in registered channels, given in milliseconds. Defaults to 5 seconds. The option is a: long type. Default: 5s Group: mysql
      Parameters:
      signalPollIntervalMs - the value to set
      Returns:
      the dsl builder

    • signalPollIntervalMs

      default DebeziumMySqlEndpointBuilderFactory.DebeziumMySqlEndpointBuilder signalPollIntervalMs(String signalPollIntervalMs)
      Interval for looking for new signals in registered channels, given in milliseconds. Defaults to 5 seconds. The option will be converted to a long type. Default: 5s Group: mysql
      Parameters:
      signalPollIntervalMs - the value to set
      Returns:
      the dsl builder

    • skippedOperations

      default DebeziumMySqlEndpointBuilderFactory.DebeziumMySqlEndpointBuilder skippedOperations(String skippedOperations)
      The comma-separated list of operations to skip during streaming, defined as: 'c' for inserts/create; 'u' for updates; 'd' for deletes, 't' for truncates, and 'none' to indicate nothing skipped. By default, only truncate operations will be skipped. The option is a: java.lang.String type. Default: t Group: mysql
      Parameters:
      skippedOperations - the value to set
      Returns:
      the dsl builder

    • snapshotDelayMs

      default DebeziumMySqlEndpointBuilderFactory.DebeziumMySqlEndpointBuilder snapshotDelayMs(long snapshotDelayMs)
      A delay period before a snapshot will begin, given in milliseconds. Defaults to 0 ms. The option is a: long type. Default: 0ms Group: mysql
      Parameters:
      snapshotDelayMs - the value to set
      Returns:
      the dsl builder

    • snapshotDelayMs

      default DebeziumMySqlEndpointBuilderFactory.DebeziumMySqlEndpointBuilder 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 long type. Default: 0ms Group: mysql
      Parameters:
      snapshotDelayMs - the value to set
      Returns:
      the dsl builder

    • snapshotFetchSize

      default DebeziumMySqlEndpointBuilderFactory.DebeziumMySqlEndpointBuilder snapshotFetchSize(int snapshotFetchSize)
      The maximum number of records that should be loaded into memory while performing a snapshot. The option is a: int type. Group: mysql
      Parameters:
      snapshotFetchSize - the value to set
      Returns:
      the dsl builder

    • snapshotFetchSize

      default DebeziumMySqlEndpointBuilderFactory.DebeziumMySqlEndpointBuilder 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 int type. Group: mysql
      Parameters:
      snapshotFetchSize - the value to set
      Returns:
      the dsl builder

    • snapshotIncludeCollectionList

      default DebeziumMySqlEndpointBuilderFactory.DebeziumMySqlEndpointBuilder 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: java.lang.String type. Group: mysql
      Parameters:
      snapshotIncludeCollectionList - the value to set
      Returns:
      the dsl builder

    • snapshotLockingMode

      default DebeziumMySqlEndpointBuilderFactory.DebeziumMySqlEndpointBuilder 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: java.lang.String type. Default: minimal Group: mysql
      Parameters:
      snapshotLockingMode - the value to set
      Returns:
      the dsl builder

    • snapshotLockTimeoutMs

      default DebeziumMySqlEndpointBuilderFactory.DebeziumMySqlEndpointBuilder 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: long type. Default: 10s Group: mysql
      Parameters:
      snapshotLockTimeoutMs - the value to set
      Returns:
      the dsl builder

    • snapshotLockTimeoutMs

      default DebeziumMySqlEndpointBuilderFactory.DebeziumMySqlEndpointBuilder 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 long type. Default: 10s Group: mysql
      Parameters:
      snapshotLockTimeoutMs - the value to set
      Returns:
      the dsl builder

    • snapshotMaxThreads

      default DebeziumMySqlEndpointBuilderFactory.DebeziumMySqlEndpointBuilder snapshotMaxThreads(int snapshotMaxThreads)
      The maximum number of threads used to perform the snapshot. Defaults to 1. The option is a: int type. Default: 1 Group: mysql
      Parameters:
      snapshotMaxThreads - the value to set
      Returns:
      the dsl builder

    • snapshotMaxThreads

      default DebeziumMySqlEndpointBuilderFactory.DebeziumMySqlEndpointBuilder snapshotMaxThreads(String snapshotMaxThreads)
      The maximum number of threads used to perform the snapshot. Defaults to 1. The option will be converted to a int type. Default: 1 Group: mysql
      Parameters:
      snapshotMaxThreads - the value to set
      Returns:
      the dsl builder

    • snapshotMode

      default DebeziumMySqlEndpointBuilderFactory.DebeziumMySqlEndpointBuilder snapshotMode(String snapshotMode)
      The criteria for running a snapshot upon startup of the connector. Select one of the following snapshot options: 'when_needed': On startup, the connector runs a snapshot if one is needed.; 'schema_only': If the connector does not detect any offsets for the logical server name, it runs a snapshot that captures only the schema (table structures), but not any table data. After the snapshot completes, the connector begins to stream changes from the binlog.; 'schema_only_recovery': The connector performs a snapshot that captures only the database schema history. The connector then transitions back to streaming. Use this setting to restore a corrupted or lost database schema history topic. Do not use if the database schema was modified after the connector stopped.; 'initial' (default): If the connector does not detect any offsets for the logical server name, it runs a snapshot that captures the current full state of the configured tables. After the snapshot completes, the connector begins to stream changes from the binlog.; 'initial_only': The connector performs a snapshot as it does for the 'initial' option, but after the connector completes the snapshot, it stops, and does not stream changes from the binlog.; 'never': The connector does not run a snapshot. Upon first startup, the connector immediately begins reading 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: java.lang.String type. Default: initial Group: mysql
      Parameters:
      snapshotMode - the value to set
      Returns:
      the dsl builder

    • snapshotModeConfigurationBasedSnapshotData

      default DebeziumMySqlEndpointBuilderFactory.DebeziumMySqlEndpointBuilder snapshotModeConfigurationBasedSnapshotData(boolean snapshotModeConfigurationBasedSnapshotData)
      When 'snapshot.mode' is set as configuration_based, this setting permits to specify whenever the data should be snapshotted or not. The option is a: boolean type. Default: false Group: mysql
      Parameters:
      snapshotModeConfigurationBasedSnapshotData - the value to set
      Returns:
      the dsl builder

    • snapshotModeConfigurationBasedSnapshotData

      default DebeziumMySqlEndpointBuilderFactory.DebeziumMySqlEndpointBuilder snapshotModeConfigurationBasedSnapshotData(String snapshotModeConfigurationBasedSnapshotData)
      When 'snapshot.mode' is set as configuration_based, this setting permits to specify whenever the data should be snapshotted or not. The option will be converted to a boolean type. Default: false Group: mysql
      Parameters:
      snapshotModeConfigurationBasedSnapshotData - the value to set
      Returns:
      the dsl builder

    • snapshotModeConfigurationBasedSnapshotOnDataError

      default DebeziumMySqlEndpointBuilderFactory.DebeziumMySqlEndpointBuilder snapshotModeConfigurationBasedSnapshotOnDataError(boolean snapshotModeConfigurationBasedSnapshotOnDataError)
      When 'snapshot.mode' is set as configuration_based, this setting permits to specify whenever the data should be snapshotted or not in case of error. The option is a: boolean type. Default: false Group: mysql
      Parameters:
      snapshotModeConfigurationBasedSnapshotOnDataError - the value to set
      Returns:
      the dsl builder

    • snapshotModeConfigurationBasedSnapshotOnDataError

      default DebeziumMySqlEndpointBuilderFactory.DebeziumMySqlEndpointBuilder snapshotModeConfigurationBasedSnapshotOnDataError(String snapshotModeConfigurationBasedSnapshotOnDataError)
      When 'snapshot.mode' is set as configuration_based, this setting permits to specify whenever the data should be snapshotted or not in case of error. The option will be converted to a boolean type. Default: false Group: mysql
      Parameters:
      snapshotModeConfigurationBasedSnapshotOnDataError - the value to set
      Returns:
      the dsl builder

    • snapshotModeConfigurationBasedSnapshotOnSchemaError

      default DebeziumMySqlEndpointBuilderFactory.DebeziumMySqlEndpointBuilder snapshotModeConfigurationBasedSnapshotOnSchemaError(boolean snapshotModeConfigurationBasedSnapshotOnSchemaError)
      When 'snapshot.mode' is set as configuration_based, this setting permits to specify whenever the schema should be snapshotted or not in case of error. The option is a: boolean type. Default: false Group: mysql
      Parameters:
      snapshotModeConfigurationBasedSnapshotOnSchemaError - the value to set
      Returns:
      the dsl builder

    • snapshotModeConfigurationBasedSnapshotOnSchemaError

      default DebeziumMySqlEndpointBuilderFactory.DebeziumMySqlEndpointBuilder snapshotModeConfigurationBasedSnapshotOnSchemaError(String snapshotModeConfigurationBasedSnapshotOnSchemaError)
      When 'snapshot.mode' is set as configuration_based, this setting permits to specify whenever the schema should be snapshotted or not in case of error. The option will be converted to a boolean type. Default: false Group: mysql
      Parameters:
      snapshotModeConfigurationBasedSnapshotOnSchemaError - the value to set
      Returns:
      the dsl builder

    • snapshotModeConfigurationBasedSnapshotSchema

      default DebeziumMySqlEndpointBuilderFactory.DebeziumMySqlEndpointBuilder snapshotModeConfigurationBasedSnapshotSchema(boolean snapshotModeConfigurationBasedSnapshotSchema)
      When 'snapshot.mode' is set as configuration_based, this setting permits to specify whenever the schema should be snapshotted or not. The option is a: boolean type. Default: false Group: mysql
      Parameters:
      snapshotModeConfigurationBasedSnapshotSchema - the value to set
      Returns:
      the dsl builder

    • snapshotModeConfigurationBasedSnapshotSchema

      default DebeziumMySqlEndpointBuilderFactory.DebeziumMySqlEndpointBuilder snapshotModeConfigurationBasedSnapshotSchema(String snapshotModeConfigurationBasedSnapshotSchema)
      When 'snapshot.mode' is set as configuration_based, this setting permits to specify whenever the schema should be snapshotted or not. The option will be converted to a boolean type. Default: false Group: mysql
      Parameters:
      snapshotModeConfigurationBasedSnapshotSchema - the value to set
      Returns:
      the dsl builder

    • snapshotModeConfigurationBasedStartStream

      default DebeziumMySqlEndpointBuilderFactory.DebeziumMySqlEndpointBuilder snapshotModeConfigurationBasedStartStream(boolean snapshotModeConfigurationBasedStartStream)
      When 'snapshot.mode' is set as configuration_based, this setting permits to specify whenever the stream should start or not after snapshot. The option is a: boolean type. Default: false Group: mysql
      Parameters:
      snapshotModeConfigurationBasedStartStream - the value to set
      Returns:
      the dsl builder

    • snapshotModeConfigurationBasedStartStream

      default DebeziumMySqlEndpointBuilderFactory.DebeziumMySqlEndpointBuilder snapshotModeConfigurationBasedStartStream(String snapshotModeConfigurationBasedStartStream)
      When 'snapshot.mode' is set as configuration_based, this setting permits to specify whenever the stream should start or not after snapshot. The option will be converted to a boolean type. Default: false Group: mysql
      Parameters:
      snapshotModeConfigurationBasedStartStream - the value to set
      Returns:
      the dsl builder

    • snapshotModeCustomName

      default DebeziumMySqlEndpointBuilderFactory.DebeziumMySqlEndpointBuilder snapshotModeCustomName(String snapshotModeCustomName)
      When 'snapshot.mode' is set as custom, this setting must be set to specify a the name of the custom implementation provided in the 'name()' method. The implementations must implement the 'Snapshotter' interface and is called on each app boot to determine whether to do a snapshot. The option is a: java.lang.String type. Group: mysql
      Parameters:
      snapshotModeCustomName - the value to set
      Returns:
      the dsl builder

    • snapshotQueryMode

      default DebeziumMySqlEndpointBuilderFactory.DebeziumMySqlEndpointBuilder snapshotQueryMode(String snapshotQueryMode)
      Controls query used during the snapshot. The option is a: java.lang.String type. Default: select_all Group: mysql
      Parameters:
      snapshotQueryMode - the value to set
      Returns:
      the dsl builder

    • snapshotQueryModeCustomName

      default DebeziumMySqlEndpointBuilderFactory.DebeziumMySqlEndpointBuilder snapshotQueryModeCustomName(String snapshotQueryModeCustomName)
      When 'snapshot.query.mode' is set as custom, this setting must be set to specify a the name of the custom implementation provided in the 'name()' method. The implementations must implement the 'SnapshotterQuery' interface and is called to determine how to build queries during snapshot. The option is a: java.lang.String type. Group: mysql
      Parameters:
      snapshotQueryModeCustomName - the value to set
      Returns:
      the dsl builder

    • snapshotSelectStatementOverrides

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

    • snapshotTablesOrderByRowCount

      default DebeziumMySqlEndpointBuilderFactory.DebeziumMySqlEndpointBuilder snapshotTablesOrderByRowCount(String snapshotTablesOrderByRowCount)
      Controls the order in which tables are processed in the initial snapshot. A descending value will order the tables by row count descending. A ascending value will order the tables by row count ascending. A value of disabled (the default) will disable ordering by row count. The option is a: java.lang.String type. Default: disabled Group: mysql
      Parameters:
      snapshotTablesOrderByRowCount - the value to set
      Returns:
      the dsl builder

    • sourceinfoStructMaker

      default DebeziumMySqlEndpointBuilderFactory.DebeziumMySqlEndpointBuilder sourceinfoStructMaker(String sourceinfoStructMaker)
      The name of the SourceInfoStructMaker class that returns SourceInfo schema and struct. The option is a: java.lang.String type. Default: io.debezium.connector.mysql.MySqlSourceInfoStructMaker Group: mysql
      Parameters:
      sourceinfoStructMaker - the value to set
      Returns:
      the dsl builder

    • streamingDelayMs

      default DebeziumMySqlEndpointBuilderFactory.DebeziumMySqlEndpointBuilder streamingDelayMs(long streamingDelayMs)
      A delay period after the snapshot is completed and the streaming begins, given in milliseconds. Defaults to 0 ms. The option is a: long type. Default: 0ms Group: mysql
      Parameters:
      streamingDelayMs - the value to set
      Returns:
      the dsl builder

    • streamingDelayMs

      default DebeziumMySqlEndpointBuilderFactory.DebeziumMySqlEndpointBuilder streamingDelayMs(String streamingDelayMs)
      A delay period after the snapshot is completed and the streaming begins, given in milliseconds. Defaults to 0 ms. The option will be converted to a long type. Default: 0ms Group: mysql
      Parameters:
      streamingDelayMs - the value to set
      Returns:
      the dsl builder

    • tableExcludeList

      default DebeziumMySqlEndpointBuilderFactory.DebeziumMySqlEndpointBuilder 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: java.lang.String type. Group: mysql
      Parameters:
      tableExcludeList - the value to set
      Returns:
      the dsl builder

    • tableIgnoreBuiltin

      default DebeziumMySqlEndpointBuilderFactory.DebeziumMySqlEndpointBuilder tableIgnoreBuiltin(boolean tableIgnoreBuiltin)
      Flag specifying whether built-in tables should be ignored. The option is a: boolean type. Default: true Group: mysql
      Parameters:
      tableIgnoreBuiltin - the value to set
      Returns:
      the dsl builder

    • tableIgnoreBuiltin

      default DebeziumMySqlEndpointBuilderFactory.DebeziumMySqlEndpointBuilder tableIgnoreBuiltin(String tableIgnoreBuiltin)
      Flag specifying whether built-in tables should be ignored. The option will be converted to a boolean type. Default: true Group: mysql
      Parameters:
      tableIgnoreBuiltin - the value to set
      Returns:
      the dsl builder

    • tableIncludeList

      default DebeziumMySqlEndpointBuilderFactory.DebeziumMySqlEndpointBuilder tableIncludeList(String tableIncludeList)
      The tables for which changes are to be captured. The option is a: java.lang.String type. Group: mysql
      Parameters:
      tableIncludeList - the value to set
      Returns:
      the dsl builder

    • timePrecisionMode

      default DebeziumMySqlEndpointBuilderFactory.DebeziumMySqlEndpointBuilder 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: java.lang.String type. Default: adaptive_time_microseconds Group: mysql
      Parameters:
      timePrecisionMode - the value to set
      Returns:
      the dsl builder

    • tombstonesOnDelete

      default DebeziumMySqlEndpointBuilderFactory.DebeziumMySqlEndpointBuilder tombstonesOnDelete(boolean tombstonesOnDelete)
      Whether delete operations should be represented by a delete event and a subsequent tombstone event (true) or only by a delete event (false). Emitting the tombstone event (the default behavior) allows Kafka to completely delete all events pertaining to the given key once the source record got deleted. The option is a: boolean type. Default: false Group: mysql
      Parameters:
      tombstonesOnDelete - the value to set
      Returns:
      the dsl builder

    • tombstonesOnDelete

      default DebeziumMySqlEndpointBuilderFactory.DebeziumMySqlEndpointBuilder tombstonesOnDelete(String tombstonesOnDelete)
      Whether delete operations should be represented by a delete event and a subsequent tombstone event (true) or only by a delete event (false). Emitting the tombstone event (the default behavior) allows Kafka to completely delete all events pertaining to the given key once the source record got deleted. The option will be converted to a boolean type. Default: false Group: mysql
      Parameters:
      tombstonesOnDelete - the value to set
      Returns:
      the dsl builder

    • topicNamingStrategy

      default DebeziumMySqlEndpointBuilderFactory.DebeziumMySqlEndpointBuilder topicNamingStrategy(String topicNamingStrategy)
      The name of the TopicNamingStrategy class that should be used to determine the topic name for data change, schema change, transaction, heartbeat event etc. The option is a: java.lang.String type. Default: io.debezium.schema.SchemaTopicNamingStrategy Group: mysql
      Parameters:
      topicNamingStrategy - the value to set
      Returns:
      the dsl builder

    • topicPrefix

      default DebeziumMySqlEndpointBuilderFactory.DebeziumMySqlEndpointBuilder topicPrefix(String topicPrefix)
      Topic prefix that identifies and provides a namespace for the particular database server/cluster is capturing changes. The topic prefix should be unique across all other connectors, since it is used as a prefix for all Kafka topic names that receive events emitted by this connector. Only alphanumeric characters, hyphens, dots and underscores must be accepted. The option is a: java.lang.String type. Required: true Group: mysql
      Parameters:
      topicPrefix - the value to set
      Returns:
      the dsl builder

    • transactionMetadataFactory

      default DebeziumMySqlEndpointBuilderFactory.DebeziumMySqlEndpointBuilder transactionMetadataFactory(String transactionMetadataFactory)
      Class to make transaction context & transaction struct/schemas. The option is a: java.lang.String type. Default: io.debezium.pipeline.txmetadata.DefaultTransactionMetadataFactory Group: mysql
      Parameters:
      transactionMetadataFactory - the value to set
      Returns:
      the dsl builder

    • useNongracefulDisconnect

      default DebeziumMySqlEndpointBuilderFactory.DebeziumMySqlEndpointBuilder useNongracefulDisconnect(boolean useNongracefulDisconnect)
      Whether to use socket.setSoLinger(true, 0) when BinaryLogClient keepalive thread triggers a disconnect for a stale connection. The option is a: boolean type. Default: false Group: mysql
      Parameters:
      useNongracefulDisconnect - the value to set
      Returns:
      the dsl builder

    • useNongracefulDisconnect

      default DebeziumMySqlEndpointBuilderFactory.DebeziumMySqlEndpointBuilder useNongracefulDisconnect(String useNongracefulDisconnect)
      Whether to use socket.setSoLinger(true, 0) when BinaryLogClient keepalive thread triggers a disconnect for a stale connection. The option will be converted to a boolean type. Default: false Group: mysql
      Parameters:
      useNongracefulDisconnect - the value to set
      Returns:
      the dsl builder