blob: d5ce6be05176d60fadfdbcff0dd8f3f6ed092d34 [file] [log] [blame]
// kafka-connector options: START
[[camel-couchdb-kafka-connector-sink]]
= camel-couchdb-kafka-connector sink configuration
When using camel-couchdb-kafka-connector as sink 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-couchdb-kafka-connector</artifactId>
<version>x.x.x</version>
<!-- use the same version as your Camel Kafka connector version -->
</dependency>
----
The camel-couchdb sink connector supports 12 options, which are listed below.
[width="100%",cols="2,5,^1,2",options="header"]
|===
| Name | Description | Default | Priority
| *camel.sink.path.protocol* | The protocol to use for communicating with the database. One of: [http] [https] | null | HIGH
| *camel.sink.path.hostname* | Hostname of the running couchdb instance | null | HIGH
| *camel.sink.path.port* | Port number for the running couchdb instance | 5984 | MEDIUM
| *camel.sink.path.database* | Name of the database to use | null | 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.basicPropertyBinding* | Whether the endpoint should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities | false | MEDIUM
| *camel.sink.endpoint.synchronous* | Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported). | false | MEDIUM
| *camel.sink.endpoint.password* | Password for authenticated databases | null | MEDIUM
| *camel.sink.endpoint.username* | Username in case of authenticated databases | null | 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.basicPropertyBinding* | Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities | false | MEDIUM
|===
// kafka-connector options: END