diff --git a/Home.md b/Home.md index 93a012c..6c9ea8f 100644 --- a/Home.md +++ b/Home.md @@ -1,21 +1,44 @@ -# Deploy the Project on CamelX Platform +# Ignite Cache -Deploy on CamelX Platform in three steps +Perform cache operations on an Ignite cache or consume changes from a continuous query. -## 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 | `ignite-cache` | +| Support Level | Stable | +| Labels | cache,clustering | +| 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 + + org.apache.camel + camel-ignite + 4.10.2 + +``` -## Step 3: Expose -Enable **"Expose"** +## Endpoint Properties -Choose an **API Gateway** (Internal, Public, etc.) +| Name | Type | Required | Default | Description | +|------|------|----------|---------|-------------| +| `cacheName` | string | ✓ | | The cache name. | +| `propagateIncomingBodyIfNoReturnValue` | boolean | | `true` | Sets whether to propagate the incoming body if the return type of the underlying Ignite operation is void. | +| `treatCollectionsAsCacheObjects` | boolean | | `false` | Sets whether to treat Collections as cache objects or as Collections of items to insert/update/compute, etc. | +| `autoUnsubscribe` | boolean | | `true` | Whether auto unsubscribe is enabled in the Continuous Query Consumer. Default value notice: ContinuousQuery.DFLT_AUTO_UNSUBSCRIBE | +| `fireExistingQueryResults` | boolean | | `false` | Whether to process existing results that match the query. Used on initialization of the Continuous Query Consumer. | +| `oneExchangePerUpdate` | boolean | | `true` | Whether to pack each update in an individual Exchange, even if multiple updates are received in one batch. Only used by the Continuous Query Consumer. | +| `pageSize` | integer | | `1` | The page size. Only used by the Continuous Query Consumer. Default value notice: ContinuousQuery.DFLT_PAGE_SIZE | +| `query` | object | | | The Query to execute, only needed for operations that require it, and for the Continuous Query Consumer. | +| `remoteFilter` | object | | | The remote filter, only used by the Continuous Query Consumer. | +| `timeInterval` | integer | | `0` | The time interval for the Continuous Query Consumer. Default value notice: ContinuousQuery.DFLT_TIME_INTERVAL | +| `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. | +| `cachePeekMode` | object | | `ALL` | The CachePeekMode, only needed for operations that require it (IgniteCacheOperation#SIZE). | +| `failIfInexistentCache` | boolean | | `false` | Whether to fail the initialization if the cache doesn't exist. | +| `operation` | object | | | The cache operation to invoke. Possible values: GET, PUT, REMOVE, SIZE, REBALANCE, QUERY, CLEAR. | +| `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. |