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

Interface DebeziumPostgresComponentBuilderFactory.DebeziumPostgresComponentBuilder

    • Method Detail

      • additionalProperties

        default DebeziumPostgresComponentBuilderFactory.DebeziumPostgresComponentBuilder additionalProperties​(Map<String,​Object> additionalProperties)
        Additional properties for debezium components in case they can't be set directly on the camel configurations (e.g: setting Kafka Connect properties needed by Debezium engine, for example setting KafkaOffsetBackingStore), the properties have to be prefixed with additionalProperties.. E.g: additionalProperties.transactional.id=12345&additionalProperties.schema.registry.url=http://localhost:8811/avro. The option is a: java.util.Map type. Group: common

      • bridgeErrorHandler

        default DebeziumPostgresComponentBuilderFactory.DebeziumPostgresComponentBuilder bridgeErrorHandler​(boolean bridgeErrorHandler)
        Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored. The option is a: boolean type. Default: false Group: consumer

      • configuration

        default DebeziumPostgresComponentBuilderFactory.DebeziumPostgresComponentBuilder configuration​(org.apache.camel.component.debezium.configuration.PostgresConnectorEmbeddedDebeziumConfiguration configuration)
        Allow pre-configured Configurations to be set. The option is a: org.apache.camel.component.debezium.configuration.PostgresConnectorEmbeddedDebeziumConfiguration type. Group: consumer

      • internalKeyConverter

        default DebeziumPostgresComponentBuilderFactory.DebeziumPostgresComponentBuilder 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

      • internalValueConverter

        default DebeziumPostgresComponentBuilderFactory.DebeziumPostgresComponentBuilder 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

      • offsetCommitPolicy

        default DebeziumPostgresComponentBuilderFactory.DebeziumPostgresComponentBuilder 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. Default: io.debezium.embedded.spi.OffsetCommitPolicy.PeriodicCommitOffsetPolicy Group: consumer

      • offsetCommitTimeoutMs

        default DebeziumPostgresComponentBuilderFactory.DebeziumPostgresComponentBuilder 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: 5s Group: consumer

      • offsetStorageReplicationFactor

        default DebeziumPostgresComponentBuilderFactory.DebeziumPostgresComponentBuilder 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

      • databaseInitialStatements

        default DebeziumPostgresComponentBuilderFactory.DebeziumPostgresComponentBuilder 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 configurationof 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: postgres

      • databaseServerName

        default DebeziumPostgresComponentBuilderFactory.DebeziumPostgresComponentBuilder databaseServerName​(String databaseServerName)
        Unique name that identifies the database server and all recorded offsets, and that is used as a prefix for all schemas and topics. Each distinct installation should have a separate namespace and be monitored by at most one Debezium connector. The option is a: java.lang.String type. Group: postgres

      • databaseSslmode

        default DebeziumPostgresComponentBuilderFactory.DebeziumPostgresComponentBuilder databaseSslmode​(String databaseSslmode)
        Whether to use an encrypted connection to Postgres. Options include'disable' (the default) to use 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: java.lang.String type. Default: disable Group: postgres

      • decimalHandlingMode

        default DebeziumPostgresComponentBuilderFactory.DebeziumPostgresComponentBuilder 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: postgres

      • eventProcessingFailureHandlingMode

        default DebeziumPostgresComponentBuilderFactory.DebeziumPostgresComponentBuilder 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: postgres

      • heartbeatIntervalMs

        default DebeziumPostgresComponentBuilderFactory.DebeziumPostgresComponentBuilder 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: postgres

      • hstoreHandlingMode

        default DebeziumPostgresComponentBuilderFactory.DebeziumPostgresComponentBuilder 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: java.lang.String type. Default: json Group: postgres

      • includeUnknownDatatypes

        default DebeziumPostgresComponentBuilderFactory.DebeziumPostgresComponentBuilder 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: boolean type. Default: false Group: postgres

      • intervalHandlingMode

        default DebeziumPostgresComponentBuilderFactory.DebeziumPostgresComponentBuilder 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: java.lang.String type. Default: numeric Group: postgres

      • maxQueueSize

        default DebeziumPostgresComponentBuilderFactory.DebeziumPostgresComponentBuilder 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: postgres

      • messageKeyColumns

        default DebeziumPostgresComponentBuilderFactory.DebeziumPostgresComponentBuilder 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: postgres

      • schemaRefreshMode

        default DebeziumPostgresComponentBuilderFactory.DebeziumPostgresComponentBuilder 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: java.lang.String type. Default: columns_diff Group: postgres

      • slotDropOnStop

        default DebeziumPostgresComponentBuilderFactory.DebeziumPostgresComponentBuilder slotDropOnStop​(boolean slotDropOnStop)
        Whether or not to drop the logical replication slot when the connector finishes orderlyBy default the replication is kept so that on restart progress can resume from the last recorded location. The option is a: boolean type. Default: false Group: postgres

      • snapshotCustomClass

        default DebeziumPostgresComponentBuilderFactory.DebeziumPostgresComponentBuilder 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: java.lang.String type. Group: postgres

      • snapshotLockTimeoutMs

        default DebeziumPostgresComponentBuilderFactory.DebeziumPostgresComponentBuilder 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: postgres

      • snapshotMode

        default DebeziumPostgresComponentBuilderFactory.DebeziumPostgresComponentBuilder snapshotMode​(String snapshotMode)
        The criteria for running a snapshot upon startup of the connector. Options include: 'always' to specify that the connector run a snapshot each time it starts up; 'initial' (the default) to specify the connector can run a snapshot only when no offsets are available for the logical server name; 'initial_only' same as 'initial' except the connector should stop after completing the snapshot and before it would normally start emitting changes;'never' to specify the connector should never run a snapshot and that upon first startup the connector should read from the last position (LSN) recorded by the server; and'exported' to specify the connector should run a snapshot based on the position when the replication slot was created; 'custom' to specify a custom class with 'snapshot.custom_class' which will be loaded and used to determine the snapshot, see docs for more details. The option is a: java.lang.String type. Default: initial Group: postgres

      • snapshotSelectStatementOverrides

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

      • timePrecisionMode

        default DebeziumPostgresComponentBuilderFactory.DebeziumPostgresComponentBuilder 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: java.lang.String type. Default: adaptive Group: postgres

      • toastedValuePlaceholder

        default DebeziumPostgresComponentBuilderFactory.DebeziumPostgresComponentBuilder toastedValuePlaceholder​(String toastedValuePlaceholder)
        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 repesents hexadecimally encoded octets. The option is a: java.lang.String type. Default: __debezium_unavailable_value Group: postgres

      • tombstonesOnDelete

        default DebeziumPostgresComponentBuilderFactory.DebeziumPostgresComponentBuilder tombstonesOnDelete​(boolean tombstonesOnDelete)
        Whether delete operations should be represented by a delete event and a subsquenttombstone event (true) or only by a delete event (false). Emitting the tombstone event (the default behavior) allows Kafka to completely delete all events pertaining to the given key once the source record got deleted. The option is a: boolean type. Default: false Group: postgres

      • xminFetchIntervalMs

        default DebeziumPostgresComponentBuilderFactory.DebeziumPostgresComponentBuilder 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: long type. Default: 0ms Group: postgres