ArangoDb

Discover more about the ArangoDb connector and how to use it on the Digibee Integration Platform.

Important information:

• This documentation is currently available only in English but will soon be translated into Portuguese.

• The content is under revision and may change. We appreciate your understanding as we work to improve the documentation.

Perform operations on ArangoDb when used as a Document Database, or as a Graph Database.

Parameters

Take a look at the configuration options for the component. Parameters supported by Double Braces expressions are marked with (DB).

Required Tab

Parameter	Description	Default value	Data type
Dynamic Account	When activated, the connector will use the account dynamically. When deactivated, it’ll use the account statically.	false	boolean
Account Name DB	The name of the account that is generated dynamically via the Store Account connector.		string
Account	Sets the account to be used by the connector.	N/A	string
Database DB	database name	N/A	string
Fail On Error	If true will stop pipeline with an error, if false will let the pipeline continue but the output will show a property success with value false	false	boolean

Optional Tab

Parameter	Description	Default value	Data type
Document Collection DB	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).	N/A	string
Edge Collection DB	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.	N/A	string
Graph DB	Graph name, when using ArangoDb as a Graph Database. Combine this attribute with one of the two attributes vertexCollection and edgeCollection.	N/A	string
Host DB	ArangoDB host. If host and port are default, this field is Optional.	N/A	string
Operation	Operations to perform on ArangoDb. For the operation AQL_QUERY, no need to specify a collection or graph.		string
Port	ArangoDB exposed port. If host and port are default, this field is Optional.	N/A	number
Vertex Collection DB	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.	N/A	string

Headers Tab

Parameter	Description	Default value	Data type
CamelArangoDbMultiUpdate	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.	false	boolean
CamelArangoDbMultiInsert	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.	false	boolean
CamelArangoDbMultiDelete	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.	false	boolean
Key DB	The Arango key to use for the operation.	N/A	string
ResultClassType DB	The type of the result of the operation.	BaseDocument.class or BaseEdgeDocument.class	string
CamelArangoDbAqlQuery DB	The AQL query to execute.	N/A	string
CamelArangoDbAqlParameters DB	The key/value pairs defining the variables to bind the query to.	N/A	JSON

Successful executions should output at least a property "success": true