Update wiki Home page for neo4j

gitea_admin 2026-03-11 14:41:26 +00:00
parent fdabfa4555
commit 121dd35e0d

52
Home.md

@ -1,21 +1,45 @@
# Deploy the Project on CamelX Platform
# Neo4j
Deploy on CamelX Platform in three steps
Perform operations on the Neo4j Graph Database
## 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 | `neo4j` |
| Support Level | Preview |
| Labels | database,ai |
| 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-neo4j</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 |
|------|------|----------|---------|-------------|
| `name` | string | ✓ | | The database name |
| `alias` | string | | | Node alias |
| `databaseUrl` | string | | | Url for connecting to Neo database |
| `detachRelationship` | boolean | | `false` | Detach a relationship - set true if want to delete a node and detach its relationships to other nodes at same time |
| `dimension` | integer | | | Dimension of Vector Index |
| `label` | string | | | Node Label |
| `maxResults` | integer | | `3` | Maximum results for Vector Similarity search |
| `minScore` | number | | `0` | Minimum score for Vector Similarity search |
| `query` | string | | | Cypher Query |
| `similarityFunction` | object | | `cosine` | Similarity Function of Vector Index |
| `vectorIndexName` | string | | | Vector Index Name |
| `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. |
| `driver` | object | | | Advanced - Driver |
| `kerberosAuthTicket` | string | | | Kerberos Authentication encoded base64 ticket |
| `password` | string | | | Basic authentication database password |
| `realm` | string | | | Basic authentication database realm |
| `token` | string | | | Bearer authentication database realm |
| `username` | string | | | Basic authentication database user |