camel.apache.org/mongodb-gridfs
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 mongodb-gridfs

gitea_admin 2026-03-11 14:41:20 +00:00
parent 2ec72eead0
commit b34958352b
1 changed files with 37 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

51
Home.md

@ -1,21 +1,44 @@
# Deploy the Project on CamelX Platform
# MongoDB GridFS
Deploy on CamelX Platform in three steps
Interact with MongoDB GridFS.
## 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 | `mongodb-gridfs` |
| Support Level | Stable |
| Labels | database,file |
| 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-mongodb-gridfs</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 |
|------|------|----------|---------|-------------|
| `connectionBean` | string | ✓ | | Name of com.mongodb.client.MongoClient to use. |
| `bucket` | string | | `fs` | Sets the name of the GridFS bucket within the database. Default is fs. |
| `database` | string | ✓ | | Sets the name of the MongoDB database to target |
| `readPreference` | object | | | Sets a MongoDB ReadPreference on the Mongo connection. Read preferences set directly on the connection will be overridden by this setting. The com.mongodb.ReadPreference#valueOf(String) utility method is used to resolve the passed readPreference value. Some examples for the possible values are nearest, primary or secondary etc. |
| `writeConcern` | object | | | Set the WriteConcern for write operations on MongoDB using the standard ones. Resolved from the fields of the WriteConcern class by calling the WriteConcern#valueOf(String) method. |
| `delay` | duration | | `500` | Sets the delay between polls within the Consumer. Default is 500ms |
| `fileAttributeName` | string | | `camel-processed` | If the QueryType uses a FileAttribute, this sets the name of the attribute that is used. Default is camel-processed. |
| `initialDelay` | duration | | `1000` | Sets the initialDelay before the consumer will start polling. Default is 1000ms |
| `persistentTSCollection` | string | | `camel-timestamps` | If the QueryType uses a persistent timestamp, this sets the name of the collection within the DB to store the timestamp. |
| `persistentTSObject` | string | | `camel-timestamp` | If the QueryType uses a persistent timestamp, this is the ID of the object in the collection to store the timestamp. |
| `query` | string | | | Additional query parameters (in JSON) that are used to configure the query used for finding files in the GridFsConsumer |
| `queryStrategy` | object | | `TimeStamp` | Sets the QueryStrategy that is used for polling for new files. Default is Timestamp |
| `bridgeErrorHandler` | boolean | | `false` | Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored. |
| `exceptionHandler` | object | | | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By default the consumer will deal with exceptions, that will be logged at WARN or ERROR level and ignored. |
| `exchangePattern` | object | | | Sets the exchange pattern when the consumer creates an exchange. |
| `operation` | string | | | Sets the operation this endpoint will execute against GridFs. |
| `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. |