Class ArangoDB

A thin wrapper around an ArangoJS Database instance. It provides direct and easy access to the ArangoJS instance itself, but also adds a few convenience methods, for optional use.

The constructor accepts an ArangoJS Config

import { aql } from "arangojs/aql";
import { ArangoDB } from "@distributhor/guacamole";

const db = new ArangoDB({ databaseName: "name", url: "http://127.0.0.1:8529", auth: { username: "admin", password: "letmein" } });

// the native ArangoJS driver instance is exposed on the `db.driver` property
db.driver.query(aql`FOR d IN user FILTER d.name LIKE ${name} RETURN d`);

// the backseat driver method, which immediately calls cursor.all()
// on the results, returning all the documents, and not the cursor
db.query(aql`FOR d IN user FILTER d.name LIKE ${name} RETURN d`);