camel-apache-org/couchbase
camel-apache-org/couchbase
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 1 Wiki Activity

Update wiki Home page for couchbase

gitea_admin 2026-10-12 05:36:03 +00:00
parent c8b95c05e6
commit d5c29f2cff
1 changed files with 72 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

86
Home.md

@ -1,21 +1,79 @@
# Deploy the Project on CamelX Platform # Couchbase
Deploy on CamelX Platform in three steps Query Couchbase databases using SQL (N1QL) queries or MapReduce Views with a poll strategy and/or perform various operations against Couchbase databases.
## Step 1: Create a release ## Metadata
From the project space, click on **"Create a release"**
The new version is automatically available in the list | Property | Value |
|----------|-------|
| Scheme | `couchbase` |
| Support Level | Preview |
| Labels | database |
| Version | 4.20.0 (CEQ 3.36.0) |
## Step 2: Deploy ## Maven Dependency
Click on **"Deploy"**
- **Version:** Select the desired release ```xml
- **Environment:** Choose `Development`, `Staging`, or `Production` <dependency>
- **Configuration:** Select the configuration source <groupId>org.apache.camel.quarkus</groupId>
- **Resources:** Set CPU and Memory <artifactId>camel-quarkus-couchbase</artifactId>
<version>4.20.0 (CEQ 3.36.0)</version>
</dependency>
```
## Step 3: Expose ## Endpoint Properties
Enable **"Expose"**
Choose an **API Gateway** (Internal, Public, etc.) | Name | Type | Required | Default | Description |
|------|------|----------|---------|-------------|
| `protocol` | string | ✓ | | The protocol to use |
| `hostname` | string | ✓ | | The hostname to use |
| `port` | integer | | `8091` | The port number to use |
| `bucket` | string | ✓ | | The bucket to use |
| `collection` | string | | | The collection to use |
| `key` | string | | | The key to use |
| `scope` | string | | | The scope to use |
| `consumerProcessedStrategy` | string | | `none` | Define the consumer Processed strategy to use |
| `consumerRetryPause` | integer | | `5000` | Define the consumer retry pause between different attempts |
| `descending` | boolean | | `false` | Define if this operation is descending or not |
| `designDocumentName` | string | | `beer` | The design document name to use. Deprecated: use the statement option with SQL queries instead. |
| `fullDocument` | boolean | | `false` | If true consumer will return complete document instead data defined in view |
| `limit` | integer | | `-1` | The output limit to use |
| `rangeEndKey` | string | | | Define a range for the end key |
| `rangeStartKey` | string | | | Define a range for the start key |
| `sendEmptyMessageWhenIdle` | boolean | | `false` | If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead. |
| `skip` | integer | | `-1` | Define the skip to use |
| `statement` | string | | | A SQL (N1QL) query statement for consuming documents. When set, the consumer uses SQL queries instead of MapReduce views. The query should select META().id AS __id to identify documents. Example: SELECT META().id AS __id, FROM myCollection WHERE type = 'order' LIMIT 100. If not set and useView is false, a SQL query is auto-generated from the bucket, scope, collection, limit, skip, descending, rangeStartKey, and rangeEndKey options. |
| `useView` | boolean | | `false` | If true, use the deprecated MapReduce Views to query documents via designDocumentName and viewName. If false (default), use SQL queries instead. |
| `viewName` | string | | `brewery_beers` | The view name to use. Deprecated: use the statement option with SQL queries instead. |
| `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` | enum | | | Sets the exchange pattern when the consumer creates an exchange. |
| `pollStrategy` | object | | | A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel. |
| `autoStartIdForInserts` | boolean | | `false` | Define if we want an autostart Id when we are doing an insert operation |
| `operation` | string | | `CCB_PUT` | The operation to do |
| `persistTo` | integer | | `0` | Where to persist the data |
| `producerRetryAttempts` | integer | | `2` | Define the number of retry attempts |
| `producerRetryPause` | integer | | `5000` | Define the producer retry pause between different attempts |
| `replicateTo` | integer | | `0` | Where to replicate the data |
| `startingIdForInsertsFrom` | integer | | | Define the starting Id where we are doing an insert operation |
| `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. |
| `additionalHosts` | string | | | The additional hosts |
| `connectionString` | string | | | The Couchbase SDK connection string to use (e.g., couchbase://hostname:11210). When set, this takes precedence over the hostname and port options for the SDK connection. This is useful when the KV port is not the default 11210, for example when connecting to a container with dynamic port mappings. |
| `connectTimeout` | duration | | `30000` | Define the timeoutconnect in milliseconds |
| `queryTimeout` | duration | | `2500` | Define the operation timeout in milliseconds |
| `backoffErrorThreshold` | integer | | | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. |
| `backoffIdleThreshold` | integer | | | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. |
| `backoffMultiplier` | integer | | | To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. |
| `delay` | integer | | `500` | Milliseconds before the next poll. |
| `greedy` | boolean | | `false` | If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages. |
| `initialDelay` | integer | | `1000` | Milliseconds before the first poll starts. |
| `repeatCount` | integer | | `0` | Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever. |
| `runLoggingLevel` | enum | | `TRACE` | The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. |
| `scheduledExecutorService` | object | | | Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. |
| `scheduler` | object | | `none` | To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler |
| `schedulerProperties` | object | | | To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler. This is a multi-value option with prefix: scheduler. |
| `startScheduler` | boolean | | `true` | Whether the scheduler should be auto started. |
| `timeUnit` | enum | | `MILLISECONDS` | Time unit for initialDelay and delay options. |
| `useFixedDelay` | boolean | | `true` | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. |
| `password` | string | | | The password to use |
| `username` | string | | | The username to use |