// spring-boot-auto-configure options: START
:page-partial:
:doctitle: Camel Spring Boot Starter for lucene

== Spring Boot Auto-Configuration

When using lucene with Spring Boot make sure to use the following Maven dependency to have support for auto configuration:

[source,xml]
----
<dependency>
  <groupId>org.apache.camel.springboot</groupId>
  <artifactId>camel-lucene-starter</artifactId>
  <version>x.x.x</version>
  <!-- use the same version as your Camel core version -->
</dependency>
----


The component supports 8 options, which are listed below.



[width="100%",cols="2,5,^1,2",options="header"]
|===
| Name | Description | Default | Type
| *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. The option is a org.apache.lucene.analysis.Analyzer type. |  | Analyzer
| *camel.component.lucene.config* | To use a shared lucene configuration. The option is a org.apache.camel.component.lucene.LuceneConfiguration type. |  | LuceneConfiguration
| *camel.component.lucene.enabled* | Whether to enable auto configuration of the lucene component. This is enabled by default. |  | Boolean
| *camel.component.lucene.index-dir* | A file system directory in which index files are created upon analysis of the document by the specified analyzer |  | File
| *camel.component.lucene.lazy-start-producer* | 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 | Boolean
| *camel.component.lucene.max-hits* | An integer value that limits the result set of the search operation |  | Integer
| *camel.component.lucene.src-dir* | An optional directory containing files to be used to be analyzed and added to the index at producer startup. |  | File
| *camel.component.lucene.basic-property-binding* | *Deprecated* Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities | false | Boolean
|===
// spring-boot-auto-configure options: END
