| {"component":{"kind":"component","name":"couchdb","title":"CouchDB","description":"Consume changesets for inserts, updates and deletes in a CouchDB database, as well as get, save, update and delete documents from a CouchDB database.","deprecated":false,"firstVersion":"2.11.0","label":"database,nosql","javaType":"org.apache.camel.component.couchdb.CouchDbComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-couchdb","version":"3.18.1","scheme":"couchdb","extendsScheme":"","syntax":"couchdb:protocol:hostname:port/database","async":false,"api":false,"consumerOnly":false,"producerOnly":false,"lenientProperties":false},"headers":{"CouchDbDatabase":{"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The database the message came from","constantName":"org.apache.camel.component.couchdb.CouchDbConstants#HEADER_DATABASE"},"CouchDbSeq":{"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The couchdb changeset sequence number of the update / delete message","constantName":"org.apache.camel.component.couchdb.CouchDbConstants#HEADER_SEQ"},"CouchDbId":{"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The couchdb document id","constantName":"org.apache.camel.component.couchdb.CouchDbConstants#HEADER_DOC_ID"},"CouchDbRev":{"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The couchdb document revision","constantName":"org.apache.camel.component.couchdb.CouchDbConstants#HEADER_DOC_REV"},"CouchDbMethod":{"kind":"header","displayName":"","group":"common","label":"","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The method (delete / update)","constantName":"org.apache.camel.component.couchdb.CouchDbConstants#HEADER_METHOD"},"CamelCouchDbResumeAction":{"kind":"header","displayName":"","group":"consumer","label":"consumer","required":false,"javaType":"String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The resume action to execute when resuming.","constantName":"org.apache.camel.component.couchdb.CouchDbConstants#COUCHDB_RESUME_ACTION"}},"properties":{"protocol":{"kind":"path","displayName":"Protocol","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","enum":["http","https"],"deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The protocol to use for communicating with the database."},"hostname":{"kind":"path","displayName":"Hostname","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Hostname of the running couchdb instance"},"port":{"kind":"path","displayName":"Port","group":"common","label":"","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"defaultValue":5984,"description":"Port number for the running couchdb instance"},"database":{"kind":"path","displayName":"Database","group":"common","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"Name of the database to use"},"createDatabase":{"kind":"parameter","displayName":"Create Database","group":"common","label":"","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"Creates the database if it does not already exist"},"deletes":{"kind":"parameter","displayName":"Deletes","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Document deletes are published as events"},"heartbeat":{"kind":"parameter","displayName":"Heartbeat","group":"consumer","label":"consumer","required":false,"type":"duration","javaType":"long","deprecated":false,"autowired":false,"secret":false,"defaultValue":"30000","description":"How often to send an empty message to keep socket alive in millis"},"style":{"kind":"parameter","displayName":"Style","group":"consumer","label":"consumer","required":false,"type":"string","javaType":"java.lang.String","enum":["all_docs","main_only"],"deprecated":false,"autowired":false,"secret":false,"defaultValue":"main_only","description":"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":{"kind":"parameter","displayName":"Updates","group":"consumer","label":"consumer","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":true,"description":"Document inserts/updates are published as events"},"bridgeErrorHandler":{"kind":"parameter","displayName":"Bridge Error Handler","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"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."},"exceptionHandler":{"kind":"parameter","displayName":"Exception Handler","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.spi.ExceptionHandler","optionalPrefix":"consumer.","deprecated":false,"autowired":false,"secret":false,"description":"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":{"kind":"parameter","displayName":"Exchange Pattern","group":"consumer (advanced)","label":"consumer,advanced","required":false,"type":"object","javaType":"org.apache.camel.ExchangePattern","enum":["InOnly","InOut","InOptionalOut"],"deprecated":false,"autowired":false,"secret":false,"description":"Sets the exchange pattern when the consumer creates an exchange."},"lazyStartProducer":{"kind":"parameter","displayName":"Lazy Start Producer","group":"producer (advanced)","label":"producer,advanced","required":false,"type":"boolean","javaType":"boolean","deprecated":false,"autowired":false,"secret":false,"defaultValue":false,"description":"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":{"kind":"parameter","displayName":"Password","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"description":"Password for authenticated databases"},"username":{"kind":"parameter","displayName":"Username","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"description":"Username in case of authenticated databases"}}} |