# ArangoDb

{% hint style="info" %}
O conteúdo desta documentação está em revisão e pode ser alterado. Agradecemos sua compreensão enquanto trabalhamos para melhorá-la.
{% endhint %}

O **ArangoDb** executa operações no ArangoDb quando utilizado como Document Database ou como Graph Database.

## **Parâmetros**

Dê uma olhada nos parâmetros de configuração do conector. Parâmetros suportados por [expressões Double Braces](https://docs.digibee.com/documentation/connectors-and-triggers/pt-br/double-braces/overview) estão marcados com `(DB)`.

### **Aba General**

<table data-full-width="true"><thead><tr><th>Parâmetro</th><th>Descrição</th><th>Valor padrão</th><th>Tipo de dado</th></tr></thead><tbody><tr><td><strong>Dynamic Account</strong></td><td>Quando ativo, o conector usará a conta dinamicamente. Caso contrário, usará a conta de forma estática.</td><td>False</td><td>Booleano</td></tr><tr><td><strong>Account Name</strong> <code>(DB)</code></td><td>O nome da conta dinâmica usada pelo conector. Esta conta deve ter sido previamente configurada em um conector <a href="../tools/store-account"><strong>Store Account</strong></a> no pipeline para que este processo tenha efeito. Este parâmetro fica disponível apenas se o parâmetro <strong>Dynamic Account</strong> estiver ativo.</td><td>N/A</td><td>String</td></tr><tr><td><strong>Account</strong></td><td>A conta usada pelo conector. Este parâmetro fica disponível apenas se o parâmetro <strong>Dynamic Account</strong> estiver inativo.</td><td>N/A</td><td>Account</td></tr><tr><td><strong>Database</strong> <code>(DB)</code></td><td>Nome do banco de dados.</td><td>N/A</td><td>String</td></tr><tr><td><strong>Fail On Error</strong></td><td>Se a opção for ativada, a execução do pipeline com erro será interrompida. Caso contrário, a execução do pipeline continua, mas o resultado mostrará um valor falso para a propriedade <code>"success"</code>.</td><td>False</td><td>Booleano</td></tr></tbody></table>

### **Aba Opcional**

<table data-full-width="true"><thead><tr><th>Parâmetro</th><th>Descrição</th><th>Valor Padrão</th><th>Tipo de Dado</th></tr></thead><tbody><tr><td><strong>Document Collection</strong> <code>(DB)</code></td><td>Nome da coleção, ao usar o ArangoDB como um banco de dados de documentos. Defina o nome da <code>documentCollection</code> ao usar operações CRUD nas coleções de banco de dados de documentos (SAVE_DOCUMENT, FIND_DOCUMENT_BY_KEY, UPDATE_DOCUMENT, DELETE_DOCUMENT).</td><td>N/A</td><td>String</td></tr><tr><td><strong>Edge Collection</strong> <code>(DB)</code></td><td>Nome da coleção de vértices, ao usar o ArangoDB como um banco de dados gráfico. Defina o nome da <code>edgeCollection</code> para realizar operações CRUD em arestas usando essas operações: SAVE_VERTEX, FIND_VERTEX_BY_KEY, UPDATE_VERTEX, DELETE_VERTEX. O atributo <code>graph</code> é obrigatório.</td><td>N/A</td><td>String</td></tr><tr><td><strong>Graph</strong> <code>(DB)</code></td><td>Nome do grafo, ao usar o ArangoDB como um banco de dados gráfico. Combine este atributo com um dos dois atributos: <code>vertexCollection</code> ou <code>edgeCollection</code>.</td><td>N/A</td><td>String</td></tr><tr><td><strong>Host</strong> <code>(DB)</code></td><td>Host do ArangoDB. Se o host e a porta forem padrão, este campo é opcional.</td><td>N/A</td><td>String</td></tr><tr><td><strong>Operation</strong></td><td>Operações a serem realizadas no ArangoDB. Para a operação <code>AQL_QUERY</code>, não há necessidade de especificar uma coleção ou grafo.</td><td></td><td>String</td></tr><tr><td><strong>Port</strong></td><td>Porta exposta do ArangoDB. Se o host e a porta forem padrão, este campo é opcional.</td><td>N/A</td><td>Number</td></tr><tr><td><strong>Vertex Collection</strong> <code>(DB)</code></td><td>Nome da coleção de vértices, ao usar o ArangoDB como um banco de dados gráfico. Defina o nome da <code>vertexCollection</code> para realizar operações CRUD em vértices usando essas operações: SAVE_EDGE, FIND_EDGE_BY_KEY, UPDATE_EDGE, DELETE_EDGE. O atributo <code>graph</code> é obrigatório.</td><td>N/A</td><td>String</td></tr></tbody></table>

### **Aba Headers**

<table data-full-width="true"><thead><tr><th>Parâmetro</th><th>Descrição</th><th>Valor Padrão</th><th>Tipo de Dado</th></tr></thead><tbody><tr><td><strong>Db Multi Update</strong></td><td>Indica se há múltiplos documentos a serem atualizados. Se definido como verdadeiro, o corpo da mensagem deve ser uma coleção de documentos a serem atualizados.</td><td>False</td><td>Boolean</td></tr><tr><td><strong>Db Multi Insert</strong></td><td>Indica se há múltiplos documentos a serem inseridos. Se definido como verdadeiro, o corpo da mensagem deve ser uma coleção de documentos a serem inseridos.</td><td>False</td><td>Boolean</td></tr><tr><td><strong>Db Multi Delete</strong></td><td>Indica se há múltiplos documentos a serem excluídos. Se definido como verdadeiro, o corpo da mensagem deve ser uma coleção de chaves de documentos a serem excluídos.</td><td>False</td><td>Boolean</td></tr><tr><td><strong>Key</strong> <code>(DB)</code></td><td>A chave Arango a ser usada para a operação.</td><td>N/A</td><td>String</td></tr><tr><td><strong>Result Class Type</strong> <code>(DB)</code></td><td>O tipo do resultado da operação.</td><td>BaseDocument.class ou BaseEdgeDocument.class</td><td>String</td></tr><tr><td><strong>Db Aql Query</strong> <code>(DB)</code></td><td>A consulta AQL a ser executada.</td><td>N/A</td><td>String</td></tr><tr><td><strong>Db Aql Parameters</strong> <code>(DB)</code></td><td>Os pares chave/valor que definem as variáveis para associar à consulta.</td><td>N/A</td><td>JSON</td></tr></tbody></table>

### **Aba Documentation**

<table data-full-width="true"><thead><tr><th>Parâmetro</th><th>Descrição</th><th>Valor padrão</th><th>Tipo de dado</th></tr></thead><tbody><tr><td><strong>Documentation</strong></td><td>Seção para documentar qualquer informação necessária sobre a configuração do conector e regras de negócio.</td><td>N/A</td><td>String</td></tr></tbody></table>
