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

Interface DebeziumPostgresEndpointBuilderFactory.DebeziumPostgresEndpointBuilder

All Superinterfaces:
org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver
Enclosing interface:
DebeziumPostgresEndpointBuilderFactory
public static interface DebeziumPostgresEndpointBuilderFactory.DebeziumPostgresEndpointBuilder extends org.apache.camel.builder.EndpointConsumerBuilder
Builder for endpoint for the Debezium PostgresSQL Connector component.

  • Method Details

    • advanced

      default DebeziumPostgresEndpointBuilderFactory.AdvancedDebeziumPostgresEndpointBuilder advanced()

    • additionalProperties

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

    • additionalProperties

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

    • internalKeyConverter

      default DebeziumPostgresEndpointBuilderFactory.DebeziumPostgresEndpointBuilder 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 DebeziumPostgresEndpointBuilderFactory.DebeziumPostgresEndpointBuilder 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 DebeziumPostgresEndpointBuilderFactory.DebeziumPostgresEndpointBuilder offsetCommitPolicy(String offsetCommitPolicy)
      The name of the Java class of the commit policy. It defines when offsets commit has to be triggered based on the number of events processed and the time elapsed since the last commit. This class must implement the interface 'OffsetCommitPolicy'. The default is a periodic commit policy based upon time intervals. The option is a: <code>java.lang.String</code> type. Group: consumer
      Parameters:
      offsetCommitPolicy - the value to set
      Returns:
      the dsl builder

    • offsetCommitTimeoutMs

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

    • offsetCommitTimeoutMs

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

    • offsetFlushIntervalMs

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

    • offsetFlushIntervalMs

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

    • offsetStorage

      default DebeziumPostgresEndpointBuilderFactory.DebeziumPostgresEndpointBuilder 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 DebeziumPostgresEndpointBuilderFactory.DebeziumPostgresEndpointBuilder 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 DebeziumPostgresEndpointBuilderFactory.DebeziumPostgresEndpointBuilder offsetStoragePartitions(int offsetStoragePartitions)
      The number of partitions used when creating the offset storage topic. Required when offset.storage is set to the 'KafkaOffsetBackingStore'. The option is a: <code>int</code> type. Group: consumer
      Parameters:
      offsetStoragePartitions - the value to set
      Returns:
      the dsl builder

    • offsetStoragePartitions

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

    • offsetStorageReplicationFactor

      default DebeziumPostgresEndpointBuilderFactory.DebeziumPostgresEndpointBuilder offsetStorageReplicationFactor(int offsetStorageReplicationFactor)
      Replication factor used when creating the offset storage topic. Required when offset.storage is set to the KafkaOffsetBackingStore. The option is a: <code>int</code> type. Group: consumer
      Parameters:
      offsetStorageReplicationFactor - the value to set
      Returns:
      the dsl builder

    • offsetStorageReplicationFactor

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

    • offsetStorageTopic

      default DebeziumPostgresEndpointBuilderFactory.DebeziumPostgresEndpointBuilder offsetStorageTopic(String offsetStorageTopic)
      The name of the Kafka topic where offsets are to be stored. Required when offset.storage is set to the KafkaOffsetBackingStore. The option is a: <code>java.lang.String</code> type. Group: consumer
      Parameters:
      offsetStorageTopic - the value to set
      Returns:
      the dsl builder

    • binaryHandlingMode

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

    • columnExcludeList

      default DebeziumPostgresEndpointBuilderFactory.DebeziumPostgresEndpointBuilder columnExcludeList(String columnExcludeList)
      Regular expressions matching columns to exclude from change events. The option is a: <code>java.lang.String</code> type. Group: postgres
      Parameters:
      columnExcludeList - the value to set
      Returns:
      the dsl builder

    • columnIncludeList

      default DebeziumPostgresEndpointBuilderFactory.DebeziumPostgresEndpointBuilder columnIncludeList(String columnIncludeList)
      Regular expressions matching columns to include in change events. The option is a: <code>java.lang.String</code> type. Group: postgres
      Parameters:
      columnIncludeList - the value to set
      Returns:
      the dsl builder

    • columnPropagateSourceType

      default DebeziumPostgresEndpointBuilderFactory.DebeziumPostgresEndpointBuilder 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: postgres
      Parameters:
      columnPropagateSourceType - the value to set
      Returns:
      the dsl builder

    • converters

      default DebeziumPostgresEndpointBuilderFactory.DebeziumPostgresEndpointBuilder 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: postgres
      Parameters:
      converters - the value to set
      Returns:
      the dsl builder

    • databaseDbname

      default DebeziumPostgresEndpointBuilderFactory.DebeziumPostgresEndpointBuilder databaseDbname(String databaseDbname)
      The name of the database from which the connector should capture changes. The option is a: <code>java.lang.String</code> type. Group: postgres
      Parameters:
      databaseDbname - the value to set
      Returns:
      the dsl builder

    • databaseHostname

      default DebeziumPostgresEndpointBuilderFactory.DebeziumPostgresEndpointBuilder databaseHostname(String databaseHostname)
      Resolvable hostname or IP address of the database server. The option is a: <code>java.lang.String</code> type. Group: postgres
      Parameters:
      databaseHostname - the value to set
      Returns:
      the dsl builder

    • databaseInitialStatements

      default DebeziumPostgresEndpointBuilderFactory.DebeziumPostgresEndpointBuilder databaseInitialStatements(String databaseInitialStatements)
      A semicolon separated list of SQL statements to be executed when a JDBC 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: postgres
      Parameters:
      databaseInitialStatements - the value to set
      Returns:
      the dsl builder

    • databasePassword

      default DebeziumPostgresEndpointBuilderFactory.DebeziumPostgresEndpointBuilder databasePassword(String databasePassword)
      Password of the database user to be used when connecting to the database. The option is a: <code>java.lang.String</code> type. Required: true Group: postgres
      Parameters:
      databasePassword - the value to set
      Returns:
      the dsl builder

    • databasePort

      default DebeziumPostgresEndpointBuilderFactory.DebeziumPostgresEndpointBuilder databasePort(int databasePort)
      Port of the database server. The option is a: <code>int</code> type. Default: 5432 Group: postgres
      Parameters:
      databasePort - the value to set
      Returns:
      the dsl builder

    • databasePort

      default DebeziumPostgresEndpointBuilderFactory.DebeziumPostgresEndpointBuilder databasePort(String databasePort)
      Port of the database server. The option will be converted to a <code>int</code> type. Default: 5432 Group: postgres
      Parameters:
      databasePort - the value to set
      Returns:
      the dsl builder

    • databaseSslcert

      default DebeziumPostgresEndpointBuilderFactory.DebeziumPostgresEndpointBuilder databaseSslcert(String databaseSslcert)
      File containing the SSL Certificate for the client. See the Postgres SSL docs for further information. The option is a: <code>java.lang.String</code> type. Group: postgres
      Parameters:
      databaseSslcert - the value to set
      Returns:
      the dsl builder

    • databaseSslfactory

      default DebeziumPostgresEndpointBuilderFactory.DebeziumPostgresEndpointBuilder databaseSslfactory(String databaseSslfactory)
      A name of class to that creates SSL Sockets. Use org.postgresql.ssl.NonValidatingFactory to disable SSL validation in development environments. The option is a: <code>java.lang.String</code> type. Group: postgres
      Parameters:
      databaseSslfactory - the value to set
      Returns:
      the dsl builder

    • databaseSslkey

      default DebeziumPostgresEndpointBuilderFactory.DebeziumPostgresEndpointBuilder databaseSslkey(String databaseSslkey)
      File containing the SSL private key for the client. See the Postgres SSL docs for further information. The option is a: <code>java.lang.String</code> type. Group: postgres
      Parameters:
      databaseSslkey - the value to set
      Returns:
      the dsl builder

    • databaseSslmode

      default DebeziumPostgresEndpointBuilderFactory.DebeziumPostgresEndpointBuilder databaseSslmode(String databaseSslmode)
      Whether to use an encrypted connection to Postgres. Options include: 'disable' (the default) to use an unencrypted connection; 'allow' to try and use an unencrypted connection first and, failing that, a secure (encrypted) connection; 'prefer' (the default) to try and use a secure (encrypted) connection first and, failing that, an unencrypted connection; 'require' 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-full' 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: prefer Group: postgres
      Parameters:
      databaseSslmode - the value to set
      Returns:
      the dsl builder

    • databaseSslpassword

      default DebeziumPostgresEndpointBuilderFactory.DebeziumPostgresEndpointBuilder databaseSslpassword(String databaseSslpassword)
      Password to access the client private key from the file specified by 'database.sslkey'. See the Postgres SSL docs for further information. The option is a: <code>java.lang.String</code> type. Group: postgres
      Parameters:
      databaseSslpassword - the value to set
      Returns:
      the dsl builder

    • databaseSslrootcert

      default DebeziumPostgresEndpointBuilderFactory.DebeziumPostgresEndpointBuilder databaseSslrootcert(String databaseSslrootcert)
      File containing the root certificate(s) against which the server is validated. See the Postgres JDBC SSL docs for further information. The option is a: <code>java.lang.String</code> type. Group: postgres
      Parameters:
      databaseSslrootcert - the value to set
      Returns:
      the dsl builder

    • databaseTcpkeepalive

      default DebeziumPostgresEndpointBuilderFactory.DebeziumPostgresEndpointBuilder databaseTcpkeepalive(boolean databaseTcpkeepalive)
      Enable or disable TCP keep-alive probe to avoid dropping TCP connection. The option is a: <code>boolean</code> type. Default: true Group: postgres
      Parameters:
      databaseTcpkeepalive - the value to set
      Returns:
      the dsl builder

    • databaseTcpkeepalive

      default DebeziumPostgresEndpointBuilderFactory.DebeziumPostgresEndpointBuilder databaseTcpkeepalive(String databaseTcpkeepalive)
      Enable or disable TCP keep-alive probe to avoid dropping TCP connection. The option will be converted to a <code>boolean</code> type. Default: true Group: postgres
      Parameters:
      databaseTcpkeepalive - the value to set
      Returns:
      the dsl builder

    • databaseUser

      default DebeziumPostgresEndpointBuilderFactory.DebeziumPostgresEndpointBuilder databaseUser(String databaseUser)
      Name of the database user to be used when connecting to the database. The option is a: <code>java.lang.String</code> type. Group: postgres
      Parameters:
      databaseUser - the value to set
      Returns:
      the dsl builder

    • datatypePropagateSourceType

      default DebeziumPostgresEndpointBuilderFactory.DebeziumPostgresEndpointBuilder 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: postgres
      Parameters:
      datatypePropagateSourceType - the value to set
      Returns:
      the dsl builder

    • decimalHandlingMode

      default DebeziumPostgresEndpointBuilderFactory.DebeziumPostgresEndpointBuilder 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: postgres
      Parameters:
      decimalHandlingMode - the value to set
      Returns:
      the dsl builder

    • errorsMaxRetries

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

    • errorsMaxRetries

      default DebeziumPostgresEndpointBuilderFactory.DebeziumPostgresEndpointBuilder 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 <code>int</code> type. Default: -1 Group: postgres
      Parameters:
      errorsMaxRetries - the value to set
      Returns:
      the dsl builder

    • eventProcessingFailureHandlingMode

      default DebeziumPostgresEndpointBuilderFactory.DebeziumPostgresEndpointBuilder 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: postgres
      Parameters:
      eventProcessingFailureHandlingMode - the value to set
      Returns:
      the dsl builder

    • flushLsnSource

      default DebeziumPostgresEndpointBuilderFactory.DebeziumPostgresEndpointBuilder flushLsnSource(boolean flushLsnSource)
      Boolean to determine if Debezium should flush LSN in the source postgres database. If set to false, user will have to flush the LSN manually outside Debezium. The option is a: <code>boolean</code> type. Default: true Group: postgres
      Parameters:
      flushLsnSource - the value to set
      Returns:
      the dsl builder

    • flushLsnSource

      default DebeziumPostgresEndpointBuilderFactory.DebeziumPostgresEndpointBuilder flushLsnSource(String flushLsnSource)
      Boolean to determine if Debezium should flush LSN in the source postgres database. If set to false, user will have to flush the LSN manually outside Debezium. The option will be converted to a <code>boolean</code> type. Default: true Group: postgres
      Parameters:
      flushLsnSource - the value to set
      Returns:
      the dsl builder

    • heartbeatActionQuery

      default DebeziumPostgresEndpointBuilderFactory.DebeziumPostgresEndpointBuilder heartbeatActionQuery(String heartbeatActionQuery)
      The query executed with every heartbeat. The option is a: <code>java.lang.String</code> type. Group: postgres
      Parameters:
      heartbeatActionQuery - the value to set
      Returns:
      the dsl builder

    • heartbeatIntervalMs

      default DebeziumPostgresEndpointBuilderFactory.DebeziumPostgresEndpointBuilder 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: postgres
      Parameters:
      heartbeatIntervalMs - the value to set
      Returns:
      the dsl builder

    • heartbeatIntervalMs

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

    • heartbeatTopicsPrefix

      default DebeziumPostgresEndpointBuilderFactory.DebeziumPostgresEndpointBuilder 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: postgres
      Parameters:
      heartbeatTopicsPrefix - the value to set
      Returns:
      the dsl builder

    • hstoreHandlingMode

      default DebeziumPostgresEndpointBuilderFactory.DebeziumPostgresEndpointBuilder hstoreHandlingMode(String hstoreHandlingMode)
      Specify how HSTORE columns should be represented in change events, including: 'json' represents values as string-ified JSON (default); 'map' represents values as a key/value map. The option is a: <code>java.lang.String</code> type. Default: json Group: postgres
      Parameters:
      hstoreHandlingMode - the value to set
      Returns:
      the dsl builder

    • includeSchemaComments

      default DebeziumPostgresEndpointBuilderFactory.DebeziumPostgresEndpointBuilder 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: postgres
      Parameters:
      includeSchemaComments - the value to set
      Returns:
      the dsl builder

    • includeSchemaComments

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

    • includeUnknownDatatypes

      default DebeziumPostgresEndpointBuilderFactory.DebeziumPostgresEndpointBuilder includeUnknownDatatypes(boolean includeUnknownDatatypes)
      Specify whether the fields of data type not supported by Debezium should be processed: 'false' (the default) omits the fields; 'true' converts the field into an implementation dependent binary representation. The option is a: <code>boolean</code> type. Default: false Group: postgres
      Parameters:
      includeUnknownDatatypes - the value to set
      Returns:
      the dsl builder

    • includeUnknownDatatypes

      default DebeziumPostgresEndpointBuilderFactory.DebeziumPostgresEndpointBuilder includeUnknownDatatypes(String includeUnknownDatatypes)
      Specify whether the fields of data type not supported by Debezium should be processed: 'false' (the default) omits the fields; 'true' converts the field into an implementation dependent binary representation. The option will be converted to a <code>boolean</code> type. Default: false Group: postgres
      Parameters:
      includeUnknownDatatypes - the value to set
      Returns:
      the dsl builder

    • incrementalSnapshotChunkSize

      default DebeziumPostgresEndpointBuilderFactory.DebeziumPostgresEndpointBuilder incrementalSnapshotChunkSize(int incrementalSnapshotChunkSize)
      The maximum size of chunk (number of documents/rows) for incremental snapshotting. The option is a: <code>int</code> type. Default: 1024 Group: postgres
      Parameters:
      incrementalSnapshotChunkSize - the value to set
      Returns:
      the dsl builder

    • incrementalSnapshotChunkSize

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

    • intervalHandlingMode

      default DebeziumPostgresEndpointBuilderFactory.DebeziumPostgresEndpointBuilder intervalHandlingMode(String intervalHandlingMode)
      Specify how INTERVAL columns should be represented in change events, including: 'string' represents values as an exact ISO formatted string; 'numeric' (default) represents values using the inexact conversion into microseconds. The option is a: <code>java.lang.String</code> type. Default: numeric Group: postgres
      Parameters:
      intervalHandlingMode - the value to set
      Returns:
      the dsl builder

    • maxBatchSize

      default DebeziumPostgresEndpointBuilderFactory.DebeziumPostgresEndpointBuilder maxBatchSize(int maxBatchSize)
      Maximum size of each batch of source records. Defaults to 2048. The option is a: <code>int</code> type. Default: 2048 Group: postgres
      Parameters:
      maxBatchSize - the value to set
      Returns:
      the dsl builder

    • maxBatchSize

      default DebeziumPostgresEndpointBuilderFactory.DebeziumPostgresEndpointBuilder maxBatchSize(String maxBatchSize)
      Maximum size of each batch of source records. Defaults to 2048. The option will be converted to a <code>int</code> type. Default: 2048 Group: postgres
      Parameters:
      maxBatchSize - the value to set
      Returns:
      the dsl builder

    • maxQueueSize

      default DebeziumPostgresEndpointBuilderFactory.DebeziumPostgresEndpointBuilder 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: postgres
      Parameters:
      maxQueueSize - the value to set
      Returns:
      the dsl builder

    • maxQueueSize

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

    • maxQueueSizeInBytes

      default DebeziumPostgresEndpointBuilderFactory.DebeziumPostgresEndpointBuilder 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: postgres
      Parameters:
      maxQueueSizeInBytes - the value to set
      Returns:
      the dsl builder

    • maxQueueSizeInBytes

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

    • messageKeyColumns

      default DebeziumPostgresEndpointBuilderFactory.DebeziumPostgresEndpointBuilder 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: postgres
      Parameters:
      messageKeyColumns - the value to set
      Returns:
      the dsl builder

    • messagePrefixExcludeList

      default DebeziumPostgresEndpointBuilderFactory.DebeziumPostgresEndpointBuilder messagePrefixExcludeList(String messagePrefixExcludeList)
      A comma-separated list of regular expressions that match the logical decoding message prefixes to be excluded from monitoring. The option is a: <code>java.lang.String</code> type. Group: postgres
      Parameters:
      messagePrefixExcludeList - the value to set
      Returns:
      the dsl builder

    • messagePrefixIncludeList

      default DebeziumPostgresEndpointBuilderFactory.DebeziumPostgresEndpointBuilder messagePrefixIncludeList(String messagePrefixIncludeList)
      A comma-separated list of regular expressions that match the logical decoding message prefixes to be monitored. All prefixes are monitored by default. The option is a: <code>java.lang.String</code> type. Group: postgres
      Parameters:
      messagePrefixIncludeList - the value to set
      Returns:
      the dsl builder

    • notificationEnabledChannels

      default DebeziumPostgresEndpointBuilderFactory.DebeziumPostgresEndpointBuilder notificationEnabledChannels(String notificationEnabledChannels)
      List of notification channels names that are enabled. The option is a: <code>java.lang.String</code> type. Group: postgres
      Parameters:
      notificationEnabledChannels - the value to set
      Returns:
      the dsl builder

    • notificationSinkTopicName

      default DebeziumPostgresEndpointBuilderFactory.DebeziumPostgresEndpointBuilder notificationSinkTopicName(String notificationSinkTopicName)
      The name of the topic for the notifications. This is required in case 'sink' is in the list of enabled channels. The option is a: <code>java.lang.String</code> type. Group: postgres
      Parameters:
      notificationSinkTopicName - the value to set
      Returns:
      the dsl builder

    • pluginName

      default DebeziumPostgresEndpointBuilderFactory.DebeziumPostgresEndpointBuilder pluginName(String pluginName)
      The name of the Postgres logical decoding plugin installed on the server. Supported values are 'decoderbufs' and 'pgoutput'. Defaults to 'decoderbufs'. The option is a: <code>java.lang.String</code> type. Default: decoderbufs Group: postgres
      Parameters:
      pluginName - the value to set
      Returns:
      the dsl builder

    • pollIntervalMs

      default DebeziumPostgresEndpointBuilderFactory.DebeziumPostgresEndpointBuilder 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: postgres
      Parameters:
      pollIntervalMs - the value to set
      Returns:
      the dsl builder

    • pollIntervalMs

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

    • provideTransactionMetadata

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

    • provideTransactionMetadata

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

    • publicationAutocreateMode

      default DebeziumPostgresEndpointBuilderFactory.DebeziumPostgresEndpointBuilder publicationAutocreateMode(String publicationAutocreateMode)
      Applies only when streaming changes using pgoutput.Determine how creation of a publication should work, the default is all_tables.DISABLED - The connector will not attempt to create a publication at all. The expectation is that the user has created the publication up-front. If the publication isn't found to exist upon startup, the connector will throw an exception and stop.ALL_TABLES - If no publication exists, the connector will create a new publication for all tables. Note this requires that the configured user has access. If the publication already exists, it will be used. i.e CREATE PUBLICATION FOR ALL TABLES;FILTERED - If no publication exists, the connector will create a new publication for all those tables matchingthe current filter configuration (see table/database include/exclude list properties). If the publication already exists, it will be used. i.e CREATE PUBLICATION FOR TABLE. The option is a: <code>java.lang.String</code> type. Default: all_tables Group: postgres
      Parameters:
      publicationAutocreateMode - the value to set
      Returns:
      the dsl builder

    • publicationName

      default DebeziumPostgresEndpointBuilderFactory.DebeziumPostgresEndpointBuilder publicationName(String publicationName)
      The name of the Postgres 10 publication used for streaming changes from a plugin. Defaults to 'dbz_publication'. The option is a: <code>java.lang.String</code> type. Default: dbz_publication Group: postgres
      Parameters:
      publicationName - the value to set
      Returns:
      the dsl builder

    • queryFetchSize

      default DebeziumPostgresEndpointBuilderFactory.DebeziumPostgresEndpointBuilder 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: postgres
      Parameters:
      queryFetchSize - the value to set
      Returns:
      the dsl builder

    • queryFetchSize

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

    • replicaIdentityAutosetValues

      default DebeziumPostgresEndpointBuilderFactory.DebeziumPostgresEndpointBuilder replicaIdentityAutosetValues(String replicaIdentityAutosetValues)
      Applies only when streaming changes using pgoutput.Determines the value for Replica Identity at table level. This option will overwrite the existing value in databaseA comma-separated list of regular expressions that match fully-qualified tables and Replica Identity value to be used in the table. Each expression must match the pattern ':', where the table names could be defined as (SCHEMA_NAME.TABLE_NAME), and the replica identity values are: DEFAULT - Records the old values of the columns of the primary key, if any. This is the default for non-system tables.INDEX index_name - Records the old values of the columns covered by the named index, that must be unique, not partial, not deferrable, and include only columns marked NOT NULL. If this index is dropped, the behavior is the same as NOTHING.FULL - Records the old values of all columns in the row.NOTHING - Records no information about the old row. This is the default for system tables. The option is a: <code>java.lang.String</code> type. Group: postgres
      Parameters:
      replicaIdentityAutosetValues - the value to set
      Returns:
      the dsl builder

    • retriableRestartConnectorWaitMs

      default DebeziumPostgresEndpointBuilderFactory.DebeziumPostgresEndpointBuilder 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: postgres
      Parameters:
      retriableRestartConnectorWaitMs - the value to set
      Returns:
      the dsl builder

    • retriableRestartConnectorWaitMs

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

    • schemaExcludeList

      default DebeziumPostgresEndpointBuilderFactory.DebeziumPostgresEndpointBuilder schemaExcludeList(String schemaExcludeList)
      The schemas for which events must not be captured. The option is a: <code>java.lang.String</code> type. Group: postgres
      Parameters:
      schemaExcludeList - the value to set
      Returns:
      the dsl builder

    • schemaHistoryInternalFileFilename

      default DebeziumPostgresEndpointBuilderFactory.DebeziumPostgresEndpointBuilder schemaHistoryInternalFileFilename(String schemaHistoryInternalFileFilename)
      The path to the file that will be used to record the database schema history. The option is a: <code>java.lang.String</code> type. Group: postgres
      Parameters:
      schemaHistoryInternalFileFilename - the value to set
      Returns:
      the dsl builder

    • schemaIncludeList

      default DebeziumPostgresEndpointBuilderFactory.DebeziumPostgresEndpointBuilder schemaIncludeList(String schemaIncludeList)
      The schemas for which events should be captured. The option is a: <code>java.lang.String</code> type. Group: postgres
      Parameters:
      schemaIncludeList - the value to set
      Returns:
      the dsl builder

    • schemaNameAdjustmentMode

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

    • schemaRefreshMode

      default DebeziumPostgresEndpointBuilderFactory.DebeziumPostgresEndpointBuilder schemaRefreshMode(String schemaRefreshMode)
      Specify the conditions that trigger a refresh of the in-memory schema for a table. 'columns_diff' (the default) is the safest mode, ensuring the in-memory schema stays in-sync with the database table's schema at all times. 'columns_diff_exclude_unchanged_toast' instructs the connector to refresh the in-memory schema cache if there is a discrepancy between it and the schema derived from the incoming message, unless unchanged TOASTable data fully accounts for the discrepancy. This setting can improve connector performance significantly if there are frequently-updated tables that have TOASTed data that are rarely part of these updates. However, it is possible for the in-memory schema to become outdated if TOASTable columns are dropped from the table. The option is a: <code>java.lang.String</code> type. Default: columns_diff Group: postgres
      Parameters:
      schemaRefreshMode - the value to set
      Returns:
      the dsl builder

    • signalDataCollection

      default DebeziumPostgresEndpointBuilderFactory.DebeziumPostgresEndpointBuilder 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: postgres
      Parameters:
      signalDataCollection - the value to set
      Returns:
      the dsl builder

    • signalEnabledChannels

      default DebeziumPostgresEndpointBuilderFactory.DebeziumPostgresEndpointBuilder signalEnabledChannels(String signalEnabledChannels)
      List of channels names that are enabled. Source channel is enabled by default. The option is a: <code>java.lang.String</code> type. Default: source Group: postgres
      Parameters:
      signalEnabledChannels - the value to set
      Returns:
      the dsl builder

    • signalPollIntervalMs

      default DebeziumPostgresEndpointBuilderFactory.DebeziumPostgresEndpointBuilder signalPollIntervalMs(long signalPollIntervalMs)
      Interval for looking for new signals in registered channels, given in milliseconds. Defaults to 5 seconds. The option is a: <code>long</code> type. Default: 5s Group: postgres
      Parameters:
      signalPollIntervalMs - the value to set
      Returns:
      the dsl builder

    • signalPollIntervalMs

      default DebeziumPostgresEndpointBuilderFactory.DebeziumPostgresEndpointBuilder 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 <code>long</code> type. Default: 5s Group: postgres
      Parameters:
      signalPollIntervalMs - the value to set
      Returns:
      the dsl builder

    • skippedOperations

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

    • slotDropOnStop

      default DebeziumPostgresEndpointBuilderFactory.DebeziumPostgresEndpointBuilder slotDropOnStop(boolean slotDropOnStop)
      Whether or not to drop the logical replication slot when the connector finishes orderly. By default the replication is kept so that on restart progress can resume from the last recorded location. The option is a: <code>boolean</code> type. Default: false Group: postgres
      Parameters:
      slotDropOnStop - the value to set
      Returns:
      the dsl builder

    • slotDropOnStop

      default DebeziumPostgresEndpointBuilderFactory.DebeziumPostgresEndpointBuilder slotDropOnStop(String slotDropOnStop)
      Whether or not to drop the logical replication slot when the connector finishes orderly. By default the replication is kept so that on restart progress can resume from the last recorded location. The option will be converted to a <code>boolean</code> type. Default: false Group: postgres
      Parameters:
      slotDropOnStop - the value to set
      Returns:
      the dsl builder

    • slotMaxRetries

      default DebeziumPostgresEndpointBuilderFactory.DebeziumPostgresEndpointBuilder slotMaxRetries(int slotMaxRetries)
      How many times to retry connecting to a replication slot when an attempt fails. The option is a: <code>int</code> type. Default: 6 Group: postgres
      Parameters:
      slotMaxRetries - the value to set
      Returns:
      the dsl builder

    • slotMaxRetries

      default DebeziumPostgresEndpointBuilderFactory.DebeziumPostgresEndpointBuilder slotMaxRetries(String slotMaxRetries)
      How many times to retry connecting to a replication slot when an attempt fails. The option will be converted to a <code>int</code> type. Default: 6 Group: postgres
      Parameters:
      slotMaxRetries - the value to set
      Returns:
      the dsl builder

    • slotName

      default DebeziumPostgresEndpointBuilderFactory.DebeziumPostgresEndpointBuilder slotName(String slotName)
      The name of the Postgres logical decoding slot created for streaming changes from a plugin. Defaults to 'debezium. The option is a: <code>java.lang.String</code> type. Default: debezium Group: postgres
      Parameters:
      slotName - the value to set
      Returns:
      the dsl builder

    • slotRetryDelayMs

      default DebeziumPostgresEndpointBuilderFactory.DebeziumPostgresEndpointBuilder slotRetryDelayMs(long slotRetryDelayMs)
      Time to wait between retry attempts when the connector fails to connect to a replication slot, given in milliseconds. Defaults to 10 seconds (10,000 ms). The option is a: <code>long</code> type. Default: 10s Group: postgres
      Parameters:
      slotRetryDelayMs - the value to set
      Returns:
      the dsl builder

    • slotRetryDelayMs

      default DebeziumPostgresEndpointBuilderFactory.DebeziumPostgresEndpointBuilder slotRetryDelayMs(String slotRetryDelayMs)
      Time to wait between retry attempts when the connector fails to connect to a replication slot, given in milliseconds. Defaults to 10 seconds (10,000 ms). The option will be converted to a <code>long</code> type. Default: 10s Group: postgres
      Parameters:
      slotRetryDelayMs - the value to set
      Returns:
      the dsl builder

    • slotStreamParams

      default DebeziumPostgresEndpointBuilderFactory.DebeziumPostgresEndpointBuilder slotStreamParams(String slotStreamParams)
      Any optional parameters used by logical decoding plugin. Semi-colon separated. E.g. 'add-tables=public.table,public.table2;include-lsn=true'. The option is a: <code>java.lang.String</code> type. Group: postgres
      Parameters:
      slotStreamParams - the value to set
      Returns:
      the dsl builder

    • snapshotCustomClass

      default DebeziumPostgresEndpointBuilderFactory.DebeziumPostgresEndpointBuilder snapshotCustomClass(String snapshotCustomClass)
      When 'snapshot.mode' is set as custom, this setting must be set to specify a fully qualified class name to load (via the default class loader). This class must implement the 'Snapshotter' interface and is called on each app boot to determine whether to do a snapshot and how to build queries. The option is a: <code>java.lang.String</code> type. Group: postgres
      Parameters:
      snapshotCustomClass - the value to set
      Returns:
      the dsl builder

    • snapshotDelayMs

      default DebeziumPostgresEndpointBuilderFactory.DebeziumPostgresEndpointBuilder 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: postgres
      Parameters:
      snapshotDelayMs - the value to set
      Returns:
      the dsl builder

    • snapshotDelayMs

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

    • snapshotFetchSize

      default DebeziumPostgresEndpointBuilderFactory.DebeziumPostgresEndpointBuilder 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: postgres
      Parameters:
      snapshotFetchSize - the value to set
      Returns:
      the dsl builder

    • snapshotFetchSize

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

    • snapshotIncludeCollectionList

      default DebeziumPostgresEndpointBuilderFactory.DebeziumPostgresEndpointBuilder 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: postgres
      Parameters:
      snapshotIncludeCollectionList - the value to set
      Returns:
      the dsl builder

    • snapshotLockTimeoutMs

      default DebeziumPostgresEndpointBuilderFactory.DebeziumPostgresEndpointBuilder 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: postgres
      Parameters:
      snapshotLockTimeoutMs - the value to set
      Returns:
      the dsl builder

    • snapshotLockTimeoutMs

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

    • snapshotMaxThreads

      default DebeziumPostgresEndpointBuilderFactory.DebeziumPostgresEndpointBuilder 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: postgres
      Parameters:
      snapshotMaxThreads - the value to set
      Returns:
      the dsl builder

    • snapshotMaxThreads

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

    • snapshotMode

      default DebeziumPostgresEndpointBuilderFactory.DebeziumPostgresEndpointBuilder snapshotMode(String snapshotMode)
      The criteria for running a snapshot upon startup of the connector. Select one of the following snapshot options: 'always': The connector runs a snapshot every time that it starts. After the snapshot completes, the connector begins to stream changes from the transaction log.; '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 transaction log. '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 transaction log.; 'never': The connector does not run a snapshot. Upon first startup, the connector immediately begins reading from the beginning of the transaction log. 'exported': This option is deprecated; use 'initial' instead.; 'custom': The connector loads a custom class to specify how the connector performs snapshots. For more information, see Custom snapshotter SPI in the PostgreSQL connector documentation. The option is a: <code>java.lang.String</code> type. Default: initial Group: postgres
      Parameters:
      snapshotMode - the value to set
      Returns:
      the dsl builder

    • snapshotSelectStatementOverrides

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

    • snapshotTablesOrderByRowCount

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

    • sourceinfoStructMaker

      default DebeziumPostgresEndpointBuilderFactory.DebeziumPostgresEndpointBuilder sourceinfoStructMaker(String sourceinfoStructMaker)
      The name of the SourceInfoStructMaker class that returns SourceInfo schema and struct. The option is a: <code>java.lang.String</code> type. Default: io.debezium.connector.postgresql.PostgresSourceInfoStructMaker Group: postgres
      Parameters:
      sourceinfoStructMaker - the value to set
      Returns:
      the dsl builder

    • statusUpdateIntervalMs

      default DebeziumPostgresEndpointBuilderFactory.DebeziumPostgresEndpointBuilder statusUpdateIntervalMs(int statusUpdateIntervalMs)
      Frequency for sending replication connection status updates to the server, given in milliseconds. Defaults to 10 seconds (10,000 ms). The option is a: <code>int</code> type. Default: 10s Group: postgres
      Parameters:
      statusUpdateIntervalMs - the value to set
      Returns:
      the dsl builder

    • statusUpdateIntervalMs

      default DebeziumPostgresEndpointBuilderFactory.DebeziumPostgresEndpointBuilder statusUpdateIntervalMs(String statusUpdateIntervalMs)
      Frequency for sending replication connection status updates to the server, given in milliseconds. Defaults to 10 seconds (10,000 ms). The option will be converted to a <code>int</code> type. Default: 10s Group: postgres
      Parameters:
      statusUpdateIntervalMs - the value to set
      Returns:
      the dsl builder

    • tableExcludeList

      default DebeziumPostgresEndpointBuilderFactory.DebeziumPostgresEndpointBuilder 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: postgres
      Parameters:
      tableExcludeList - the value to set
      Returns:
      the dsl builder

    • tableIgnoreBuiltin

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

    • tableIgnoreBuiltin

      default DebeziumPostgresEndpointBuilderFactory.DebeziumPostgresEndpointBuilder tableIgnoreBuiltin(String tableIgnoreBuiltin)
      Flag specifying whether built-in tables should be ignored. The option will be converted to a <code>boolean</code> type. Default: true Group: postgres
      Parameters:
      tableIgnoreBuiltin - the value to set
      Returns:
      the dsl builder

    • tableIncludeList

      default DebeziumPostgresEndpointBuilderFactory.DebeziumPostgresEndpointBuilder tableIncludeList(String tableIncludeList)
      The tables for which changes are to be captured. The option is a: <code>java.lang.String</code> type. Group: postgres
      Parameters:
      tableIncludeList - the value to set
      Returns:
      the dsl builder

    • timePrecisionMode

      default DebeziumPostgresEndpointBuilderFactory.DebeziumPostgresEndpointBuilder timePrecisionMode(String timePrecisionMode)
      Time, date, and timestamps can be represented with different kinds of precisions, including: 'adaptive' (the default) bases the precision of time, date, and timestamp values on the database column's precision; 'adaptive_time_microseconds' like 'adaptive' mode, but TIME fields always use microseconds precision; 'connect' always represents time, date, and timestamp values using Kafka Connect's built-in representations for Time, Date, and Timestamp, which uses millisecond precision regardless of the database columns' precision. The option is a: <code>java.lang.String</code> type. Default: adaptive Group: postgres
      Parameters:
      timePrecisionMode - the value to set
      Returns:
      the dsl builder

    • tombstonesOnDelete

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

    • tombstonesOnDelete

      default DebeziumPostgresEndpointBuilderFactory.DebeziumPostgresEndpointBuilder 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 <code>boolean</code> type. Default: false Group: postgres
      Parameters:
      tombstonesOnDelete - the value to set
      Returns:
      the dsl builder

    • topicNamingStrategy

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

    • topicPrefix

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

    • unavailableValuePlaceholder

      default DebeziumPostgresEndpointBuilderFactory.DebeziumPostgresEndpointBuilder unavailableValuePlaceholder(String unavailableValuePlaceholder)
      Specify the constant that will be provided by Debezium to indicate that the original value is a toasted value not provided by the database. If starts with 'hex:' prefix it is expected that the rest of the string represents hexadecimal encoded octets. The option is a: <code>java.lang.String</code> type. Default: __debezium_unavailable_value Group: postgres
      Parameters:
      unavailableValuePlaceholder - the value to set
      Returns:
      the dsl builder

    • xminFetchIntervalMs

      default DebeziumPostgresEndpointBuilderFactory.DebeziumPostgresEndpointBuilder xminFetchIntervalMs(long xminFetchIntervalMs)
      Specify how often (in ms) the xmin will be fetched from the replication slot. This xmin value is exposed by the slot which gives a lower bound of where a new replication slot could start from. The lower the value, the more likely this value is to be the current 'true' value, but the bigger the performance cost. The bigger the value, the less likely this value is to be the current 'true' value, but the lower the performance penalty. The default is set to 0 ms, which disables tracking xmin. The option is a: <code>long</code> type. Default: 0ms Group: postgres
      Parameters:
      xminFetchIntervalMs - the value to set
      Returns:
      the dsl builder

    • xminFetchIntervalMs

      default DebeziumPostgresEndpointBuilderFactory.DebeziumPostgresEndpointBuilder xminFetchIntervalMs(String xminFetchIntervalMs)
      Specify how often (in ms) the xmin will be fetched from the replication slot. This xmin value is exposed by the slot which gives a lower bound of where a new replication slot could start from. The lower the value, the more likely this value is to be the current 'true' value, but the bigger the performance cost. The bigger the value, the less likely this value is to be the current 'true' value, but the lower the performance penalty. The default is set to 0 ms, which disables tracking xmin. The option will be converted to a <code>long</code> type. Default: 0ms Group: postgres
      Parameters:
      xminFetchIntervalMs - the value to set
      Returns:
      the dsl builder