ArangoDb
Discover more about the ArangoDb connector and how to use it on the Digibee Integration Platform.
The content of this documentation is under revision and may change. We appreciate your understanding as we work to improve it.
ArangoDb performs 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).
General tab
Dynamic Account
When active, the connector will use the account dynamically. Otherwise, it will use the account statically.
False
Boolean
Account Name (DB)
The name of the dynamic account used by the connector. This account must have been previously configured in a Store Account connector in the pipeline for this process to take effect. It is only available if the Dynamic Account parameter is active.
N/A
String
Account
The account used by the connector. It is only available if the Dynamic Account parameter is inactive.
N/A
Account
Database (DB)
Database name.
N/A
String
Fail On Error
If the option is activated, the pipeline's execution with an error will be interrupted. Otherwise, the pipeline execution proceeds, but the result will show a false value for the "success" property.
False
Boolean
Optional tab
Document Collection (DB)
Collection name, when using ArangoDB as a Document Database. Set the documentCollection name when using CRUD operations 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 operations 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 either the vertexCollection or edgeCollection attributes.
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 AQL_QUERY operation, 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 operations 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
Db Multi Update
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
Db Multi Insert
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
Db Multi Delete
Indicates if there are multiple documents to delete. If set to true, the body of the message must be a collection of keys of documents to delete.
False
Boolean
Key (DB)
The Arango key to use for the operation.
N/A
String
Result Class Type (DB)
The type of the result of the operation.
BaseDocument.class or BaseEdgeDocument.class
String
Db Aql Query (DB)
The AQL query to execute.
N/A
String
Db Aql Parameters (DB)
The key/value pairs defining the variables to bind the query to.
N/A
JSON
Documentation tab
Documentation
Section for documenting any necessary information about the connector configuration and business rules.
N/A
String
Last updated