CouchDB

Consume changesets for inserts, updates and deletes in a CouchDB database, as well as get, save, update and delete documents from a CouchDB database.

Metadata

Property	Value
Scheme	`couchdb`
Support Level	Stable
Labels	database
Version	4.10.2

Maven Dependency

<dependency>
    <groupId>org.apache.camel</groupId>
    <artifactId>camel-couchdb</artifactId>
    <version>4.10.2</version>
</dependency>

Endpoint Properties

Name	Type	Required	Default	Description
`protocol`	string	✓		The protocol to use for communicating with the database.
`hostname`	string	✓		Hostname of the running couchdb instance
`port`	integer		`5984`	Port number for the running couchdb instance
`database`	string	✓		Name of the database to use
`createDatabase`	boolean		`false`	Creates the database if it does not already exist
`deletes`	boolean		`true`	Document deletes are published as events
`heartbeat`	duration		`30000`	How often to send an empty message to keep socket alive in millis
`maxMessagesPerPoll`	integer		`10`	Gets the maximum number of messages as a limit to poll at each polling. Gets the maximum number of messages as a limit to poll at each polling. The default value is 10. Use 0 or a negative number to set it as unlimited.
`style`	string		`main_only`	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`	boolean		`true`	Document inserts/updates are published as events
`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.
`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.
`password`	string			Password for authenticated databases
`username`	string			Username in case of authenticated databases