| // kafka-connector options: START |
| [[camel-debezium-postgres-kafka-connector-source]] |
| = camel-debezium-postgres-kafka-connector source configuration |
| |
| When using camel-debezium-postgres-kafka-connector as source make sure to use the following Maven dependency to have support for the connector: |
| |
| [source,xml] |
| ---- |
| <dependency> |
| <groupId>org.apache.camel.kafkaconnector</groupId> |
| <artifactId>camel-debezium-postgres-kafka-connector</artifactId> |
| <version>x.x.x</version> |
| <!-- use the same version as your Camel Kafka connector version --> |
| </dependency> |
| ---- |
| |
| |
| The camel-debezium-postgres source connector supports 70 options, which are listed below. |
| |
| |
| |
| [width="100%",cols="2,5,^1,2",options="header"] |
| |=== |
| | Name | Description | Default | Priority |
| | *camel.source.path.name* | Unique name for the connector. Attempting to register again with the same name will fail. | null | ConfigDef.Importance.HIGH |
| | * camel.source.endpoint.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 | null | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.bridge ErrorHandler* | 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 | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.internal KeyConverter* | 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" | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.internal ValueConverter* | 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" | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.offset CommitPolicy* | 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" | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.offset CommitTimeoutMs* | 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. | 5000L | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.offset FlushIntervalMs* | Interval at which to try committing offsets. The default is 1 minute. | 60000L | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.offset Storage* | The name of the Java class that is responsible for persistence of connector offsets. | "org.apache.kafka.connect.storage.FileOffsetBackingStore" | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.offset StorageFileName* | Path to file where offsets are to be stored. Required when offset.storage is set to the FileOffsetBackingStore. | null | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.offset StoragePartitions* | The number of partitions used when creating the offset storage topic. Required when offset.storage is set to the 'KafkaOffsetBackingStore'. | null | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.offset StorageReplicationFactor* | Replication factor used when creating the offset storage topic. Required when offset.storage is set to the KafkaOffsetBackingStore | null | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.offset StorageTopic* | The name of the Kafka topic where offsets are to be stored. Required when offset.storage is set to the KafkaOffsetBackingStore. | null | ConfigDef.Importance.MEDIUM |
| | * camel.source.endpoint.exception Handler* | 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. | null | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.exchange Pattern* | Sets the exchange pattern when the consumer creates an exchange. One of: [InOnly] [InOut] [InOptionalOut] | null | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.basic PropertyBinding* | Whether the endpoint should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities | false | ConfigDef.Importance.MEDIUM |
| | * camel.source.endpoint.synchronous* | Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported). | false | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.column Blacklist* | Description is not available here, please check Debezium website for corresponding key 'column.blacklist' description. | null | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.database Dbname* | The name of the database the connector should be monitoring | null | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.database HistoryFileFilename* | The path to the file that will be used to record the database history | null | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.database Hostname* | Resolvable hostname or IP address of the Postgres database server. | null | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.database InitialStatements* | 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. | null | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.database Password* | Password of the Postgres database user to be used when connecting to the database. | null | ConfigDef.Importance.HIGH |
| | *camel.source.endpoint.database Port* | Port of the Postgres database server. | 5432 | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.database ServerName* | 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. | null | ConfigDef.Importance.HIGH |
| | *camel.source.endpoint.database Sslcert* | File containing the SSL Certificate for the client. See the Postgres SSL docs for further information | null | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.database Sslfactory* | A name of class to that creates SSL Sockets. Use org.postgresql.ssl.NonValidatingFactory to disable SSL validation in development environments | null | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.database Sslkey* | File containing the SSL private key for the client. See the Postgres SSL docs for further information | null | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.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" | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.database Sslpassword* | Password to access the client private key from the file specified by 'database.sslkey'. See the Postgres SSL docs for further information | null | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.database Sslrootcert* | File containing the root certificate(s) against which the server is validated. See the Postgres JDBC SSL docs for further information | null | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.database Tcpkeepalive* | Enable or disable TCP keep-alive probe to avoid dropping TCP connection | true | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.database User* | Name of the Postgres database user to be used when connecting to the database. | null | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.decimal HandlingMode* | 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" | ConfigDef.Importance.MEDIUM |
| | * camel.source.endpoint.heartbeat IntervalMs* | 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. | 0 | ConfigDef.Importance.MEDIUM |
| | * camel.source.endpoint.heartbeat TopicsPrefix* | The prefix that is used to name heartbeat topics.Defaults to __debezium-heartbeat. | "__debezium-heartbeat" | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.hstore HandlingMode* | Specify how HSTORE columns should be represented in change events, including:'json' represents values as json string'map' (default) represents values using java.util.Map | "json" | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.include UnknownDatatypes* | 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 | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.interval HandlingMode* | 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" | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.maxBatch Size* | Maximum size of each batch of source records. Defaults to 2048. | 2048 | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.maxQueue 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 | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.message KeyColumns* | 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 | null | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.plugin Name* | The name of the Postgres logical decoding plugin installed on the server. Supported values are 'decoderbufs' and 'wal2json'. Defaults to 'decoderbufs'. | "decoderbufs" | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.poll IntervalMs* | Frequency in milliseconds to wait for new change events to appear after receiving no events. Defaults to 500ms. | 500L | ConfigDef.Importance.MEDIUM |
| | * camel.source.endpoint.publication Name* | The name of the Postgres 10 publication used for streaming changes from a plugin.Defaults to 'dbz_publication' | "dbz_publication" | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.schema Blacklist* | The schemas for which events must not be captured | null | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.schema RefreshMode* | 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" | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.schema Whitelist* | The schemas for which events should be captured | null | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.slotDrop OnStop* | 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 | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.slotMax Retries* | How many times to retry connecting to a replication slot when an attempt fails. | 6 | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.slotName* | The name of the Postgres logical decoding slot created for streaming changes from a plugin.Defaults to 'debezium | "debezium" | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.slot RetryDelayMs* | The number of milli-seconds to wait between retry attempts when the connector fails to connect to a replication slot. | 10000L | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.slot StreamParams* | Any optional parameters used by logical decoding plugin. Semi-colon separated. E.g. 'add-tables=public.table,public.table2;include-lsn=true' | null | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.snapshot CustomClass* | 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. | null | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.snapshot DelayMs* | The number of milliseconds to delay before a snapshot will begin. | 0L | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.snapshot FetchSize* | The maximum number of records that should be loaded into memory while performing a snapshot | null | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.snapshot LockTimeoutMs* | 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 | 10000L | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.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" | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.snapshot SelectStatementOverrides* | 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. | null | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.source StructVersion* | A version of the format of the publicly visible source part in the message | "v2" | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.status UpdateIntervalMs* | Frequency in milliseconds for sending replication connection status updates to the server. Defaults to 10 seconds (10000 ms). | 10000 | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.table Blacklist* | Description is not available here, please check Debezium website for corresponding key 'table.blacklist' description. | null | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.table Whitelist* | The tables for which changes are to be captured | null | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.time PrecisionMode* | 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" | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.toasted ValuePlaceholder* | 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" | ConfigDef.Importance.MEDIUM |
| | * camel.source.endpoint.tombstones OnDelete* | 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 | ConfigDef.Importance.MEDIUM |
| | *camel.source.endpoint.xmin FetchIntervalMs* | 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. | 0L | ConfigDef.Importance.MEDIUM |
| | * camel.component.debezium-postgres.bridge ErrorHandler* | 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 | ConfigDef.Importance.MEDIUM |
| | * camel.component.debezium-postgres.configuration* | Allow pre-configured Configurations to be set. | null | ConfigDef.Importance.MEDIUM |
| | * camel.component.debezium-postgres.basic PropertyBinding* | Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities | false | ConfigDef.Importance.MEDIUM |
| |=== |
| // kafka-connector options: END |
