camel.apache.org/arangodb
1
0
Fork 0
generated from camel.apache.org/component
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update wiki Home page for arangodb

gitea_admin 2026-03-11 14:35:00 +00:00
parent ebf14ae6b4
commit 798114c609
1 changed files with 33 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

47
Home.md

@ -1,21 +1,40 @@
# Deploy the Project on CamelX Platform
# ArangoDb
Deploy on CamelX Platform in three steps
Perform operations on ArangoDb when used as a Document Database, or as a 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 | `arangodb` |
| Support Level | Stable |
| Labels | database |
| 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-arangodb</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 |
|------|------|----------|---------|-------------|
| `database` | string | ✓ | | database name |
| `documentCollection` | string | | | Collection name, when using ArangoDb as a Document Database. Set the documentCollection name when using the CRUD operation on the document database collections (SAVE_DOCUMENT , FIND_DOCUMENT_BY_KEY, UPDATE_DOCUMENT, DELETE_DOCUMENT). |
| `edgeCollection` | string | | | Collection name of vertices, when using ArangoDb as a Graph Database. Set the edgeCollection name to perform CRUD operation on edges using these operations : SAVE_VERTEX, FIND_VERTEX_BY_KEY, UPDATE_VERTEX, DELETE_VERTEX. The graph attribute is mandatory. |
| `graph` | string | | | Graph name, when using ArangoDb as a Graph Database. Combine this attribute with one of the two attributes vertexCollection and edgeCollection. |
| `host` | string | | | ArangoDB host. If host and port are default, this field is Optional. |
| `operation` | object | | | Operations to perform on ArangoDb. For the operation AQL_QUERY, no need to specify a collection or graph. |
| `port` | integer | | | ArangoDB exposed port. If host and port are default, this field is Optional. |
| `vertexCollection` | string | | | Collection name of vertices, when using ArangoDb as a Graph Database. Set the vertexCollection name to perform CRUD operation on vertices using these operations : SAVE_EDGE, FIND_EDGE_BY_KEY, UPDATE_EDGE, DELETE_EDGE. The graph attribute is mandatory. |
| `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. |
| `arangoDB` | object | | | To use an existing ArangDB client. |
| `vertx` | object | | | To use an existing Vertx instance in the ArangoDB client. |
| `password` | string | | | ArangoDB password. If user and password are default, this field is Optional. |
| `user` | string | | | ArangoDB user. If user and password are default, this field is Optional. |