| {"component":{"kind":"component","name":"arangodb","title":"ArangoDb","description":"Perform operations on ArangoDb when used as a Document Database, or as a Graph Database","deprecated":false,"firstVersion":"3.5.0","label":"database,nosql","javaType":"org.apache.camel.component.arangodb.ArangoDbComponent","supportLevel":"Stable","groupId":"org.apache.camel","artifactId":"camel-arangodb","version":"3.18.1","scheme":"arangodb","extendsScheme":"","syntax":"arangodb:database","async":false,"api":false,"consumerOnly":false,"producerOnly":true,"lenientProperties":false},"headers":{"CamelArangoDbMultiUpdate":{"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"java.lang.Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":"false","description":"Indicates if there are multiple documents to update. If set to true, the body of the message must be a Collection of documents to update.","constantName":"org.apache.camel.component.arangodb.ArangoDbConstants#MULTI_UPDATE"},"CamelArangoDbMultiInsert":{"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"java.lang.Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":"false","description":"Indicates if there are multiple documents to insert. If set to true, the body of the message must be a Collection of documents to insert.","constantName":"org.apache.camel.component.arangodb.ArangoDbConstants#MULTI_INSERT"},"CamelArangoDbMultiDelete":{"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"java.lang.Boolean","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":"false","description":"Indicates if there are multiple documents to delete. If set to true, the body of the message must be a Collection of key of documents to delete.","constantName":"org.apache.camel.component.arangodb.ArangoDbConstants#MULTI_DELETE"},"key":{"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The Arango key to use for the operation.","constantName":"org.apache.camel.component.arangodb.ArangoDbConstants#ARANGO_KEY"},"ResultClassType":{"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"java.lang.Class","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"defaultValue":"BaseDocument.class or BaseEdgeDocument.class","description":"The type of the result of the operation.","constantName":"org.apache.camel.component.arangodb.ArangoDbConstants#RESULT_CLASS_TYPE"},"CamelArangoDbAqlQuery":{"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The AQL query to execute.","constantName":"org.apache.camel.component.arangodb.ArangoDbConstants#AQL_QUERY"},"CamelArangoDbAqlParameters":{"kind":"header","displayName":"","group":"producer","label":"","required":false,"javaType":"java.util.Map","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The key/value pairs defining the variables to bind the query to.","constantName":"org.apache.camel.component.arangodb.ArangoDbConstants#AQL_QUERY_BIND_PARAMETERS"},"CamelArangoDbAqlOptions":{"kind":"header","displayName":"","group":"advanced","label":"advanced","required":false,"javaType":"com.arangodb.model.AqlQueryOptions","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"The additional options that will be passed to the query API.","constantName":"org.apache.camel.component.arangodb.ArangoDbConstants#AQL_QUERY_OPTIONS"}},"properties":{"database":{"kind":"path","displayName":"Database","group":"producer","label":"","required":true,"type":"string","javaType":"java.lang.String","deprecated":false,"deprecationNote":"","autowired":false,"secret":false,"description":"database name"},"documentCollection":{"kind":"parameter","displayName":"Document Collection","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.arangodb.ArangoDbConfiguration","configurationField":"configuration","description":"Collection name, when using ArangoDb as a Document Database. Set the documentCollection name when using the CRUD operation on the document database collections (SAVE_DOCUMENT , FIND_DOCUMENT_BY_KEY, UPDATE_DOCUMENT, DELETE_DOCUMENT)."},"edgeCollection":{"kind":"parameter","displayName":"Edge Collection","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.arangodb.ArangoDbConfiguration","configurationField":"configuration","description":"Collection name of vertices, when using ArangoDb as a Graph Database. Set the edgeCollection name to perform CRUD operation on edges using these operations : SAVE_VERTEX, FIND_VERTEX_BY_KEY, UPDATE_VERTEX, DELETE_VERTEX. The graph attribute is mandatory."},"graph":{"kind":"parameter","displayName":"Graph","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.arangodb.ArangoDbConfiguration","configurationField":"configuration","description":"Graph name, when using ArangoDb as a Graph Database. Combine this attribute with one of the two attributes vertexCollection and edgeCollection."},"host":{"kind":"parameter","displayName":"Host","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.arangodb.ArangoDbConfiguration","configurationField":"configuration","description":"ArangoDB host. If host and port are default, this field is Optional."},"operation":{"kind":"parameter","displayName":"Operation","group":"producer","label":"producer","required":false,"type":"object","javaType":"org.apache.camel.component.arangodb.ArangoDbOperation","enum":["SAVE_DOCUMENT","FIND_DOCUMENT_BY_KEY","UPDATE_DOCUMENT","DELETE_DOCUMENT","AQL_QUERY","SAVE_VERTEX","FIND_VERTEX_BY_KEY","UPDATE_VERTEX","DELETE_VERTEX","SAVE_EDGE","FIND_EDGE_BY_KEY","UPDATE_EDGE","DELETE_EDGE"],"deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.arangodb.ArangoDbConfiguration","configurationField":"configuration","description":"Operations to perform on ArangoDb. For the operation AQL_QUERY, no need to specify a collection or graph."},"port":{"kind":"parameter","displayName":"Port","group":"producer","label":"producer","required":false,"type":"integer","javaType":"int","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.arangodb.ArangoDbConfiguration","configurationField":"configuration","description":"ArangoDB exposed port. If host and port are default, this field is Optional."},"vertexCollection":{"kind":"parameter","displayName":"Vertex Collection","group":"producer","label":"producer","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":false,"configurationClass":"org.apache.camel.component.arangodb.ArangoDbConfiguration","configurationField":"configuration","description":"Collection name of vertices, when using ArangoDb as a Graph Database. Set the vertexCollection name to perform CRUD operation on vertices using these operations : SAVE_EDGE, FIND_EDGE_BY_KEY, UPDATE_EDGE, DELETE_EDGE. The graph attribute is mandatory."},"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,"configurationClass":"org.apache.camel.component.arangodb.ArangoDbConfiguration","configurationField":"configuration","description":"ArangoDB password. If user and password are default, this field is Optional."},"user":{"kind":"parameter","displayName":"User","group":"security","label":"security","required":false,"type":"string","javaType":"java.lang.String","deprecated":false,"autowired":false,"secret":true,"configurationClass":"org.apache.camel.component.arangodb.ArangoDbConfiguration","configurationField":"configuration","description":"ArangoDB user. If user and password are default, this field is Optional."}}} |