Update wiki Home page for lucene

gitea_admin 2026-03-11 14:41:08 +00:00
parent dbde097a82
commit 1b1f8d6f1f

41
Home.md

@ -1,21 +1,34 @@
# Deploy the Project on CamelX Platform
# Lucene
Deploy on CamelX Platform in three steps
Perform inserts or queries against Apache Lucene databases.
## Step 1: Create a release
From the project space, click on **"Create a release"**
## Metadata
The new version is automatically available in the list
| Property | Value |
|----------|-------|
| Scheme | `lucene` |
| Support Level | Stable |
| Labels | database,search |
| Version | 4.10.2 |
## Step 2: Deploy
Click on **"Deploy"**
## Maven Dependency
- **Version:** Select the desired release
- **Environment:** Choose `Development`, `Staging`, or `Production`
- **Configuration:** Select the configuration source
- **Resources:** Set CPU and Memory
```xml
<dependency>
<groupId>org.apache.camel</groupId>
<artifactId>camel-lucene</artifactId>
<version>4.10.2</version>
</dependency>
```
## Step 3: Expose
Enable **"Expose"**
## Endpoint Properties
Choose an **API Gateway** (Internal, Public, etc.)
| Name | Type | Required | Default | Description |
|------|------|----------|---------|-------------|
| `host` | string | ✓ | | The URL to the lucene server |
| `operation` | object | ✓ | | Operation to do such as insert or query. |
| `analyzer` | object | | | 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 |
| `indexDir` | string | | | A file system directory in which index files are created upon analysis of the document by the specified analyzer |
| `maxHits` | integer | | | An integer value that limits the result set of the search operation |
| `srcDir` | string | | | An optional directory containing files to be used to be analyzed and added to the index at producer startup. |
| `lazyStartProducer` | boolean | | `false` | 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. |