Debezium PostgresSQL Connector

Since Camel 3.0

Only consumer is supported

The Debezium PostgresSQL component is wrapper around Debezium using Debezium Embedded, which enables Change Data Capture from PostgresSQL database using Debezium without the need for Kafka or Kafka Connect.

Note on handling failures: Per Debezium Embedded Engine documentation, the engines is actively recording source offsets and periodically flushes these offsets to a persistent storage, so when the application is restarted or crashed, the engine will resume from the last recorded offset. Thus, at normal operation, your downstream routes will receive each event exactly once, however in case of an application crash (not having a graceful shutdown), the application will resume from the last recorded offset, which may result in receiving duplicate events immediately after the restart. Therefore, your downstream routes should be tolerant enough of such case and deduplicate events if needed.

Note: The Debezium PostgresSQL component is currently not supported in OSGi

Maven users will need to add the following dependency to their pom.xml for this component.

<dependency>
    <groupId>org.apache.camel</groupId>
    <artifactId>camel-debezium-postgres</artifactId>
    <version>x.x.x</version>
    <!-- use the same version as your Camel core version -->
</dependency>

URI format

debezium-postgres:name[?options]

Options

The Debezium PostgresSQL Connector component supports 74 options, which are listed below.

Name	Description	Default	Type
additionalProperties (common)	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		Map
bridgeErrorHandler (consumer)	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.	false	boolean
configuration (consumer)	Allow pre-configured Configurations to be set.		PostgresConnectorEmbeddedDebeziumConfiguration
internalKeyConverter (consumer)	The Converter class that should be used to serialize and deserialize key data for offsets. The default is JSON converter.	org.apache.kafka.connect.json.JsonConverter	String
internalValueConverter (consumer)	The Converter class that should be used to serialize and deserialize value data for offsets. The default is JSON converter.	org.apache.kafka.connect.json.JsonConverter	String
offsetCommitPolicy (consumer)	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.	io.debezium.embedded.spi.OffsetCommitPolicy.PeriodicCommitOffsetPolicy	String
offsetCommitTimeoutMs (consumer)	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.	5s	long
offsetFlushIntervalMs (consumer)	Interval at which to try committing offsets. The default is 1 minute.	60s	long
offsetStorage (consumer)	The name of the Java class that is responsible for persistence of connector offsets.	org.apache.kafka.connect.storage.FileOffsetBackingStore	String
offsetStorageFileName (consumer)	Path to file where offsets are to be stored. Required when offset.storage is set to the FileOffsetBackingStore.		String
offsetStoragePartitions (consumer)	The number of partitions used when creating the offset storage topic. Required when offset.storage is set to the 'KafkaOffsetBackingStore'.		int
offsetStorageReplicationFactor (consumer)	Replication factor used when creating the offset storage topic. Required when offset.storage is set to the KafkaOffsetBackingStore		int
offsetStorageTopic (consumer)	The name of the Kafka topic where offsets are to be stored. Required when offset.storage is set to the KafkaOffsetBackingStore.		String
basicPropertyBinding (advanced)	Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities	false	boolean
binaryHandlingMode (postgres)	Specify how binary (blob, binary, etc.) columns should be represented in change events, including:'bytes' represents binary data as byte array (default)'base64' represents binary data as base64-encoded string’hex' represents binary data as hex-encoded (base16) string	bytes	String
columnBlacklist (postgres)	Regular expressions matching columns to exclude from change events		String
columnWhitelist (postgres)	Regular expressions matching columns to include in change events		String
converters (postgres)	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 '.'		String
databaseDbname (postgres)	The name of the database the connector should be monitoring		String
databaseHistoryFileFilename (postgres)	The path to the file that will be used to record the database history		String
databaseHostname (postgres)	Resolvable hostname or IP address of the Postgres database server.		String
databaseInitialStatements (postgres)	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.		String
databasePassword (postgres)	Required Password of the Postgres database user to be used when connecting to the database.		String
databasePort (postgres)	Port of the Postgres database server.	5432	int
databaseServerName (postgres)	Required 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.		String
databaseSslcert (postgres)	File containing the SSL Certificate for the client. See the Postgres SSL docs for further information		String
databaseSslfactory (postgres)	A name of class to that creates SSL Sockets. Use org.postgresql.ssl.NonValidatingFactory to disable SSL validation in development environments		String
databaseSslkey (postgres)	File containing the SSL private key for the client. See the Postgres SSL docs for further information		String
databaseSslmode (postgres)	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.	disable	String
databaseSslpassword (postgres)	Password to access the client private key from the file specified by 'database.sslkey'. See the Postgres SSL docs for further information		String
databaseSslrootcert (postgres)	File containing the root certificate(s) against which the server is validated. See the Postgres JDBC SSL docs for further information		String
databaseTcpkeepalive (postgres)	Enable or disable TCP keep-alive probe to avoid dropping TCP connection	true	boolean
databaseUser (postgres)	Name of the Postgres database user to be used when connecting to the database.		String
decimalHandlingMode (postgres)	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.	precise	String
eventProcessingFailureHandling Mode (postgres)	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.	fail	String
heartbeatActionQuery (postgres)	The query executed with every heartbeat. Defaults to an empty string.		String
heartbeatIntervalMs (postgres)	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.	0ms	int
heartbeatTopicsPrefix (postgres)	The prefix that is used to name heartbeat topics.Defaults to __debezium-heartbeat.	__debezium-heartbeat	String
hstoreHandlingMode (postgres)	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	json	String
includeUnknownDatatypes (postgres)	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.	false	boolean
intervalHandlingMode (postgres)	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	numeric	String
maxBatchSize (postgres)	Maximum size of each batch of source records. Defaults to 2048.	2048	int
maxQueueSize (postgres)	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.	8192	int
messageKeyColumns (postgres)	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		String
pluginName (postgres)	The name of the Postgres logical decoding plugin installed on the server. Supported values are 'decoderbufs' and 'wal2json'. Defaults to 'decoderbufs'.	decoderbufs	String
pollIntervalMs (postgres)	Frequency in milliseconds to wait for new change events to appear after receiving no events. Defaults to 500ms.	500ms	long
provideTransactionMetadata (postgres)	Enables transaction metadata extraction together with event counting	false	boolean
publicationAutocreateMode (postgres)	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 whitelist/blacklist properties). If the publication already exists, it will be used. i.e CREATE PUBLICATION FOR TABLE	all_tables	String
publicationName (postgres)	The name of the Postgres 10 publication used for streaming changes from a plugin.Defaults to 'dbz_publication'	dbz_publication	String
sanitizeFieldNames (postgres)	Whether field names will be sanitized to Avro naming conventions	false	boolean
schemaBlacklist (postgres)	The schemas for which events must not be captured		String
schemaRefreshMode (postgres)	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.	columns_diff	String
schemaWhitelist (postgres)	The schemas for which events should be captured		String
skippedOperations (postgres)	The comma-separated list of operations to skip during streaming, defined as: 'i' for inserts; 'u' for updates; 'd' for deletes. By default, no operations will be skipped.		String
slotDropOnStop (postgres)	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	false	boolean
slotMaxRetries (postgres)	How many times to retry connecting to a replication slot when an attempt fails.	6	int
slotName (postgres)	The name of the Postgres logical decoding slot created for streaming changes from a plugin.Defaults to 'debezium	debezium	String
slotRetryDelayMs (postgres)	The number of milli-seconds to wait between retry attempts when the connector fails to connect to a replication slot.	10s	long
slotStreamParams (postgres)	Any optional parameters used by logical decoding plugin. Semi-colon separated. E.g. 'add-tables=public.table,public.table2;include-lsn=true'		String
snapshotCustomClass (postgres)	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.		String
snapshotDelayMs (postgres)	The number of milliseconds to delay before a snapshot will begin.	0ms	long
snapshotFetchSize (postgres)	The maximum number of records that should be loaded into memory while performing a snapshot		int
snapshotLockTimeoutMs (postgres)	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	10s	long
snapshotMode (postgres)	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.	initial	String
snapshotSelectStatement Overrides (postgres)	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.		String
sourceStructVersion (postgres)	A version of the format of the publicly visible source part in the message	v2	String
statusUpdateIntervalMs (postgres)	Frequency in milliseconds for sending replication connection status updates to the server. Defaults to 10 seconds (10000 ms).	10s	int
tableBlacklist (postgres)	Description is not available here, please check Debezium website for corresponding key 'table.blacklist' description.		String
tableIgnoreBuiltin (postgres)	Flag specifying whether built-in tables should be ignored.	true	boolean
tableWhitelist (postgres)	The tables for which changes are to be captured		String
timePrecisionMode (postgres)	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 .	adaptive	String
toastedValuePlaceholder (postgres)	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.	__debezium_unavailable_value	String
tombstonesOnDelete (postgres)	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.	false	boolean
xminFetchIntervalMs (postgres)	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.	0ms	long

Name

Description

Default

Type

additionalProperties (common)

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

Map

bridgeErrorHandler (consumer)

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.

false

boolean

configuration (consumer)

Allow pre-configured Configurations to be set.

PostgresConnectorEmbeddedDebeziumConfiguration

internalKeyConverter (consumer)

The Converter class that should be used to serialize and deserialize key data for offsets. The default is JSON converter.

org.apache.kafka.connect.json.JsonConverter

String

internalValueConverter (consumer)

The Converter class that should be used to serialize and deserialize value data for offsets. The default is JSON converter.

org.apache.kafka.connect.json.JsonConverter

String

offsetCommitPolicy (consumer)

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.

io.debezium.embedded.spi.OffsetCommitPolicy.PeriodicCommitOffsetPolicy

String

offsetCommitTimeoutMs (consumer)

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.

long

offsetFlushIntervalMs (consumer)

Interval at which to try committing offsets. The default is 1 minute.

60s

long

offsetStorage (consumer)

The name of the Java class that is responsible for persistence of connector offsets.

org.apache.kafka.connect.storage.FileOffsetBackingStore

String

offsetStorageFileName (consumer)

Path to file where offsets are to be stored. Required when offset.storage is set to the FileOffsetBackingStore.

String

offsetStoragePartitions (consumer)

The number of partitions used when creating the offset storage topic. Required when offset.storage is set to the 'KafkaOffsetBackingStore'.

int

offsetStorageReplicationFactor (consumer)

Replication factor used when creating the offset storage topic. Required when offset.storage is set to the KafkaOffsetBackingStore

int

offsetStorageTopic (consumer)

The name of the Kafka topic where offsets are to be stored. Required when offset.storage is set to the KafkaOffsetBackingStore.

String

basicPropertyBinding (advanced)

Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities

false

boolean

binaryHandlingMode (postgres)

Specify how binary (blob, binary, etc.) columns should be represented in change events, including:'bytes' represents binary data as byte array (default)'base64' represents binary data as base64-encoded string’hex' represents binary data as hex-encoded (base16) string

bytes

String

columnBlacklist (postgres)

Regular expressions matching columns to exclude from change events

String

columnWhitelist (postgres)

Regular expressions matching columns to include in change events

String

converters (postgres)

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 '.'

String

databaseDbname (postgres)

The name of the database the connector should be monitoring

String

databaseHistoryFileFilename (postgres)

The path to the file that will be used to record the database history

String

databaseHostname (postgres)

Resolvable hostname or IP address of the Postgres database server.

String

databaseInitialStatements (postgres)

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.

String

databasePassword (postgres)

Required Password of the Postgres database user to be used when connecting to the database.

String

databasePort (postgres)

Port of the Postgres database server.

5432

int

databaseServerName (postgres)

Required 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.

String

databaseSslcert (postgres)

File containing the SSL Certificate for the client. See the Postgres SSL docs for further information

String

databaseSslfactory (postgres)

A name of class to that creates SSL Sockets. Use org.postgresql.ssl.NonValidatingFactory to disable SSL validation in development environments

String

databaseSslkey (postgres)

File containing the SSL private key for the client. See the Postgres SSL docs for further information

String

databaseSslmode (postgres)

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.

disable

String

databaseSslpassword (postgres)

Password to access the client private key from the file specified by 'database.sslkey'. See the Postgres SSL docs for further information

String

databaseSslrootcert (postgres)

File containing the root certificate(s) against which the server is validated. See the Postgres JDBC SSL docs for further information

String

databaseTcpkeepalive (postgres)

Enable or disable TCP keep-alive probe to avoid dropping TCP connection

true

boolean

databaseUser (postgres)

Name of the Postgres database user to be used when connecting to the database.

String

decimalHandlingMode (postgres)

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.

precise

String

eventProcessingFailureHandling Mode (postgres)

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.

fail

String

heartbeatActionQuery (postgres)

The query executed with every heartbeat. Defaults to an empty string.

String

heartbeatIntervalMs (postgres)

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.

0ms

int

heartbeatTopicsPrefix (postgres)

The prefix that is used to name heartbeat topics.Defaults to __debezium-heartbeat.

__debezium-heartbeat

String

hstoreHandlingMode (postgres)

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

json

String

includeUnknownDatatypes (postgres)

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.

false

boolean

intervalHandlingMode (postgres)

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

numeric

String

maxBatchSize (postgres)

Maximum size of each batch of source records. Defaults to 2048.

2048

int

maxQueueSize (postgres)

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.

8192

int

messageKeyColumns (postgres)

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

String

pluginName (postgres)

The name of the Postgres logical decoding plugin installed on the server. Supported values are 'decoderbufs' and 'wal2json'. Defaults to 'decoderbufs'.

decoderbufs

String

pollIntervalMs (postgres)

Frequency in milliseconds to wait for new change events to appear after receiving no events. Defaults to 500ms.

500ms

long

provideTransactionMetadata (postgres)

Enables transaction metadata extraction together with event counting

false

boolean

publicationAutocreateMode (postgres)

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 whitelist/blacklist properties). If the publication already exists, it will be used. i.e CREATE PUBLICATION FOR TABLE

all_tables

String

publicationName (postgres)

The name of the Postgres 10 publication used for streaming changes from a plugin.Defaults to 'dbz_publication'

dbz_publication

String

sanitizeFieldNames (postgres)

Whether field names will be sanitized to Avro naming conventions

false

boolean

schemaBlacklist (postgres)

The schemas for which events must not be captured

String

schemaRefreshMode (postgres)

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.

columns_diff

String

schemaWhitelist (postgres)

The schemas for which events should be captured

String

skippedOperations (postgres)

The comma-separated list of operations to skip during streaming, defined as: 'i' for inserts; 'u' for updates; 'd' for deletes. By default, no operations will be skipped.

String

slotDropOnStop (postgres)

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

false

boolean

slotMaxRetries (postgres)

How many times to retry connecting to a replication slot when an attempt fails.

int

slotName (postgres)

The name of the Postgres logical decoding slot created for streaming changes from a plugin.Defaults to 'debezium

debezium

String

slotRetryDelayMs (postgres)

The number of milli-seconds to wait between retry attempts when the connector fails to connect to a replication slot.

10s

long

slotStreamParams (postgres)

Any optional parameters used by logical decoding plugin. Semi-colon separated. E.g. 'add-tables=public.table,public.table2;include-lsn=true'

String

snapshotCustomClass (postgres)

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.

String

snapshotDelayMs (postgres)

The number of milliseconds to delay before a snapshot will begin.

0ms

long

snapshotFetchSize (postgres)

The maximum number of records that should be loaded into memory while performing a snapshot

int

snapshotLockTimeoutMs (postgres)

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

10s

long

snapshotMode (postgres)

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.

initial

String

snapshotSelectStatement Overrides (postgres)

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.

String

sourceStructVersion (postgres)

A version of the format of the publicly visible source part in the message

String

statusUpdateIntervalMs (postgres)

Frequency in milliseconds for sending replication connection status updates to the server. Defaults to 10 seconds (10000 ms).

10s

int

tableBlacklist (postgres)

Description is not available here, please check Debezium website for corresponding key 'table.blacklist' description.

String

tableIgnoreBuiltin (postgres)

Flag specifying whether built-in tables should be ignored.

true

boolean

tableWhitelist (postgres)

The tables for which changes are to be captured

String

timePrecisionMode (postgres)

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 .

adaptive

String

toastedValuePlaceholder (postgres)

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.

__debezium_unavailable_value

String

tombstonesOnDelete (postgres)

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.

false

boolean

xminFetchIntervalMs (postgres)

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.

0ms

long

The Debezium PostgresSQL Connector endpoint is configured using URI syntax:

debezium-postgres:name

with the following path and query parameters:

Path Parameters (1 parameters):

Name	Description	Default	Type
name	Required Unique name for the connector. Attempting to register again with the same name will fail.		String

Name

Description

Default

Type

name

Required Unique name for the connector. Attempting to register again with the same name will fail.

String

Query Parameters (76 parameters):

Name	Description	Default	Type
additionalProperties (common)	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		Map
bridgeErrorHandler (consumer)	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.	false	boolean
internalKeyConverter (consumer)	The Converter class that should be used to serialize and deserialize key data for offsets. The default is JSON converter.	org.apache.kafka.connect.json.JsonConverter	String
internalValueConverter (consumer)	The Converter class that should be used to serialize and deserialize value data for offsets. The default is JSON converter.	org.apache.kafka.connect.json.JsonConverter	String
offsetCommitPolicy (consumer)	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.	io.debezium.embedded.spi.OffsetCommitPolicy.PeriodicCommitOffsetPolicy	String
offsetCommitTimeoutMs (consumer)	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.	5s	long
offsetFlushIntervalMs (consumer)	Interval at which to try committing offsets. The default is 1 minute.	60s	long
offsetStorage (consumer)	The name of the Java class that is responsible for persistence of connector offsets.	org.apache.kafka.connect.storage.FileOffsetBackingStore	String
offsetStorageFileName (consumer)	Path to file where offsets are to be stored. Required when offset.storage is set to the FileOffsetBackingStore.		String
offsetStoragePartitions (consumer)	The number of partitions used when creating the offset storage topic. Required when offset.storage is set to the 'KafkaOffsetBackingStore'.		int
offsetStorageReplicationFactor (consumer)	Replication factor used when creating the offset storage topic. Required when offset.storage is set to the KafkaOffsetBackingStore		int
offsetStorageTopic (consumer)	The name of the Kafka topic where offsets are to be stored. Required when offset.storage is set to the KafkaOffsetBackingStore.		String
exceptionHandler (consumer)	To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By default the consumer will deal with exceptions, that will be logged at WARN or ERROR level and ignored.		ExceptionHandler
exchangePattern (consumer)	Sets the exchange pattern when the consumer creates an exchange. The value can be one of: InOnly, InOut, InOptionalOut		ExchangePattern
basicPropertyBinding (advanced)	Whether the endpoint should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities	false	boolean
synchronous (advanced)	Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported).	false	boolean
binaryHandlingMode (postgres)	Specify how binary (blob, binary, etc.) columns should be represented in change events, including:'bytes' represents binary data as byte array (default)'base64' represents binary data as base64-encoded string’hex' represents binary data as hex-encoded (base16) string	bytes	String
columnBlacklist (postgres)	Regular expressions matching columns to exclude from change events		String
columnWhitelist (postgres)	Regular expressions matching columns to include in change events		String
converters (postgres)	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 '.'		String
databaseDbname (postgres)	The name of the database the connector should be monitoring		String
databaseHistoryFileFilename (postgres)	The path to the file that will be used to record the database history		String
databaseHostname (postgres)	Resolvable hostname or IP address of the Postgres database server.		String
databaseInitialStatements (postgres)	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.		String
databasePassword (postgres)	Required Password of the Postgres database user to be used when connecting to the database.		String
databasePort (postgres)	Port of the Postgres database server.	5432	int
databaseServerName (postgres)	Required 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.		String
databaseSslcert (postgres)	File containing the SSL Certificate for the client. See the Postgres SSL docs for further information		String
databaseSslfactory (postgres)	A name of class to that creates SSL Sockets. Use org.postgresql.ssl.NonValidatingFactory to disable SSL validation in development environments		String
databaseSslkey (postgres)	File containing the SSL private key for the client. See the Postgres SSL docs for further information		String
databaseSslmode (postgres)	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.	disable	String
databaseSslpassword (postgres)	Password to access the client private key from the file specified by 'database.sslkey'. See the Postgres SSL docs for further information		String
databaseSslrootcert (postgres)	File containing the root certificate(s) against which the server is validated. See the Postgres JDBC SSL docs for further information		String
databaseTcpkeepalive (postgres)	Enable or disable TCP keep-alive probe to avoid dropping TCP connection	true	boolean
databaseUser (postgres)	Name of the Postgres database user to be used when connecting to the database.		String
decimalHandlingMode (postgres)	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.	precise	String
eventProcessingFailureHandling Mode (postgres)	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.	fail	String
heartbeatActionQuery (postgres)	The query executed with every heartbeat. Defaults to an empty string.		String
heartbeatIntervalMs (postgres)	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.	0ms	int
heartbeatTopicsPrefix (postgres)	The prefix that is used to name heartbeat topics.Defaults to __debezium-heartbeat.	__debezium-heartbeat	String
hstoreHandlingMode (postgres)	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	json	String
includeUnknownDatatypes (postgres)	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.	false	boolean
intervalHandlingMode (postgres)	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	numeric	String
maxBatchSize (postgres)	Maximum size of each batch of source records. Defaults to 2048.	2048	int
maxQueueSize (postgres)	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.	8192	int
messageKeyColumns (postgres)	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		String
pluginName (postgres)	The name of the Postgres logical decoding plugin installed on the server. Supported values are 'decoderbufs' and 'wal2json'. Defaults to 'decoderbufs'.	decoderbufs	String
pollIntervalMs (postgres)	Frequency in milliseconds to wait for new change events to appear after receiving no events. Defaults to 500ms.	500ms	long
provideTransactionMetadata (postgres)	Enables transaction metadata extraction together with event counting	false	boolean
publicationAutocreateMode (postgres)	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 whitelist/blacklist properties). If the publication already exists, it will be used. i.e CREATE PUBLICATION FOR TABLE	all_tables	String
publicationName (postgres)	The name of the Postgres 10 publication used for streaming changes from a plugin.Defaults to 'dbz_publication'	dbz_publication	String
sanitizeFieldNames (postgres)	Whether field names will be sanitized to Avro naming conventions	false	boolean
schemaBlacklist (postgres)	The schemas for which events must not be captured		String
schemaRefreshMode (postgres)	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.	columns_diff	String
schemaWhitelist (postgres)	The schemas for which events should be captured		String
skippedOperations (postgres)	The comma-separated list of operations to skip during streaming, defined as: 'i' for inserts; 'u' for updates; 'd' for deletes. By default, no operations will be skipped.		String
slotDropOnStop (postgres)	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	false	boolean
slotMaxRetries (postgres)	How many times to retry connecting to a replication slot when an attempt fails.	6	int
slotName (postgres)	The name of the Postgres logical decoding slot created for streaming changes from a plugin.Defaults to 'debezium	debezium	String
slotRetryDelayMs (postgres)	The number of milli-seconds to wait between retry attempts when the connector fails to connect to a replication slot.	10s	long
slotStreamParams (postgres)	Any optional parameters used by logical decoding plugin. Semi-colon separated. E.g. 'add-tables=public.table,public.table2;include-lsn=true'		String
snapshotCustomClass (postgres)	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.		String
snapshotDelayMs (postgres)	The number of milliseconds to delay before a snapshot will begin.	0ms	long
snapshotFetchSize (postgres)	The maximum number of records that should be loaded into memory while performing a snapshot		int
snapshotLockTimeoutMs (postgres)	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	10s	long
snapshotMode (postgres)	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.	initial	String
snapshotSelectStatement Overrides (postgres)	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.		String
sourceStructVersion (postgres)	A version of the format of the publicly visible source part in the message	v2	String
statusUpdateIntervalMs (postgres)	Frequency in milliseconds for sending replication connection status updates to the server. Defaults to 10 seconds (10000 ms).	10s	int
tableBlacklist (postgres)	Description is not available here, please check Debezium website for corresponding key 'table.blacklist' description.		String
tableIgnoreBuiltin (postgres)	Flag specifying whether built-in tables should be ignored.	true	boolean
tableWhitelist (postgres)	The tables for which changes are to be captured		String
timePrecisionMode (postgres)	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 .	adaptive	String
toastedValuePlaceholder (postgres)	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.	__debezium_unavailable_value	String
tombstonesOnDelete (postgres)	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.	false	boolean
xminFetchIntervalMs (postgres)	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.	0ms	long

Name

Description

Default

Type

additionalProperties (common)

Map

bridgeErrorHandler (consumer)

false

boolean

internalKeyConverter (consumer)

The Converter class that should be used to serialize and deserialize key data for offsets. The default is JSON converter.

org.apache.kafka.connect.json.JsonConverter

String

internalValueConverter (consumer)

The Converter class that should be used to serialize and deserialize value data for offsets. The default is JSON converter.

org.apache.kafka.connect.json.JsonConverter

String

offsetCommitPolicy (consumer)

io.debezium.embedded.spi.OffsetCommitPolicy.PeriodicCommitOffsetPolicy

String

offsetCommitTimeoutMs (consumer)

long

offsetFlushIntervalMs (consumer)

Interval at which to try committing offsets. The default is 1 minute.

60s

long

offsetStorage (consumer)

The name of the Java class that is responsible for persistence of connector offsets.

org.apache.kafka.connect.storage.FileOffsetBackingStore

String

offsetStorageFileName (consumer)

Path to file where offsets are to be stored. Required when offset.storage is set to the FileOffsetBackingStore.

String

offsetStoragePartitions (consumer)

The number of partitions used when creating the offset storage topic. Required when offset.storage is set to the 'KafkaOffsetBackingStore'.

int

offsetStorageReplicationFactor (consumer)

Replication factor used when creating the offset storage topic. Required when offset.storage is set to the KafkaOffsetBackingStore

int

offsetStorageTopic (consumer)

The name of the Kafka topic where offsets are to be stored. Required when offset.storage is set to the KafkaOffsetBackingStore.

String

exceptionHandler (consumer)

To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By default the consumer will deal with exceptions, that will be logged at WARN or ERROR level and ignored.

ExceptionHandler

exchangePattern (consumer)

Sets the exchange pattern when the consumer creates an exchange. The value can be one of: InOnly, InOut, InOptionalOut

ExchangePattern

basicPropertyBinding (advanced)

Whether the endpoint should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities

false

boolean

synchronous (advanced)

Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported).

false

boolean

binaryHandlingMode (postgres)

bytes

String

columnBlacklist (postgres)

Regular expressions matching columns to exclude from change events

String

columnWhitelist (postgres)

Regular expressions matching columns to include in change events

String

converters (postgres)

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 '.'

String

databaseDbname (postgres)

The name of the database the connector should be monitoring

String

databaseHistoryFileFilename (postgres)

The path to the file that will be used to record the database history

String

databaseHostname (postgres)

Resolvable hostname or IP address of the Postgres database server.

String

databaseInitialStatements (postgres)

String

databasePassword (postgres)

Required Password of the Postgres database user to be used when connecting to the database.

String

databasePort (postgres)

Port of the Postgres database server.

5432

int

databaseServerName (postgres)

String

databaseSslcert (postgres)

File containing the SSL Certificate for the client. See the Postgres SSL docs for further information

String

databaseSslfactory (postgres)

A name of class to that creates SSL Sockets. Use org.postgresql.ssl.NonValidatingFactory to disable SSL validation in development environments

String

databaseSslkey (postgres)

File containing the SSL private key for the client. See the Postgres SSL docs for further information

String

databaseSslmode (postgres)

disable

String

databaseSslpassword (postgres)

Password to access the client private key from the file specified by 'database.sslkey'. See the Postgres SSL docs for further information

String

databaseSslrootcert (postgres)

File containing the root certificate(s) against which the server is validated. See the Postgres JDBC SSL docs for further information

String

databaseTcpkeepalive (postgres)

Enable or disable TCP keep-alive probe to avoid dropping TCP connection

true

boolean

databaseUser (postgres)

Name of the Postgres database user to be used when connecting to the database.

String

decimalHandlingMode (postgres)

precise

String

eventProcessingFailureHandling Mode (postgres)

fail

String

heartbeatActionQuery (postgres)

The query executed with every heartbeat. Defaults to an empty string.

String

heartbeatIntervalMs (postgres)

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.

0ms

int

heartbeatTopicsPrefix (postgres)

The prefix that is used to name heartbeat topics.Defaults to __debezium-heartbeat.

__debezium-heartbeat

String

hstoreHandlingMode (postgres)

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

json

String

includeUnknownDatatypes (postgres)

false

boolean

intervalHandlingMode (postgres)

numeric

String

maxBatchSize (postgres)

Maximum size of each batch of source records. Defaults to 2048.

2048

int

maxQueueSize (postgres)

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.

8192

int

messageKeyColumns (postgres)

String

pluginName (postgres)

The name of the Postgres logical decoding plugin installed on the server. Supported values are 'decoderbufs' and 'wal2json'. Defaults to 'decoderbufs'.

decoderbufs

String

pollIntervalMs (postgres)

Frequency in milliseconds to wait for new change events to appear after receiving no events. Defaults to 500ms.

500ms

long

provideTransactionMetadata (postgres)

Enables transaction metadata extraction together with event counting

false

boolean

publicationAutocreateMode (postgres)

all_tables

String

publicationName (postgres)

The name of the Postgres 10 publication used for streaming changes from a plugin.Defaults to 'dbz_publication'

dbz_publication

String

sanitizeFieldNames (postgres)

Whether field names will be sanitized to Avro naming conventions

false

boolean

schemaBlacklist (postgres)

The schemas for which events must not be captured

String

schemaRefreshMode (postgres)

columns_diff

String

schemaWhitelist (postgres)

The schemas for which events should be captured

String

skippedOperations (postgres)

The comma-separated list of operations to skip during streaming, defined as: 'i' for inserts; 'u' for updates; 'd' for deletes. By default, no operations will be skipped.

String

slotDropOnStop (postgres)

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

false

boolean

slotMaxRetries (postgres)

How many times to retry connecting to a replication slot when an attempt fails.

int

slotName (postgres)

The name of the Postgres logical decoding slot created for streaming changes from a plugin.Defaults to 'debezium

debezium

String

slotRetryDelayMs (postgres)

The number of milli-seconds to wait between retry attempts when the connector fails to connect to a replication slot.

10s

long

slotStreamParams (postgres)

Any optional parameters used by logical decoding plugin. Semi-colon separated. E.g. 'add-tables=public.table,public.table2;include-lsn=true'

String

snapshotCustomClass (postgres)

String

snapshotDelayMs (postgres)

The number of milliseconds to delay before a snapshot will begin.

0ms

long

snapshotFetchSize (postgres)

The maximum number of records that should be loaded into memory while performing a snapshot

int

snapshotLockTimeoutMs (postgres)

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

10s

long

snapshotMode (postgres)

initial

String

snapshotSelectStatement Overrides (postgres)

String

sourceStructVersion (postgres)

A version of the format of the publicly visible source part in the message

String

statusUpdateIntervalMs (postgres)

Frequency in milliseconds for sending replication connection status updates to the server. Defaults to 10 seconds (10000 ms).

10s

int

tableBlacklist (postgres)

Description is not available here, please check Debezium website for corresponding key 'table.blacklist' description.

String

tableIgnoreBuiltin (postgres)

Flag specifying whether built-in tables should be ignored.

true

boolean

tableWhitelist (postgres)

The tables for which changes are to be captured

String

timePrecisionMode (postgres)

adaptive

String

toastedValuePlaceholder (postgres)

__debezium_unavailable_value

String

tombstonesOnDelete (postgres)

false

boolean

xminFetchIntervalMs (postgres)

0ms

long

For more information about configuration: https://debezium.io/documentation/reference/0.10/operations/embedded.html#engine-properties https://debezium.io/documentation/reference/0.10/connectors/postgresql.html#connector-properties

Message headers

Consumer headers

The following headers are available when consuming change events from Debezium.

Header constant Header value Type Description

Header constant	Header value	Type	Description
`DebeziumConstants.HEADER_IDENTIFIER`	`"CamelDebeziumIdentifier"`	`String`	The identifier of the connector, normally is this format "{server-name}.{database-name}.{table-name}".
`DebeziumConstants.HEADER_KEY`	`"CamelDebeziumKey"`	`Struct`	The key of the event, normally is the table Primary Key.
`DebeziumConstants.HEADER_SOURCE_METADATA`	`"CamelDebeziumSourceMetadata"`	`Map`	The metadata about the source event, for example `table` name, database `name`, log position, etc, please refer to the Debezium documentation for more info.
`DebeziumConstants.HEADER_OPERATION`	`"CamelDebeziumOperation"`	`String`	If presents, the type of event operation. Values for the connector are `c` for create (or insert), `u` for update, `d` for delete or `r` in case of a snapshot event.
`DebeziumConstants.HEADER_TIMESTAMP`	`"CamelDebeziumTimestamp"`	`Long`	If presents, the time (using the system clock in the JVM) at which the connector processed the event.
`DebeziumConstants.HEADER_BEFORE`	`"CamelDebeziumBefore"`	`Struct`	If presents, contains the state of the row before the event occurred.

DebeziumConstants.HEADER_IDENTIFIER

"CamelDebeziumIdentifier"

String

The identifier of the connector, normally is this format "{server-name}.{database-name}.{table-name}".

DebeziumConstants.HEADER_KEY

"CamelDebeziumKey"

Struct

The key of the event, normally is the table Primary Key.

DebeziumConstants.HEADER_SOURCE_METADATA

"CamelDebeziumSourceMetadata"

Map

The metadata about the source event, for example table name, database name, log position, etc, please refer to the Debezium documentation for more info.

DebeziumConstants.HEADER_OPERATION

"CamelDebeziumOperation"

String

If presents, the type of event operation. Values for the connector are c for create (or insert), u for update, d for delete or r in case of a snapshot event.

DebeziumConstants.HEADER_TIMESTAMP

"CamelDebeziumTimestamp"

Long

If presents, the time (using the system clock in the JVM) at which the connector processed the event.

DebeziumConstants.HEADER_BEFORE

"CamelDebeziumBefore"

Struct

If presents, contains the state of the row before the event occurred.

Message body

The message body if is not null (in case of tombstones), it contains the state of the row after the event occurred as Struct format or Map format if you use the included Type Converter from Struct to Map (please look below for more explanation).

Samples

Consuming events

Here is a very simple route that you can use in order to listen to Debezium events from PostgresSQL connector.

from("debezium-postgres:dbz-test-1?offsetStorageFileName=/usr/offset-file-1.dat&databaseHostName=localhost&databaseUser=debezium&databasePassword=dbz&databaseServerName=my-app-connector&databaseHistoryFileName=/usr/history-file-1.dat")
    .log("Event received from Debezium : ${body}")
    .log("    with this identifier ${headers.CamelDebeziumIdentifier}")
    .log("    with these source metadata ${headers.CamelDebeziumSourceMetadata}")
    .log("    the event occured upon this operation '${headers.CamelDebeziumSourceOperation}'")
    .log("    on this database '${headers.CamelDebeziumSourceMetadata[db]}' and this table '${headers.CamelDebeziumSourceMetadata[table]}'")
    .log("    with the key ${headers.CamelDebeziumKey}")
    .log("    the previous value is ${headers.CamelDebeziumBefore}")

By default, the component will emit the events in the body and CamelDebeziumBefore header as Struct data type, the reasoning behind this, is to perceive the schema information in case is needed. However, the component as well contains a Type Converter that converts from default output type of Struct to Map in order to leverage Camel’s rich Data Format types which many of them work out of box with Map data type. To use it, you can either add Map.class type when you access the message e.g: exchange.getIn().getBody(Map.class), or you can convert the body always to Map from the route builder by adding .convertBodyTo(Map.class) to your Camel Route DSL after from statement.

We mentioned above about the schema, which can be used in case you need to perform advance data transformation and the schema is needed for that. If you choose not to convert your body to Map, you can obtain the schema information as Schema type from Struct like this:

from("debezium-postgres:[name]?[options]])
    .process(exchange -> {
        final Struct bodyValue = exchange.getIn().getBody(Struct.class);
        final Schema schemaValue = bodyValue.schema();

        log.info("Body value is :" + bodyValue);
        log.info("With Schema : " + schemaValue);
        log.info("And fields of :" + schemaValue.fields());
        log.info("Field name has `" + schemaValue.field("name").schema() + "` type");
    });

Important Note: This component is a thin wrapper around Debezium Engine as mentioned, therefore before using this component in production, you need to understand how Debezium works and how configurations can reflect the expected behavior, especially in regards to handling failures.

Spring Boot Auto-Configuration

When using debezium-postgres with Spring Boot make sure to use the following Maven dependency to have support for auto configuration:

<dependency>
  <groupId>org.apache.camel.springboot</groupId>
  <artifactId>camel-debezium-postgres-starter</artifactId>
  <version>x.x.x</version>
  <!-- use the same version as your Camel core version -->
</dependency>

The component supports 75 options, which are listed below.

Name	Description	Default	Type
camel.component.debezium-postgres.additional-properties	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		Map
camel.component.debezium-postgres.basic-property-binding	Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities	false	Boolean
camel.component.debezium-postgres.binary-handling-mode	Specify how binary (blob, binary, etc.) columns should be represented in change events, including:'bytes' represents binary data as byte array (default)'base64' represents binary data as base64-encoded string’hex' represents binary data as hex-encoded (base16) string	bytes	String
camel.component.debezium-postgres.bridge-error-handler	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.	false	Boolean
camel.component.debezium-postgres.column-blacklist	Regular expressions matching columns to exclude from change events		String
camel.component.debezium-postgres.column-whitelist	Regular expressions matching columns to include in change events		String
camel.component.debezium-postgres.configuration	Allow pre-configured Configurations to be set. The option is a org.apache.camel.component.debezium.configuration.PostgresConnectorEmbeddedDebeziumConfiguration type.		String
camel.component.debezium-postgres.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 '.'		String
camel.component.debezium-postgres.database-dbname	The name of the database the connector should be monitoring		String
camel.component.debezium-postgres.database-history-file-filename	The path to the file that will be used to record the database history		String
camel.component.debezium-postgres.database-hostname	Resolvable hostname or IP address of the Postgres database server.		String
camel.component.debezium-postgres.database-initial-statements	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.		String
camel.component.debezium-postgres.database-password	Password of the Postgres database user to be used when connecting to the database.		String
camel.component.debezium-postgres.database-port	Port of the Postgres database server.	5432	Integer
camel.component.debezium-postgres.database-server-name	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.		String
camel.component.debezium-postgres.database-sslcert	File containing the SSL Certificate for the client. See the Postgres SSL docs for further information		String
camel.component.debezium-postgres.database-sslfactory	A name of class to that creates SSL Sockets. Use org.postgresql.ssl.NonValidatingFactory to disable SSL validation in development environments		String
camel.component.debezium-postgres.database-sslkey	File containing the SSL private key for the client. See the Postgres SSL docs for further information		String
camel.component.debezium-postgres.database-sslmode	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.	disable	String
camel.component.debezium-postgres.database-sslpassword	Password to access the client private key from the file specified by 'database.sslkey'. See the Postgres SSL docs for further information		String
camel.component.debezium-postgres.database-sslrootcert	File containing the root certificate(s) against which the server is validated. See the Postgres JDBC SSL docs for further information		String
camel.component.debezium-postgres.database-tcpkeepalive	Enable or disable TCP keep-alive probe to avoid dropping TCP connection	true	Boolean
camel.component.debezium-postgres.database-user	Name of the Postgres database user to be used when connecting to the database.		String
camel.component.debezium-postgres.decimal-handling-mode	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.	precise	String
camel.component.debezium-postgres.enabled	Whether to enable auto configuration of the debezium-postgres component. This is enabled by default.		Boolean
camel.component.debezium-postgres.event-processing-failure-handling-mode	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.	fail	String
camel.component.debezium-postgres.heartbeat-action-query	The query executed with every heartbeat. Defaults to an empty string.		String
camel.component.debezium-postgres.heartbeat-interval-ms	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.	0ms	String
camel.component.debezium-postgres.heartbeat-topics-prefix	The prefix that is used to name heartbeat topics.Defaults to __debezium-heartbeat.	__debezium-heartbeat	String
camel.component.debezium-postgres.hstore-handling-mode	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	json	String
camel.component.debezium-postgres.include-unknown-datatypes	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.	false	Boolean
camel.component.debezium-postgres.internal-key-converter	The Converter class that should be used to serialize and deserialize key data for offsets. The default is JSON converter.	org.apache.kafka.connect.json.JsonConverter	String
camel.component.debezium-postgres.internal-value-converter	The Converter class that should be used to serialize and deserialize value data for offsets. The default is JSON converter.	org.apache.kafka.connect.json.JsonConverter	String
camel.component.debezium-postgres.interval-handling-mode	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	numeric	String
camel.component.debezium-postgres.max-batch-size	Maximum size of each batch of source records. Defaults to 2048.	2048	Integer
camel.component.debezium-postgres.max-queue-size	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.	8192	Integer
camel.component.debezium-postgres.message-key-columns	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		String
camel.component.debezium-postgres.offset-commit-policy	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.	io.debezium.embedded.spi.OffsetCommitPolicy.PeriodicCommitOffsetPolicy	String
camel.component.debezium-postgres.offset-commit-timeout-ms	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.	5s	String
camel.component.debezium-postgres.offset-flush-interval-ms	Interval at which to try committing offsets. The default is 1 minute. The option is a long type.	60s	String
camel.component.debezium-postgres.offset-storage	The name of the Java class that is responsible for persistence of connector offsets.	org.apache.kafka.connect.storage.FileOffsetBackingStore	String
camel.component.debezium-postgres.offset-storage-file-name	Path to file where offsets are to be stored. Required when offset.storage is set to the FileOffsetBackingStore.		String
camel.component.debezium-postgres.offset-storage-partitions	The number of partitions used when creating the offset storage topic. Required when offset.storage is set to the 'KafkaOffsetBackingStore'.		Integer
camel.component.debezium-postgres.offset-storage-replication-factor	Replication factor used when creating the offset storage topic. Required when offset.storage is set to the KafkaOffsetBackingStore		Integer
camel.component.debezium-postgres.offset-storage-topic	The name of the Kafka topic where offsets are to be stored. Required when offset.storage is set to the KafkaOffsetBackingStore.		String
camel.component.debezium-postgres.plugin-name	The name of the Postgres logical decoding plugin installed on the server. Supported values are 'decoderbufs' and 'wal2json'. Defaults to 'decoderbufs'.	decoderbufs	String
camel.component.debezium-postgres.poll-interval-ms	Frequency in milliseconds to wait for new change events to appear after receiving no events. Defaults to 500ms. The option is a long type.	500ms	String
camel.component.debezium-postgres.provide-transaction-metadata	Enables transaction metadata extraction together with event counting	false	Boolean
camel.component.debezium-postgres.publication-autocreate-mode	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 whitelist/blacklist properties). If the publication already exists, it will be used. i.e CREATE PUBLICATION FOR TABLE	all_tables	String
camel.component.debezium-postgres.publication-name	The name of the Postgres 10 publication used for streaming changes from a plugin.Defaults to 'dbz_publication'	dbz_publication	String
camel.component.debezium-postgres.sanitize-field-names	Whether field names will be sanitized to Avro naming conventions	false	Boolean
camel.component.debezium-postgres.schema-blacklist	The schemas for which events must not be captured		String
camel.component.debezium-postgres.schema-refresh-mode	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.	columns_diff	String
camel.component.debezium-postgres.schema-whitelist	The schemas for which events should be captured		String
camel.component.debezium-postgres.skipped-operations	The comma-separated list of operations to skip during streaming, defined as: 'i' for inserts; 'u' for updates; 'd' for deletes. By default, no operations will be skipped.		String
camel.component.debezium-postgres.slot-drop-on-stop	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	false	Boolean
camel.component.debezium-postgres.slot-max-retries	How many times to retry connecting to a replication slot when an attempt fails.	6	Integer
camel.component.debezium-postgres.slot-name	The name of the Postgres logical decoding slot created for streaming changes from a plugin.Defaults to 'debezium	debezium	String
camel.component.debezium-postgres.slot-retry-delay-ms	The number of milli-seconds to wait between retry attempts when the connector fails to connect to a replication slot. The option is a long type.	10s	String
camel.component.debezium-postgres.slot-stream-params	Any optional parameters used by logical decoding plugin. Semi-colon separated. E.g. 'add-tables=public.table,public.table2;include-lsn=true'		String
camel.component.debezium-postgres.snapshot-custom-class	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.		String
camel.component.debezium-postgres.snapshot-delay-ms	The number of milliseconds to delay before a snapshot will begin. The option is a long type.	0ms	String
camel.component.debezium-postgres.snapshot-fetch-size	The maximum number of records that should be loaded into memory while performing a snapshot		Integer
camel.component.debezium-postgres.snapshot-lock-timeout-ms	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.	10s	String
camel.component.debezium-postgres.snapshot-mode	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.	initial	String
camel.component.debezium-postgres.snapshot-select-statement-overrides	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.		String
camel.component.debezium-postgres.source-struct-version	A version of the format of the publicly visible source part in the message	v2	String
camel.component.debezium-postgres.status-update-interval-ms	Frequency in milliseconds for sending replication connection status updates to the server. Defaults to 10 seconds (10000 ms). The option is a int type.	10s	String
camel.component.debezium-postgres.table-blacklist	Description is not available here, please check Debezium website for corresponding key 'table.blacklist' description.		String
camel.component.debezium-postgres.table-ignore-builtin	Flag specifying whether built-in tables should be ignored.	true	Boolean
camel.component.debezium-postgres.table-whitelist	The tables for which changes are to be captured		String
camel.component.debezium-postgres.time-precision-mode	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 .	adaptive	String
camel.component.debezium-postgres.toasted-value-placeholder	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.	__debezium_unavailable_value	String
camel.component.debezium-postgres.tombstones-on-delete	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.	false	Boolean
camel.component.debezium-postgres.xmin-fetch-interval-ms	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.	0ms	String

Name

Description

Default

Type

camel.component.debezium-postgres.additional-properties

Map

camel.component.debezium-postgres.basic-property-binding

Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities

false

Boolean

camel.component.debezium-postgres.binary-handling-mode

bytes

String

camel.component.debezium-postgres.bridge-error-handler

false

Boolean

camel.component.debezium-postgres.column-blacklist

Regular expressions matching columns to exclude from change events

String

camel.component.debezium-postgres.column-whitelist

Regular expressions matching columns to include in change events

String

camel.component.debezium-postgres.configuration

Allow pre-configured Configurations to be set. The option is a org.apache.camel.component.debezium.configuration.PostgresConnectorEmbeddedDebeziumConfiguration type.

String

camel.component.debezium-postgres.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 '.'

String

camel.component.debezium-postgres.database-dbname

The name of the database the connector should be monitoring

String

camel.component.debezium-postgres.database-history-file-filename

The path to the file that will be used to record the database history

String

camel.component.debezium-postgres.database-hostname

Resolvable hostname or IP address of the Postgres database server.

String

camel.component.debezium-postgres.database-initial-statements

String

camel.component.debezium-postgres.database-password

Password of the Postgres database user to be used when connecting to the database.

String

camel.component.debezium-postgres.database-port

Port of the Postgres database server.

5432

Integer

camel.component.debezium-postgres.database-server-name

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.

String

camel.component.debezium-postgres.database-sslcert

File containing the SSL Certificate for the client. See the Postgres SSL docs for further information

String

camel.component.debezium-postgres.database-sslfactory

A name of class to that creates SSL Sockets. Use org.postgresql.ssl.NonValidatingFactory to disable SSL validation in development environments

String

camel.component.debezium-postgres.database-sslkey

File containing the SSL private key for the client. See the Postgres SSL docs for further information

String

camel.component.debezium-postgres.database-sslmode

disable

String

camel.component.debezium-postgres.database-sslpassword

Password to access the client private key from the file specified by 'database.sslkey'. See the Postgres SSL docs for further information

String

camel.component.debezium-postgres.database-sslrootcert

File containing the root certificate(s) against which the server is validated. See the Postgres JDBC SSL docs for further information

String

camel.component.debezium-postgres.database-tcpkeepalive

Enable or disable TCP keep-alive probe to avoid dropping TCP connection

true

Boolean

camel.component.debezium-postgres.database-user

Name of the Postgres database user to be used when connecting to the database.

String

camel.component.debezium-postgres.decimal-handling-mode

precise

String

camel.component.debezium-postgres.enabled

Whether to enable auto configuration of the debezium-postgres component. This is enabled by default.

Boolean

camel.component.debezium-postgres.event-processing-failure-handling-mode

fail

String

camel.component.debezium-postgres.heartbeat-action-query

The query executed with every heartbeat. Defaults to an empty string.

String

camel.component.debezium-postgres.heartbeat-interval-ms

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.

0ms

String

camel.component.debezium-postgres.heartbeat-topics-prefix

The prefix that is used to name heartbeat topics.Defaults to __debezium-heartbeat.

__debezium-heartbeat

String

camel.component.debezium-postgres.hstore-handling-mode

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

json

String

camel.component.debezium-postgres.include-unknown-datatypes

false

Boolean

camel.component.debezium-postgres.internal-key-converter

The Converter class that should be used to serialize and deserialize key data for offsets. The default is JSON converter.

org.apache.kafka.connect.json.JsonConverter

String

camel.component.debezium-postgres.internal-value-converter

The Converter class that should be used to serialize and deserialize value data for offsets. The default is JSON converter.

org.apache.kafka.connect.json.JsonConverter

String

camel.component.debezium-postgres.interval-handling-mode

numeric

String

camel.component.debezium-postgres.max-batch-size

Maximum size of each batch of source records. Defaults to 2048.

2048

Integer

camel.component.debezium-postgres.max-queue-size

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.

8192

Integer

camel.component.debezium-postgres.message-key-columns

String

camel.component.debezium-postgres.offset-commit-policy

io.debezium.embedded.spi.OffsetCommitPolicy.PeriodicCommitOffsetPolicy

String

camel.component.debezium-postgres.offset-commit-timeout-ms

String

camel.component.debezium-postgres.offset-flush-interval-ms

Interval at which to try committing offsets. The default is 1 minute. The option is a long type.

60s

String

camel.component.debezium-postgres.offset-storage

The name of the Java class that is responsible for persistence of connector offsets.

org.apache.kafka.connect.storage.FileOffsetBackingStore

String

camel.component.debezium-postgres.offset-storage-file-name

Path to file where offsets are to be stored. Required when offset.storage is set to the FileOffsetBackingStore.

String

camel.component.debezium-postgres.offset-storage-partitions

The number of partitions used when creating the offset storage topic. Required when offset.storage is set to the 'KafkaOffsetBackingStore'.

Integer

camel.component.debezium-postgres.offset-storage-replication-factor

Replication factor used when creating the offset storage topic. Required when offset.storage is set to the KafkaOffsetBackingStore

Integer

camel.component.debezium-postgres.offset-storage-topic

The name of the Kafka topic where offsets are to be stored. Required when offset.storage is set to the KafkaOffsetBackingStore.

String

camel.component.debezium-postgres.plugin-name

The name of the Postgres logical decoding plugin installed on the server. Supported values are 'decoderbufs' and 'wal2json'. Defaults to 'decoderbufs'.

decoderbufs

String

camel.component.debezium-postgres.poll-interval-ms

Frequency in milliseconds to wait for new change events to appear after receiving no events. Defaults to 500ms. The option is a long type.

500ms

String

camel.component.debezium-postgres.provide-transaction-metadata

Enables transaction metadata extraction together with event counting

false

Boolean

camel.component.debezium-postgres.publication-autocreate-mode

all_tables

String

camel.component.debezium-postgres.publication-name

The name of the Postgres 10 publication used for streaming changes from a plugin.Defaults to 'dbz_publication'

dbz_publication

String

camel.component.debezium-postgres.sanitize-field-names

Whether field names will be sanitized to Avro naming conventions

false

Boolean

camel.component.debezium-postgres.schema-blacklist

The schemas for which events must not be captured

String

camel.component.debezium-postgres.schema-refresh-mode

columns_diff

String

camel.component.debezium-postgres.schema-whitelist

The schemas for which events should be captured

String

camel.component.debezium-postgres.skipped-operations

The comma-separated list of operations to skip during streaming, defined as: 'i' for inserts; 'u' for updates; 'd' for deletes. By default, no operations will be skipped.

String

camel.component.debezium-postgres.slot-drop-on-stop

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

false

Boolean

camel.component.debezium-postgres.slot-max-retries

How many times to retry connecting to a replication slot when an attempt fails.

Integer

camel.component.debezium-postgres.slot-name

The name of the Postgres logical decoding slot created for streaming changes from a plugin.Defaults to 'debezium

debezium

String

camel.component.debezium-postgres.slot-retry-delay-ms

The number of milli-seconds to wait between retry attempts when the connector fails to connect to a replication slot. The option is a long type.

10s

String

camel.component.debezium-postgres.slot-stream-params

Any optional parameters used by logical decoding plugin. Semi-colon separated. E.g. 'add-tables=public.table,public.table2;include-lsn=true'

String

camel.component.debezium-postgres.snapshot-custom-class

String

camel.component.debezium-postgres.snapshot-delay-ms

The number of milliseconds to delay before a snapshot will begin. The option is a long type.

0ms

String

camel.component.debezium-postgres.snapshot-fetch-size

The maximum number of records that should be loaded into memory while performing a snapshot

Integer

camel.component.debezium-postgres.snapshot-lock-timeout-ms

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.

10s

String

camel.component.debezium-postgres.snapshot-mode

initial

String

camel.component.debezium-postgres.snapshot-select-statement-overrides

String

camel.component.debezium-postgres.source-struct-version

A version of the format of the publicly visible source part in the message

String

camel.component.debezium-postgres.status-update-interval-ms

Frequency in milliseconds for sending replication connection status updates to the server. Defaults to 10 seconds (10000 ms). The option is a int type.

10s

String

camel.component.debezium-postgres.table-blacklist

Description is not available here, please check Debezium website for corresponding key 'table.blacklist' description.

String

camel.component.debezium-postgres.table-ignore-builtin

Flag specifying whether built-in tables should be ignored.

true

Boolean

camel.component.debezium-postgres.table-whitelist

The tables for which changes are to be captured

String

camel.component.debezium-postgres.time-precision-mode

adaptive

String

camel.component.debezium-postgres.toasted-value-placeholder

__debezium_unavailable_value

String

camel.component.debezium-postgres.tombstones-on-delete

false

Boolean

camel.component.debezium-postgres.xmin-fetch-interval-ms

0ms

String