blob: 7dc9781b5071a1d3c3499e2bfe47762c88a184da [file] [log] [blame]
// kafka-connector options: START
[[camel-ignite-cache-kafka-connector-source]]
= camel-ignite-cache-kafka-connector source configuration
When using camel-ignite-cache-kafka-connector as source make sure to use the following Maven dependency to have support for the connector:
[source,xml]
----
<dependency>
<groupId>org.apache.camel.kafkaconnector</groupId>
<artifactId>camel-ignite-cache-kafka-connector</artifactId>
<version>x.x.x</version>
<!-- use the same version as your Camel Kafka connector version -->
</dependency>
----
The camel-ignite-cache source connector supports 20 options, which are listed below.
[width="100%",cols="2,5,^1,2",options="header"]
|===
| Name | Description | Default | Priority
| *camel.source.path.cacheName* | The cache name. | null | ConfigDef.Importance.HIGH
| * camel.source.endpoint.propagate IncomingBodyIfNoReturnValue* | Sets whether to propagate the incoming body if the return type of the underlying Ignite operation is void. | true | ConfigDef.Importance.MEDIUM
| *camel.source.endpoint.treat CollectionsAsCacheObjects* | Sets whether to treat Collections as cache objects or as Collections of items to insert/update/compute, etc. | false | ConfigDef.Importance.MEDIUM
| *camel.source.endpoint.auto Unsubscribe* | Whether auto unsubscribe is enabled in the Continuous Query Consumer. Default value notice: ContinuousQuery.DFLT_AUTO_UNSUBSCRIBE | true | ConfigDef.Importance.MEDIUM
| *camel.source.endpoint.bridge ErrorHandler* | Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. 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. | false | ConfigDef.Importance.MEDIUM
| *camel.source.endpoint.fire ExistingQueryResults* | Whether to process existing results that match the query. Used on initialization of the Continuous Query Consumer. | false | ConfigDef.Importance.MEDIUM
| *camel.source.endpoint.one ExchangePerUpdate* | 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. | true | ConfigDef.Importance.MEDIUM
| *camel.source.endpoint.pageSize* | The page size. Only used by the Continuous Query Consumer. Default value notice: ContinuousQuery.DFLT_PAGE_SIZE | 1 | ConfigDef.Importance.MEDIUM
| *camel.source.endpoint.query* | The Query to execute, only needed for operations that require it, and for the Continuous Query Consumer. | null | ConfigDef.Importance.MEDIUM
| *camel.source.endpoint.remote Filter* | The remote filter, only used by the Continuous Query Consumer. | null | ConfigDef.Importance.MEDIUM
| *camel.source.endpoint.time Interval* | The time interval for the Continuous Query Consumer. Default value notice: ContinuousQuery.DFLT_TIME_INTERVAL | 0L | ConfigDef.Importance.MEDIUM
| * camel.source.endpoint.exception Handler* | 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. | null | ConfigDef.Importance.MEDIUM
| *camel.source.endpoint.exchange Pattern* | Sets the exchange pattern when the consumer creates an exchange. One of: [InOnly] [InOut] [InOptionalOut] | null | ConfigDef.Importance.MEDIUM
| *camel.source.endpoint.basic PropertyBinding* | Whether the endpoint should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities | false | ConfigDef.Importance.MEDIUM
| * camel.source.endpoint.synchronous* | Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported). | false | ConfigDef.Importance.MEDIUM
| * camel.component.ignite-cache.configuration Resource* | Resource from where to load configuration. | null | ConfigDef.Importance.MEDIUM
| * camel.component.ignite-cache.ignite* | Ignite instance. | null | ConfigDef.Importance.MEDIUM
| * camel.component.ignite-cache.ignite Configuration* | Ignite configuration. | null | ConfigDef.Importance.MEDIUM
| * camel.component.ignite-cache.bridge ErrorHandler* | Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. 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. | false | ConfigDef.Importance.MEDIUM
| * camel.component.ignite-cache.basic PropertyBinding* | Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities | false | ConfigDef.Importance.MEDIUM
|===
// kafka-connector options: END