Skip to main content

ArangoDB

This page describes how to connect Appsmith to your ArangoDB data and query it from your app.

Connect ArangoDB​

caution

If you are a self-hosted user, you must whitelist the IP address ranges 18.223.74.0/24 and 3.131.104.0/24 of the Appsmith deployment on your ArangoDB instance. For more information about whitelisting in ArangoDB, see the ArangoDB documentation.

Connection parameters​

The following is a reference guide that provides a description of the parameters for connecting to ArangoDB.

Configuring an ArangoDB datasource.
Configuring an ArangoDB datasource.
Host Address
The network location of your ArangoDB database. This can be a domain name or an IP address. To connect to a local ArangoDB database, see Connect Local Database for directions.

Port
The port number to connect to on the server. If none is specified, Appsmith attempts to connect to port 8529.

Database Name
The name of your database.

Authentication
The Username and Password for the user with which you are connecting to the database.

SSL Mode
Determines whether your queries use an SSL connection to communicate with the database.

Options:
  • Default: The same as Disabled.
  • Enabled: Only allows an SSL connection.
  • Disabled: Does not attempt an SSL connection; it uses a plain unencrypted connection.

Query ArangoDB​

The following section provides examples of basic CRUD queries for ArangoDB.

Writing an ArangoDB query in the editor.
Writing an ArangoDB query in the editor.
info

For the ArangoDB Query Language (AQL) syntax, see the official AQL documentation.

Select​

FOR user IN users
FILTER user.role == "admin"
SORT user.id ASC
LIMIT {{ UsersTable.pageOffset }}, {{ UsersTable.pageSize }}
RETURN user

In the above example, UsersTable is the name of the Table widget that displays the data. It is configured to use server-side pagination to control how much data is queried at once.

Create​

INSERT {
    name: "{{ NameInput.text }}",
    gender: "{{ GenderDropdown.selectedOptionValue }}",
    email: "{{ EmailInput.text }}",
    role: "{{ RoleSelect.selectedOptionValue }}"
} INTO users

In the example above, NameInput, GenderDropdown, EmailInput, and RoleSelect are all widgets used to collect user input for the new record.

Update​

UPDATE
"{{ UsersTable.selectedRow.id }}"
WITH
{
    role: "admin"
}
IN users

In the example above, the query uses the id of the row selected in the UsersTable Table widget to update that record's role value.

Delete​

REMOVE "{{ UsersTable.selectedRow.id }}" IN users

In the example above, the query uses the id of the row selected in the UsersTable Table widget to delete that record.

See also​

Data access and binding