ArangoDB

Connect to ArangoDB multi-model databases with QueryBox

QueryBox supports ArangoDB through a native driver plugin. Execute AQL queries and manage databases, collections, documents, and graphs.

Connection Configuration

Basic

Configure your ArangoDB connection using individual parameters:

host · string · required

ArangoDB server hostname or IP address

Default: 127.0.0.1

port · number

ArangoDB server port

Default: 8529

user · string

Database username

Default: root

password · string

Database password

database · string

Database name to connect to

Default: _system

tls · string

Enable TLS/SSL encryption

Options: false, true

Default: false

Connection Examples

Local Development

http://127.0.0.1:8529
User: root
Database: _system

Remote Server with TLS

https://arangodb.example.com:8529
User: app_user
Password: secret
Database: production
TLS: true

Custom Database

http://localhost:8529
User: developer
Database: myapp

AQL Query Language

ArangoDB uses AQL (ArangoDB Query Language) for querying:

Basic Queries

// Return all documents
FOR doc IN users
  RETURN doc

// Filter documents
FOR doc IN users
  FILTER doc.age > 25
  RETURN doc

// Limit results
FOR doc IN users
  LIMIT 100
  RETURN doc

// Sort results
FOR doc IN users
  SORT doc.name ASC
  RETURN doc

Insert Documents

INSERT {
  name: "Alice",
  age: 30,
  email: "[e-mail]"
} INTO users

Update Documents

FOR doc IN users
  FILTER doc.name == "Alice"
  UPDATE doc WITH { age: 31 } IN users

Remove Documents

FOR doc IN users
  FILTER doc.age < 18
  REMOVE doc IN users

Joins and Relations

FOR user IN users
  FOR order IN orders
    FILTER order.userId == user._key
    RETURN {
      user: user.name,
      order: order.total
    }

Aggregation

FOR doc IN users
  COLLECT status = doc.status WITH COUNT INTO total
  RETURN {
    status: status,
    count: total
  }

Graph Traversal

FOR v, e, p IN 1..3 OUTBOUND "users/alice" friendships
  RETURN {
    friend: v.name,
    distance: LENGTH(p.vertices)
  }

DDL Meta-Commands

QueryBox extends AQL with DDL commands for database and collection management:

Database Operations

-- Create database
CREATE DATABASE mydb;

-- Drop database
DROP DATABASE mydb;

Collection Operations

-- Create collection
CREATE COLLECTION mycollection;

-- Create collection in specific database
CREATE COLLECTION mydb.mycollection;

-- Drop collection
DROP COLLECTION mycollection;

-- Drop collection from specific database
DROP COLLECTION mydb.mycollection;

These DDL commands are QueryBox extensions and are intercepted before being sent to ArangoDB.

Qualified Collection Names

QueryBox supports database-qualified collection names in AQL queries:

-- Query collection in different database
FOR doc IN mydb.users
  LIMIT 10
  RETURN doc

The plugin automatically:

1. Detects the database prefix (mydb)
2. Switches to that database
3. Rewrites the query to use the unqualified name (users)

Supported Features

AQL Queries

Full AQL query language support

Multi-Model

Documents, graphs, and key-value

Database Browser

Browse databases and collections

DDL Operations

Create and drop databases/collections

Capabilities

• AQL Execution: Full support for ArangoDB Query Language
• CRUD Operations: Insert, update, remove documents
• Graph Queries: Traverse and analyze graph data
• Aggregation: Group, count, and summarize data
• Join Operations: Combine data from multiple collections
• DDL Commands: Create and drop databases and collections
• Database Browser: Navigate databases and collections hierarchically
• Document Results: View results as structured documents
• TLS Support: Secure connections with embedded root certificates

Result Formats

AQL queries return different value types:

Document Results

• Objects returned directly as documents
• Scalars and arrays wrapped as {"value": <v>}
• Ensures consistent document-shaped payloads

DDL Results

• Key-value results showing operation status
• Example: {"result": "Collection created"}

Database Structure

The ArangoDB plugin displays:

1. Server (connection root)
2. Databases (all accessible databases or single specified database)
3. Collections (excludes system collections starting with _)
4. Actions: Quick query and drop operations

System collections (prefixed with _) are hidden from the connection tree.

Notes

Use qualified collection names (db.collection) to query across databases without changing your connection.

DROP DATABASE and DROP COLLECTION operations are permanent and cannot be undone.

ArangoDB supports multiple data models (document, graph, key-value) in a single database engine.

Advanced Features

Geospatial Queries

FOR loc IN locations
  FILTER DISTANCE(loc.lat, loc.lng, 40.7128, -74.0060) <= 1000
  RETURN loc

Full-Text Search

FOR doc IN FULLTEXT(articles, "content", "query,string")
  RETURN doc

Subqueries

FOR user IN users
  LET orderCount = (
    FOR order IN orders
      FILTER order.userId == user._key
      RETURN 1
  )
  RETURN {
    user: user.name,
    orders: LENGTH(orderCount)
  }

Plugin Information

• Version: 0.1.0
• License: Apache-2.0
• Author: ArangoDB GmbH
• Tags: nosql, multi-model
• Driver: github.com/arangodb/go-driver