Automatic docs generation for CouchDB component
Project: http://git-wip-us.apache.org/repos/asf/camel/repo Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/90ece0cc Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/90ece0cc Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/90ece0cc Branch: refs/heads/master Commit: 90ece0cce9ea63b99c228caca60841ab60dd63ad Parents: a13f062 Author: Andrea Cosentino <anco...@gmail.com> Authored: Wed Aug 24 13:27:53 2016 +0200 Committer: Andrea Cosentino <anco...@gmail.com> Committed: Wed Aug 24 13:27:53 2016 +0200 ---------------------------------------------------------------------- .../src/main/docs/couchdb-component.adoc | 39 +++++++++++++------- components/readme.adoc | 3 ++ docs/user-manual/en/SUMMARY.md | 1 + 3 files changed, 30 insertions(+), 13 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/camel/blob/90ece0cc/components/camel-couchdb/src/main/docs/couchdb-component.adoc ---------------------------------------------------------------------- diff --git a/components/camel-couchdb/src/main/docs/couchdb-component.adoc b/components/camel-couchdb/src/main/docs/couchdb-component.adoc index 080f501..53e43a0 100644 --- a/components/camel-couchdb/src/main/docs/couchdb-component.adoc +++ b/components/camel-couchdb/src/main/docs/couchdb-component.adoc @@ -49,22 +49,35 @@ is optional and if not specified then defaults to 5984. Options ^^^^^^^ -[width="100%",cols="10%,10%,80%",options="header",] -|======================================================================= -|Property |Default |Description - -|`deletes` |`true` |document deletes are published as events - -|`updates` |`true` |document inserts/updates are published as events +// component options: START +The CouchDB component has no options. +// component options: END -|`heartbeat` |`30000` |how often to send an empty message to keep socket alive in millis +// endpoint options: START +The CouchDB component supports 15 endpoint options which are listed below: -|`createDatabase` |`true` |create the database if it does not already exist - -|`username` |`null` |username in case of authenticated databases - -|`password` |`null` |password for authenticated databases +{% raw %} +[width="100%",cols="2,1,1m,1m,5",options="header"] +|======================================================================= +| Name | Group | Default | Java Type | Description +| protocol | common | | String | *Required* The protocol to use for communicating with the database. +| hostname | common | | String | *Required* Hostname of the running couchdb instance +| port | common | 5984 | int | Port number for the running couchdb instance +| database | common | | String | *Required* Name of the database to use +| createDatabase | common | false | boolean | Creates the database if it does not already exist +| deletes | common | true | boolean | Document deletes are published as events +| heartbeat | common | 30000 | long | How often to send an empty message to keep socket alive in millis +| password | common | | String | Password for authenticated databases +| style | common | main_only | String | Specifies how many revisions are returned in the changes array. The default main_only will only return the current winning revision; all_docs will return all leaf revisions (including conflicts and deleted former conflicts.) +| updates | common | true | boolean | Document inserts/updates are published as events +| username | common | | String | Username in case of authenticated databases +| bridgeErrorHandler | consumer | false | boolean | 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/ERROR level and ignored. +| exceptionHandler | consumer (advanced) | | ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions that will be logged at WARN/ERROR level and ignored. +| exchangePattern | advanced | InOnly | ExchangePattern | Sets the default exchange pattern when creating an exchange +| synchronous | advanced | false | boolean | Sets whether synchronous processing should be strictly used or Camel is allowed to use asynchronous processing (if supported). |======================================================================= +{% endraw %} +// endpoint options: END [[CouchDB-Headers]] Headers http://git-wip-us.apache.org/repos/asf/camel/blob/90ece0cc/components/readme.adoc ---------------------------------------------------------------------- diff --git a/components/readme.adoc b/components/readme.adoc index 9f44564..6b5ec75 100644 --- a/components/readme.adoc +++ b/components/readme.adoc @@ -108,6 +108,9 @@ Components | link:camel-consul/src/main/docs/consul-component.adoc[Consul] (camel-consul) + `consul://apiEndpoint` | Camel Consul support +| link:camel-couchdb/src/main/docs/couchdb-component.adoc[CouchDB] (camel-couchdb) + +`couchdb:protocol:hostname:port/database` | The couchdb component is used for integrate with CouchDB databases. + | link:camel-crypto/src/main/docs/crypto-component.adoc[Crypto (JCE)] (camel-crypto) + `crypto:cryptoOperation:name` | The crypto component is used for signing and verifying exchanges using the Signature Service of the Java Cryptographic Extension (JCE). http://git-wip-us.apache.org/repos/asf/camel/blob/90ece0cc/docs/user-manual/en/SUMMARY.md ---------------------------------------------------------------------- diff --git a/docs/user-manual/en/SUMMARY.md b/docs/user-manual/en/SUMMARY.md index 29ff1db..b3eda45 100644 --- a/docs/user-manual/en/SUMMARY.md +++ b/docs/user-manual/en/SUMMARY.md @@ -158,6 +158,7 @@ * [CoAP](coap-component.adoc) * [CometD](cometd-component.adoc) * [Consul](consul-component.adoc) + * [CouchDB](couchdb-component.adoc) * [Crypto (JCE)](crypto-component.adoc) * [CXF](cxf-component.adoc) * [CXF-RS](cxfrs-component.adoc)
