camel-couchdb-kafka-connector sink configuration

Connector Description: Consume changesets for inserts, updates and deletes in a CouchDB database, as well as get, save, update and delete documents from a CouchDB database.

When using camel-couchdb-kafka-connector as sink make sure to use the following Maven dependency to have support for the connector:

<dependency>
  <groupId>org.apache.camel.kafkaconnector</groupId>
  <artifactId>camel-couchdb-kafka-connector</artifactId>
  <version>x.x.x</version>
  <!-- use the same version as your Camel Kafka connector version -->
</dependency>

To use this sink connector in Kafka connect you’ll need to set the following connector.class

connector.class=org.apache.camel.kafkaconnector.couchdb.CamelCouchdbSinkConnector

The camel-couchdb sink connector supports 10 options, which are listed below.

Name Description Default Priority

camel.sink.path.protocol

Required The protocol to use for communicating with the database. One of: [http] [https].

Enum values:

  • http

  • https

HIGH

camel.sink.path.hostname

Required Hostname of the running couchdb instance.

HIGH

camel.sink.path.port

Port number for the running couchdb instance.

5984

MEDIUM

camel.sink.path.database

Required Name of the database to use.

HIGH

camel.sink.endpoint.createDatabase

Creates the database if it does not already exist.

false

MEDIUM

camel.sink.endpoint.lazyStartProducer

Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel’s routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing.

false

MEDIUM

camel.sink.endpoint.password

Password for authenticated databases.

MEDIUM

camel.sink.endpoint.username

Username in case of authenticated databases.

MEDIUM

camel.component.couchdb.lazyStartProducer

Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel’s routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing.

false

MEDIUM

camel.component.couchdb.autowiredEnabled

Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc.

true

MEDIUM

The camel-couchdb sink connector has no converters out of the box.

The camel-couchdb sink connector has no transforms out of the box.

The camel-couchdb sink connector has no aggregation strategies out of the box.

Back to top