Page History

h2. Camel CouchDB component

*Available as of Camel 2.11*

The *couchdb:* component is used for communicating with [CouchDB|http://couchdb.apache.org/] databases.

Maven users will need to add the following dependency to their {{pom.xml}} for this component:

{code:xml}
<dependency>
    <groupId>org.apache.camel</groupId>
    <artifactId>camel-couchdb</artifactId>
    <version>x.x.x</version>
    <!-- use the same version as your Camel core version -->
</dependency>
{code}

h3. URI format

{code}
couchdb:http://hostname[:port]/database?[options...]://name[?options]
{code}

Where *hostname* is the hostname of the running couchdb instance. Port is optional and if not specified then defaults to 5984.

h3. Options
{div:class=confluenceTableSmall}
|| Property || Default || Description ||
| {{deletes }} | {{true}} | document deletes are published as events |
| {{updates }} | {{true}} | document inserts/updates are published as events |
| {{document heartbeat}} | 30000 | how often to send an empty message to keep socket alive in millis |
| {{document createDatabase}} | | |
{{true} | {{document }} | | |
| {{document }} | |create the database if it does not already exist |
| {{document username}} | | |
| {{document }} | |username in case of authenticated databases |
| {{document password}} | | password for authenticated databases |
{div}