blob: e295d378b96e77c9b889669069c2dd489d7de4cc [file] [log] [blame]
// kafka-connector options: START
[[camel-nitrite-kafka-connector-sink]]
= camel-nitrite-kafka-connector sink configuration
When using camel-nitrite-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-nitrite-kafka-connector</artifactId>
<version>x.x.x</version>
<!-- use the same version as your Camel Kafka connector version -->
</dependency>
----
The camel-nitrite sink connector supports 11 options, which are listed below.
[width="100%",cols="2,5,^1,2",options="header"]
|===
| Name | Description | Default | Priority
| *camel.sink.path.database* | Path to database file. Will be created if not exists. | null | HIGH
| *camel.sink.endpoint.collection* | Name of Nitrite collection. Cannot be used in combination with repositoryClass option. | null | MEDIUM
| *camel.sink.endpoint.repositoryClass* | Class of Nitrite ObjectRepository. Cannot be used in combination with collection option. | null | MEDIUM
| *camel.sink.endpoint.repositoryName* | Optional name of ObjectRepository. Can be only used in combination with repositoryClass, otherwise have no effect | null | 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 Nitrite database. Required, if option username specified. | null | MEDIUM
| *camel.sink.endpoint.username* | Username for Nitrite database. Database is not secured if option not specified. | null | MEDIUM
| *camel.component.nitrite.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.nitrite.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