camel-lucene-kafka-connector sink configuration

When using camel-lucene-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-lucene-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.lucene.CamelLuceneSinkConnector

The camel-lucene sink connector supports 16 options, which are listed below.

Name	Description	Default	Required	Priority
camel.sink.path.host	The URL to the lucene server	null	true	HIGH
camel.sink.path.operation	Operation to do such as insert or query. One of: [insert] [query]	null	true	HIGH
camel.sink.endpoint.analyzer	An Analyzer builds TokenStreams, which analyze text. It thus represents a policy for extracting index terms from text. The value for analyzer can be any class that extends the abstract class org.apache.lucene.analysis.Analyzer. Lucene also offers a rich set of analyzers out of the box	null	false	MEDIUM
camel.sink.endpoint.indexDir	A file system directory in which index files are created upon analysis of the document by the specified analyzer	null	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	false	MEDIUM
camel.sink.endpoint.maxHits	An integer value that limits the result set of the search operation	null	false	MEDIUM
camel.sink.endpoint.srcDir	An optional directory containing files to be used to be analyzed and added to the index at producer startup.	null	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	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	false	MEDIUM
camel.component.lucene.analyzer	An Analyzer builds TokenStreams, which analyze text. It thus represents a policy for extracting index terms from text. The value for analyzer can be any class that extends the abstract class org.apache.lucene.analysis.Analyzer. Lucene also offers a rich set of analyzers out of the box	null	false	MEDIUM
camel.component.lucene.indexDir	A file system directory in which index files are created upon analysis of the document by the specified analyzer	null	false	MEDIUM
camel.component.lucene.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	false	MEDIUM
camel.component.lucene.maxHits	An integer value that limits the result set of the search operation	null	false	MEDIUM
camel.component.lucene.srcDir	An optional directory containing files to be used to be analyzed and added to the index at producer startup.	null	false	MEDIUM
camel.component.lucene.basicPropertyBinding	Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities	false	false	LOW
camel.component.lucene.config	To use a shared lucene configuration	null	false	MEDIUM

Name

Description

Default

Required

Priority

camel.sink.path.host

The URL to the lucene server

null

true

HIGH

camel.sink.path.operation

Operation to do such as insert or query. One of: [insert] [query]

null

true

HIGH

camel.sink.endpoint.analyzer

An Analyzer builds TokenStreams, which analyze text. It thus represents a policy for extracting index terms from text. The value for analyzer can be any class that extends the abstract class org.apache.lucene.analysis.Analyzer. Lucene also offers a rich set of analyzers out of the box

null

false

MEDIUM

camel.sink.endpoint.indexDir

A file system directory in which index files are created upon analysis of the document by the specified analyzer

null

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.maxHits

An integer value that limits the result set of the search operation

null

false

MEDIUM

camel.sink.endpoint.srcDir

An optional directory containing files to be used to be analyzed and added to the index at producer startup.

null

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.lucene.analyzer

null

false

MEDIUM

camel.component.lucene.indexDir

A file system directory in which index files are created upon analysis of the document by the specified analyzer

null

false

MEDIUM

camel.component.lucene.lazyStartProducer

false

MEDIUM

camel.component.lucene.maxHits

An integer value that limits the result set of the search operation

null

false

MEDIUM

camel.component.lucene.srcDir

An optional directory containing files to be used to be analyzed and added to the index at producer startup.

null

false

MEDIUM

camel.component.lucene.basicPropertyBinding

Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities

false

LOW

camel.component.lucene.config

To use a shared lucene configuration

null

false

MEDIUM

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

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

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