blob: 6ed7bf7685c6c038326591f52c60265f57e4ff92 [file] [log] [blame]
// kafka-connector options: START
[[camel-sql-stored-kafka-connector-sink]]
= camel-sql-stored-kafka-connector sink configuration
When using camel-sql-stored-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-sql-stored-kafka-connector</artifactId>
<version>x.x.x</version>
<!-- use the same version as your Camel Kafka connector version -->
</dependency>
----
The camel-sql-stored sink connector supports 13 options, which are listed below.
[width="100%",cols="2,5,^1,2",options="header"]
|===
| Name | Description | Default | Priority
| *camel.sink.path.template* | Sets the StoredProcedure template to perform | null | HIGH
| *camel.sink.endpoint.batch* | Enables or disables batch mode | false | MEDIUM
| *camel.sink.endpoint.dataSource* | Sets the DataSource to use to communicate with the database. | null | MEDIUM
| *camel.sink.endpoint.function* | Whether this call is for a function. | 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.noop* | If set, will ignore the results of the template and use the existing IN message as the OUT message for the continuation of processing | false | MEDIUM
| *camel.sink.endpoint.outputHeader* | Store the template result in a header instead of the message body. By default, outputHeader == null and the template result is stored in the message body, any existing content in the message body is discarded. If outputHeader is set, the value is used as the name of the header to store the template result and the original message body is preserved. | null | MEDIUM
| *camel.sink.endpoint.useMessageBodyForTemplate* | Whether to use the message body as the template and then headers for parameters. If this option is enabled then the template in the uri is not used. | 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.component.sql-stored.dataSource* | Sets the DataSource to use to communicate with the database. | null | MEDIUM
| *camel.component.sql-stored.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.sql-stored.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