arangojs

The official ArangoDB JavaScript driver.

ArangoDB JavaScript driver

The official ArangoDB low-level JavaScript client for node.js and browsers.

Install

npm install arangojs
bower install arangojs

This CommonJS module is compatible with browserify.

If you don't want to use browserify, you can simply use the AMD-compatible browserify bundle (~42 kB minified, ~10 kB gzipped) which includes all required dependencies (extend and xhr).

There is also a browserify bundle without the dependencies (~34 kB minified, ~8 kB gzipped). In this case you need to provide modules named request (xhr) and extend yourself.

If you want to use this module in non-ES5 browsers like Microsoft Internet Explorer 8 and earlier, you need to include es5-shim or a similar ES5 polyfill.

git clone https://github.com/arangodb/arangojs.git
cd arangojs
npm install
npm run dist

API

All asynchronous functions take node-style callback functions (or "errbacks") with the following arguments:

  • err: an Error object if an error occurred, or null if no error occurred.
  • result: the function's result (if applicable).

For expected API errors, err will be an instance of ArangoError.

Creates a new database.

Parameter

  • config (optional): an object with the following properties:
  • url (optional): base URL of the ArangoDB server. Default: http://localhost:8529.
  • databaseName (optional): name of the active database. Default: _system.
  • arangoVersion (optional): value of the x-arango-version header. Default: 20200.
  • headers (optional): an object with headers to send with every request.

If config is a string, it will be interpreted as config.url.

These functions implement the HTTP API for manipulating collections.

Creates a collection from the given properties, then passes a new Collection instance to the callback.

For more information on the properties object, see the HTTP API documentation for creating collections.

If properties is a string, it will be interpreted as properties.name.

Examples

var db = require('arangojs')();
db.createCollection('my-data', function (errcollection) {
    if (err) return console.error(err);
    // collection is a DocumentCollection instance 
    // see the Collection API and DocumentCollection API below for details 
});
 
// -- or -- 
 
db.createCollection({
    name: 'my-data',
    type: 2 // i.e. document collection (the default) 
}, function (errcollection) {
    if (err) return console.error(err);
    // collection is a DocumentCollection instance 
    // see the Collection API and DocumentCollection API below for details 
});

Creates an edge collection from the given properties, then passes a new EdgeCollection instance to the callback.

For more information on the properties object, see the HTTP API documentation for creating collections.

If properties is a string, it will be interpreted as properties.name.

The collection type will be set to 3 (i.e. edge collection) regardless of the value of properties.type.

Examples

var db = require('arangojs')();
db.createEdgeCollection('friends', function (erredgeCollection) {
    if (err) return console.error(err);
    // edgeCollection is an EdgeCollection instance 
    // see the Collection API and EdgeCollection API below for details 
});

Fetches the collection with the given collectionName from the database, then passes a new Collection instance to the callback.

If autoCreate is set to true, a collection with the given name will be created if it doesn't already exist.

var db = require('arangojs')();
db.collection('potatos', function (errcollection) {
    if (err) {
        // Collection did not exist 
        console.error(err);
        return;
    }
    // collection exists 
});

Fetches all non-system collections from the database and passes an array of new Collection instances to the callback.

Examples

var db = require('arangojs')();
db.collections(function (errcollections) {
    if (err) return console.error(err);
    // collections is an array of Collection instances 
    // not including system collections 
});

Fetches all collections (including system collections) from the database and passes an array of new Collection instances to the callback.

Examples

var db = require('arangojs')();
db.allCollections(function (errcollections) {
    if (err) return console.error(err);
    // collections is an array of Collection instances 
    // including system collections 
});

Deletes the collection with the given collectionName from the database.

Examples

var db = require('arangojs')();
db.dropCollection('friends', function (err) {
    if (err) return console.error(err);
    // collection "friends" no longer exists 
});

Deletes all documents in all non-system collections in the active database.

Examples

var db = require('arangojs')();
db.truncate(function (err) {
    if (err) return console.error(err);
    // all non-system collections in this database are now empty 
});

Deletes all documents in all collections (including system collections) in the active database.

Examples

var db = require('arangojs')();
db.truncateAll(function (err) {
    if (err) return console.error(err);
    // all collections (including system collections) in this db are now empty 
    // "I've made a huge mistake..." 
});

These functions implement the HTTP API for manipulating general graphs.

Creates a graph with the given properties, then passes a new Graph instance to the callback.

For more information on the properties object, see the HTTP API documentation for creating graphs.

Examples

var db = require('arangojs')();
// this assumes collections `edges`, `start-vertices` and `end-vertices` exist 
db.createGraph({
    name: 'some-graph',
    edgeDefinitions: [
        {
            collection: 'edges',
            from: [
                'start-vertices'
            ],
            to: [
                'end-vertices'
            ]
        }
    ]
}, function (errgraph) {
    if (err) return console.error(err);
    // graph is a Graph instance 
    // for more information see the Graph API below 
});

Fetches the graph with the given graphName from the database, then passes a new Graph instance to the callback.

If autoCreate is set to true, a graph with the given name will be created if it doesn't already exist.

Examples

var db = require('arangojs')();
db.graph('some-graph', function (errgraph) {
    if (err) return console.error(err);
    // graph exists 
});

Fetches all graphs from the database and passes an array of new Graph instances to the callback.

Examples

var db = require('arangojs')();
db.graphs(function (errgraphs) {
    if (err) return console.error(err);
    // graphs is an array of Graph instances 
});

Deletes the graph with the given graphName from the database.

If dropCollections is set to true, the collections associated with the graphs will also be deleted.

Examples

var db = require('arangojs')();
db.dropGraph('some-graph', function (err) {
    if (err) return console.error(err);
    // graph "some-graph" no longer exists 
});

These functions implement the HTTP API for manipulating databases.

Creates a new database with the given databaseName, then passes a new Database instance to the callback.

Examples

var db = require('arangojs')();
db.createDatabase('mydb', function (errdatabase) {
    if (err) return console.error(err);
    // database is a Database instance 
});

Fetches the database with the given databaseName from the server, then passes a new Database instance to the callback.

If autoCreate is set to true, a database with the given name will be created if it doesn't already exist.

Examples

var db = require('arangojs')();
db.database('mydb', function (errdatabase) {
    if (err) return console.error(err);
    // mydb exists 
});

Fetches all databases from the server and passes an array of new Database instances to the callback.

Examples

var db = require('arangojs')();
db.databases(function (errdatabases) {
    if (err) return console.error(err);
    // databases is an array of Database instances 
});

Deletes the database with the given databaseName from the server.

var db = require('arangojs')();
db.dropDatabase('mydb', function (err) {
    if (err) return console.error(err);
    // database "mydb" no longer exists 
})

This function implements the HTTP API for transactions.

Performs a server-side transaction and passes the action's return value to the callback.

Parameter

  • collections: an object with the following properties:
  • read: an array of names (or a single name) of collections that will be read from during the transaction.
  • write: an array of names (or a single name) of collections that will be written to or read from during the transaction.
  • action: a string evaluating to a JavaScript function to be executed on the server.
  • params (optional): parameters that will be passed to the function.
  • lockTimeout (optional): determines how long the database will wait while attemping to gain locks on collections used by the transaction before timing out.

If collections is an array or string, it will be used as collections.write.

Please note that while action should be a string evaluating to a well-formed JavaScript function, it's not possible to pass in a JavaScript function directly because the function needs to be evaluated on the server and will be transmitted in plain text.

For more information on transactions, see the HTTP API documentation for transactions.

Examples

var db = require('arangojs')();
var collections = {read: '_users'};
var action = String(function () {
    // This code will be executed inside ArangoDB! 
    var db = require('org/arangodb').db;
    return db._query('FOR user IN _users RETURN u.user').toArray();
});
db.transaction(collections, action, function (errresult) {
    if (err) return console.error(err);
    // result contains the return value of the action 
});

This function implements the HTTP API for AQL queries.

For collection-specific queries see fulltext queries and geo-spatial queries.

Performs a database query using the given query and bindVars, then passes a new Cursor instance for the result list to the callback.

Parameter

  • query: an AQL query string or a query builder instance.
  • bindVars (optional): an object with the variables to bind the query to.

For more information on Cursor instances see the Cursor API below.

Examples

var qb = require('aqb');
var db = require('arangojs')();
db.query(
    qb.for('u').in('_users')
    .filter(qb.eq('u.authData.active', '@active'))
    .return('u.user'),
    {active: true},
    function (errcursor) {
        if (err) return console.error(err);
        // cursor is a cursor for the query result 
    }
);
 
// -- or -- 
 
db.query(
    'FOR u IN _users FILTER u.authData.active == @active RETURN u.user',
    {active: true},
    function (errcursor) {
    if (err) return console.error(err);
        // cursor is a cursor for the query result 
    }
);

These functions implement the HTTP API for managing AQL user functions.

Creates an AQL user function with the given name and code if it does not already exist or replaces it if a function with the same name already existed.

Parameter

  • name: a valid AQL function name, e.g.: "myfuncs::accounting::calculate_vat".
  • code: a string evaluating to a JavaScript function (not a JavaScript function object).

Examples

var qb = require('aqb');
var db = require('arangojs')();
var vat_fn_name = 'myfuncs::acounting::calculate_vat';
var vat_fn_code = String(function (price) {
    return price * 0.19;
});
db.createFunction(vat_fn_name, vat_fn_code, function (err) {
    if (err) return console.error(err);
    // Use the new function in an AQL query with the query builder: 
    db.query(
        qb.for('product').in('products')
        .return(qb.MERGE(
            {
                vat: qb.fn(vat_fn_name)('product.price')
            },
            'product'
        )),
        function (errresult) {
            // ... 
        }
    );
});

Fetches a list of all AQL user functions registered with the database.

Examples

var db = require('arangojs')();
db.functions(function (errfunctions) {
    if (err) return console.error(err);
    // functions is a list of function definitions 
})

Deletes the AQL user function with the given name from the database.

Parameter

  • name: the name of the user function to drop.
  • group (optional): if set to true, all functions with a name starting with name will be deleted; otherwise only the function with the exact name will be deleted. Default: false.

Examples

var db = require('arangojs')();
db.dropFunction('myfuncs::acounting::calculate_vat', function (err) {
    if (err) return console.error(err);
    // the function no longer exists 
});

Returns a new Route instance for the given path (relative to the database) that can be used to perform arbitrary HTTP requests.

Parameter

  • path (optional): relative URL of the route.
  • headers (optional): default headers that should be send with each request to the route.

If path is missing, the route will refer to the base URL of the database.

For more information on Route instances see the Route API below.

Examples

var db = require('arangojs')();
var myFoxxApp = db.route('my-foxx-app');
myFoxxApp.post('users', {
    username: 'admin',
    password: 'hunter2'
}, function (errresult) {
    if (err) return console.error(err);
    // result is the result of 
    // POST /_db/_system/my-foxx-app/users 
    // with JSON request body '{"username": "admin", "password": "hunter2"}' 
});

Cursor instances provide an abstraction over the HTTP API's limitations. Unless a method explicitly exhausts the cursor, the driver will only fetch as many batches from the server as necessary. Unlike the server-side cursors, Cursor instances can also be rewinded.

var db = require('arangojs')();
db.query(someQuery, function (errcursor) {
    if (err) return console.error(err);
    // cursor represents the query results 
});

Rewinds and exhausts the cursor and passes an array containing all values returned by the query.

Examples

// query result: [1, 2, 3, 4, 5] 
cursor.all(function (errvals) {
    if (err) return console.error(err);
    // vals is an array containing the entire query result 
    vals.length === 5;
    vals; // [1, 2, 3, 4, 5] 
    cursor.hasNext() === false;
});

Advances the cursor and passes the next value returned by the query. If the cursor has already been exhausted, passes instead.

Examples

// query result: [1, 2, 3, 4, 5] 
cursor.next(function (errval) {
    if (err) return console.error(err);
    val === 1;
    cursor.next(function (errval2) {
        if (err) return console.error(err);
        val2 === 2;
    });
});

Returns true if the cursor has more values or false if the cursor has been exhausted. Synchronous.

Examples

cursor.all(function (err) { // exhausts the cursor 
    if (err) return console.error(err);
    cursor.hasNext() === false;
});

Rewinds and exhausts the cursor by applying the function fn to each value returned by the query, then invokes the callback with no result value.

Equivalent to Array.prototype.forEach.

var counter = 0;
function count() {
    counter += 1;
    return counter;
}
// query result: [1, 2, 3, 4, 5] 
cursor.each(count, function (errresult) {
    if (err) return console.error(err);
    counter === result;
    result === 5;
    cursor.hasNext() === false;
});

Rewinds and advances the cursor by applying the function fn to each value returned by the query until the cursor is exhausted or fn returns a value that evaluates to false.

Passes the return value of the last call to fn to the callback.

Equivalent to Array.prototype.every.

function even(value) {
    return value % 2 === 0;
}
// query result: [0, 2, 4, 5, 6] 
cursor.every(even, function (errresult) {
    if (err) return console.error(err);
    result === false; // 5 is not even 
    cursor.hasNext() === true;
    cursor.next(function (errvalue) {
        if (err) return console.error(err);
        value === 6; // next value after 5 
    });
});

Rewinds and advances the cursor by applying the function fn to each value returned by the query until the cursor is exhausted or fn returns a value that evaluates to true.

Passes the return value of the last call to fn to the callback.

Equivalent to Array.prototype.some.

Examples

function even(value) {
    return value % 2 === 0;
}
// query result: [1, 3, 4, 5] 
cursor.some(even, function (errresult) {
    if (err) return console.error(err);
    result === true; // 4 is even 
    cursor.hasNext() === true;
    cursor.next(function (errvalue) {
        if (err) return console.error(err);
        value === 5; // next value after 4 
    });
});

Rewinds and exhausts the cursor by applying the function fn to each value returned by the query, then invokes the callback with an array of the return values.

Equivalent to Array.prototype.map.

Examples

function square(value) {
    return value * value;
}
// query result: [1, 2, 3, 4, 5] 
cursor.map(square, function (errresult) {
    if (err) return console.error(err);
    result.length === 5;
    result; // [1, 4, 9, 16, 25] 
    cursor.hasNext() === false;
});

Rewinds and exhausts the cursor by reducing the values returned by the query with the given function fn. If accu is not provided, the first value returned by the query will be used instead (the function will not be invoked for that value).

Equivalent to Array.prototype.reduce.

Examples

function add(ab) {
    return a + b;
}
// query result: [1, 2, 3, 4, 5] 
 
var baseline = 1000;
cursor.reduce(add, baseline, function (errresult) {
    if (err) return console.error(err);
    result === (baseline + 1 + 2 + 3 + 4 + 5);
    cursor.hasNext() === false;
});
 
// -- or -- 
 
cursor.reduce(add, function (errresult) {
    if (err) return console.error(err);
    result === (1 + 2 + 3 + 4 + 5);
    cursor.hasNext() === false;
});
 

Rewinds the cursor. Synchronous.

Examples

// query result: [1, 2, 3, 4, 5] 
cursor.all(function (errresult) {
    if (err) return console.error(err);
    result; // [1, 2, 3, 4, 5] 
    cursor.hasNext() === false;
    cursor.rewind();
    cursor.hasNext() === true;
    cursor.next(function (errvalue) {
        if (err) return console.error(err);
        value === 1;
    });
});

Route instances provide access for arbitrary HTTP requests. This allows easy access to Foxx apps and other HTTP APIs not covered by the driver itself.

Creates a new Route instance representing the path relative to the current route. Optionally headers can be an object with headers which will be extended with the current route's headers and the connection's headers.

Examples

var db = require('arangojs')();
var route = db.route('my-foxx-app');
var users = route.route('users');
// equivalent to db.route('my-foxx-app/users') 

Performs a GET request to the given URL and passes the server response to the given callback.

Parameter

  • path (optional): the route-relative URL for the request.
  • qs (optional): the query string for the request.

If path is missing, the request will be made to the base URL of the route.

If qs is an object, it will be translated to a query string.

Examples

var db = require('arangojs')();
var route = db.route('my-foxx-app');
route.get(function (errresult) {
    if (err) return console.error(err);
    // result is the response body of calling 
    // GET _db/_system/my-foxx-app 
});
 
// -- or --  
 
route.get('users', function (errresult) {
    if (err) return console.error(err);
    // result is the response body of calling 
    // GET _db/_system/my-foxx-app/users 
});
 
// -- or -- 
 
route.get('users', {group: 'admin'}, function (errresult) {
    if (err) return console.error(err);
    // result is the response body of calling 
    // GET _db/_system/my-foxx-app/users?group=admin 
});

Performs a POST request to the given URL and passes the server response to the given callback.

Parameter

  • path (optional): the route-relative URL for the request.
  • body (optional): the request body for the request.
  • qs (optional): the query string for the request.

If path is missing, the request will be made to the base URL of the route.

If body is an object, it will be converted to JSON.

If qs is an object, it will be translated to a query string.

Examples

var db = require('arangojs')();
var route = db.route('my-foxx-app');
route.post(function (errresult) {
    if (err) return console.error(err);
    // result is the response body of calling 
    // POST _db/_system/my-foxx-app 
});
 
// -- or --  
 
route.post('users', function (errresult) {
    if (err) return console.error(err);
    // result is the response body of calling 
    // POST _db/_system/my-foxx-app/users 
});
 
// -- or -- 
 
route.post('users', {
    username: 'admin',
    password: 'hunter2'
}, function (errresult) {
    if (err) return console.error(err);
    // result is the response body of calling 
    // POST _db/_system/my-foxx-app/users 
    // with JSON request body {"username": "admin", "password": "hunter2"} 
});
 
// -- or -- 
 
route.post('users', {
    username: 'admin',
    password: 'hunter2'
}, {admin: true}, function (errresult) {
    if (err) return console.error(err);
    // result is the response body of calling 
    // POST _db/_system/my-foxx-app/users?admin=true 
    // with JSON request body {"username": "admin", "password": "hunter2"} 
});

Performs a PUT request to the given URL and passes the server response to the given callback.

Parameter

  • path (optional): the route-relative URL for the request.
  • body (optional): the request body for the request.
  • qs (optional): the query string for the request.

If path is missing, the request will be made to the base URL of the route.

If body is an object, it will be converted to JSON.

If qs is an object, it will be translated to a query string.

Examples

var db = require('arangojs')();
var route = db.route('my-foxx-app');
route.put(function (errresult) {
    if (err) return console.error(err);
    // result is the response body of calling 
    // PUT _db/_system/my-foxx-app 
});
 
// -- or --  
 
route.put('users/admin', function (errresult) {
    if (err) return console.error(err);
    // result is the response body of calling 
    // PUT _db/_system/my-foxx-app/users 
});
 
// -- or -- 
 
route.put('users/admin', {
    username: 'admin',
    password: 'hunter2'
}, function (errresult) {
    if (err) return console.error(err);
    // result is the response body of calling 
    // PUT _db/_system/my-foxx-app/users/admin 
    // with JSON request body {"username": "admin", "password": "hunter2"} 
});
 
// -- or -- 
 
route.put('users/admin', {
    username: 'admin',
    password: 'hunter2'
}, {admin: true}, function (errresult) {
    if (err) return console.error(err);
    // result is the response body of calling 
    // PUT _db/_system/my-foxx-app/users/admin?admin=true 
    // with JSON request body {"username": "admin", "password": "hunter2"} 
});

Performs a PATCH request to the given URL and passes the server response to the given callback.

Parameter

  • path (optional): the route-relative URL for the request.
  • body (optional): the request body for the request.
  • qs (optional): the query string for the request.

If path is missing, the request will be made to the base URL of the route.

If body is an object, it will be converted to JSON.

If qs is an object, it will be translated to a query string.

var db = require('arangojs')();
var route = db.route('my-foxx-app');
route.patch(function (errresult) {
    if (err) return console.error(err);
    // result is the response body of calling 
    // PATCH _db/_system/my-foxx-app 
});
 
// -- or --  
 
route.patch('users/admin', function (errresult) {
    if (err) return console.error(err);
    // result is the response body of calling 
    // PATCH _db/_system/my-foxx-app/users 
});
 
// -- or -- 
 
route.patch('users/admin', {
    password: 'hunter2'
}, function (errresult) {
    if (err) return console.error(err);
    // result is the response body of calling 
    // PATCH _db/_system/my-foxx-app/users/admin 
    // with JSON request body {"password": "hunter2"} 
});
 
// -- or -- 
 
route.patch('users/admin', {
    password: 'hunter2'
}, {admin: true}, function (errresult) {
    if (err) return console.error(err);
    // result is the response body of calling 
    // PATCH _db/_system/my-foxx-app/users/admin?admin=true 
    // with JSON request body {"password": "hunter2"} 
});

Performs a DELETE request to the given URL and passes the server response to the given callback.

Parameter

  • path (optional): the route-relative URL for the request.
  • qs (optional): the query string for the request.

If path is missing, the request will be made to the base URL of the route.

If qs is an object, it will be translated to a query string.

Examples

var db = require('arangojs')();
var route = db.route('my-foxx-app');
route.delete(function (errresult) {
    if (err) return console.error(err);
    // result is the response body of calling 
    // DELETE _db/_system/my-foxx-app 
});
 
// -- or --  
 
route.delete('users/admin', function (errresult) {
    if (err) return console.error(err);
    // result is the response body of calling 
    // DELETE _db/_system/my-foxx-app/users/admin 
});
 
// -- or -- 
 
route.delete('users/admin', {permanent: true}, function (errresult) {
    if (err) return console.error(err);
    // result is the response body of calling 
    // DELETE _db/_system/my-foxx-app/users/admin?permanent=true 
});

Performs a HEAD request to the given URL and passes the server response to the given callback.

Parameter

  • path (optional): the route-relative URL for the request.
  • qs (optional): the query string for the request.

If path is missing, the request will be made to the base URL of the route.

If qs is an object, it will be translated to a query string.

Examples

var db = require('arangojs')();
var route = db.route('my-foxx-app');
route.head(function (errresultresponse) {
    if (err) return console.error(err);
    // result is empty (no response body) 
    // response is the response object for 
    // HEAD _db/_system/my-foxx-app 
});

Performs an arbitrary request to the given URL and passes the server response to the given callback.

Parameter

  • opts: an object with the following properties:
  • path: the route-relative URL for the request.
  • absolutePath (optional): whether the path is relative to the connection's base URL instead of the route. Default: false.
  • body (optional): the request body.
  • qs (optional): the query string.
  • headers (optional): an object containing additional HTTP headers to send with the request.
  • method (optional): HTTP method to use. Default: "GET".

If opts.path is missing, the request will be made to the base URL of the route.

If opts.body is an object, it will be converted to JSON.

If opts.qs is an object, it will be translated to a query string.

var db = require('arangojs')();
var route = db.route('my-foxx-app');
route.request({
    path: 'hello-world',
    method: 'POST',
    body: {hello: 'world'},
    qs: {admin: true}
}, function (errresult) {
    if (err) return console.error(err);
    // result is the response body of calling 
    // POST _db/_system/my-foxx-app/hello-world?admin=true 
    // with JSON request body '{"hello": "world"}' 
});

These functions implement the HTTP API for manipulating collections.

The Collection API is implemented by all Collection instances, regardless of their specific type. I.e. it represents a shared subset between instances of DocumentCollection, EdgeCollection, GraphVertexCollection and GraphEdgeCollection.

See the HTTP API documentation for details.

Retrieves the collection's properties.

Examples

var db = require('arangojs')();
db.collection('some-collection', function (errcollection) {
    if (err) return console.error(err);
    collection.properties(function (errprops) {
        if (err) return console.error(err);
        // props contains the collection's properties 
    });
});

Retrieves the number of documents in a collection.

Examples

var db = require('arangojs')();
db.collection('some-collection', function (errcollection) {
    if (err) return console.error(err);
    collection.count(function (errcount) {
        if (err) return console.error(err);
        // count contains the collection's count 
    });
});

Retrieves statistics for a collection.

Examples

var db = require('arangojs')();
db.collection('some-collection', function (errcollection) {
    if (err) return console.error(err);
    collection.figures(function (errfigures) {
        if (err) return console.error(err);
        // figures contains the collection's figures 
    });
});

Retrieves the collection revision ID.

Examples

var db = require('arangojs')();
db.collection('some-collection', function (errcollection) {
    if (err) return console.error(err);
    collection.revision(function (errrevision) {
        if (err) return console.error(err);
        // revision contains the collection's revision 
    });
});

Retrieves the collection checksum.

For information on the possible options see the HTTP API for getting collection information.

Examples

var db = require('arangojs')();
db.collection('some-collection', function (errcollection) {
    if (err) return console.error(err);
    collection.checksum(function (errchecksum) {
        if (err) return console.error(err);
        // checksum contains the collection's checksum 
    });
});

These functions implement the HTTP API for modifying collections.

Tells the server to load the collection into memory.

If count is set to false, the return value will not include the number of documents in the collection (which may speed up the process).

Examples

var db = require('arangojs')();
db.collection('some-collection', function (errcollection) {
    if (err) return console.error(err);
    collection.load(false, function (err) {
        if (err) return console.error(err);
        // the collection has now been loaded into memory 
    });
});

Tells the server to remove the collection from memory.

Examples

var db = require('arangojs')();
db.collection('some-collection', function (errcollection) {
    if (err) return console.error(err);
    collection.unload(function (err) {
        if (err) return console.error(err);
        // the collection has now been unloaded from memory 
    });
});

Replaces the properties of the collection.

For information on the properties argument see the HTTP API for modifying collections.

Examples

var db = require('arangojs')();
db.collection('some-collection', function (errcollection) {
    if (err) return console.error(err);
    collection.setProperties({waitForSync: true}, function (errresult) {
        if (err) return console.error(err);
        result.waitForSync === true;
        // the collection will now wait for data being written to disk 
        // whenever a document is changed 
    });
});

Renames the collection. The Collection instance will automatically update its name according to the server response.

Examples

var db = require('arangojs')();
db.collection('some-collection', function (errcollection) {
    if (err) return console.error(err);
    collection.rename('new-collection-name', function (errresult) {
        if (err) return console.error(err);
        result.name === 'new-collection-name';
        collection.name === result.name;
        // result contains additional information about the collection 
    });
});

Rotates the journal of the collection.

Examples

var db = require('arangojs')();
db.collection('some-collection', function (errcollection) {
    if (err) return console.error(err);
    collection.rotate(function (errresult) {
        if (err) return console.error(err);
        // result.result will be true if rotation succeeded 
    });
});

Deletes all documents in the collection in the database.

Examples

var db = require('arangojs')();
db.collection('some-collection', function (errcollection) {
    if (err) return console.error(err);
    collection.truncate(function (err) {
        if (err) return console.error(err);
        // the collection "some-collection" is now empty 
    });
});

Deletes the collection from the database.

Equivalent to database.dropCollection(collection.name, callback).

Examples

var db = require('arangojs')();
db.collection('some-collection', function (errcollection) {
    if (err) return console.error(err);
    collection.drop(function (err) {
        if (err) return console.error(err);
        // the collection "some-collection" no longer exists 
    });
});

These functions implement the HTTP API for manipulating indexes.

Creates an arbitrary index on the collection.

For information on the possible properties of the details object, see the HTTP API for manipulating indexes.

Examples

var db = require('arangojs')();
var collection = db.createCollection('some-collection', function (errcollection) {
    if (err) return console.error(err);
    collection.createIndex({
        type: 'cap',
        size: 20
    }, function (errindex) {
        if (err) return console.error(err);
        index.id; // the index's handle 
        // the index has been created 
    });
});

Creates a cap constraint index on the collection.

Parameter

  • size: an object with any of the following properties:
  • size: the maximum number of documents in the collection.
  • byteSize: the maximum size of active document data in the collection (in bytes).

If size is a number, it will be interpreted as size.size.

For more information on the properties of the size object see the HTTP API for creating cap constraints.

Examples

var db = require('arangojs')();
db.createCollection('some-collection', function (errcollection) {
    if (err) return console.error(err);
    collection.createCapCollection(20, function (errindex) {
        if (err) return console.error(err);
        index.id; // the index's handle 
        index.size === 20;
        // the index has been created 
    });
    // -- or -- 
    collection.createCapCollection({size: 20}, function (errindex) {
        if (err) return console.error(err);
        index.id; // the index's handle 
        index.size === 20;
        // the index has been created 
    });
});

Creates a hash index on the collection.

Parameter

  • fields: an array of document fields on which to create the index.
  • unique (optional): whether to constrain the fields to unique values. Default: false.

If fields is a string, it will be wrapped in an array automatically.

For more information on hash indexes, see the HTTP API for hash indexes.

Examples

var db = require('arangojs')();
db.createCollection('some-collection', function (errcollection) {
    if (err) return console.error(err);
    collection.createHashIndex('favorite-color', function (errindex) {
        if (err) return console.error(err);
        index.id; // the index's handle 
        index.fields; // ['favorite-color'] 
        // the index has been created 
    });
    // -- or -- 
    collection.createHashIndex(['favorite-color'], function (errindex) {
        if (err) return console.error(err);
        index.id; // the index's handle 
        index.fields; // ['favorite-color'] 
        // the index has been created 
    });
});

Creates a skiplist index on the collection.

Parameter

  • fields: an array of document fields on which to create the index.
  • unique (optional): whether to constrain the fields to unique values. Default: false.

If fields is a string, it will be wrapped in an array automatically.

For more information on skiplist indexes, see the HTTP API for skiplist indexes.

Examples

var db = require('arangojs')();
db.createCollection('some-collection', function (errcollection) {
    if (err) return console.error(err);
    collection.createSkipList('favorite-color', function (errindex) {
        if (err) return console.error(err);
        index.id; // the index's handle 
        index.fields; // ['favorite-color'] 
        // the index has been created 
    });
    // -- or -- 
    collection.createSkipList(['favorite-color'], function (errindex) {
        if (err) return console.error(err);
        index.id; // the index's handle 
        index.fields; // ['favorite-color'] 
        // the index has been created 
    });
});

Creates a geo-spatial index on the collection.

Parameter

  • fields: an array of document fields on which to create the index. Currently, fulltext indexes must cover exactly one field.
  • opts (optional): an object containing additional properties of the index.

If fields is a string, it will be wrapped in an array automatically.

For more information on the properties of the opts object see the HTTP API for manipulating geo indexes.

Examples

var db = require('arangojs')();
db.createCollection('some-collection', function (errcollection) {
    if (err) return console.error(err);
    collection.createGeoIndex(['longitude', 'latitude'], function (errindex) {
        if (err) return console.error(err);
        index.id; // the index's handle 
        index.fields; // ['longitude', 'latitude'] 
        // the index has been created 
    });
    // -- or -- 
    collection.createGeoIndex('location', {geoJson: true}, function (errindex) {
        if (err) return console.error(err);
        index.id; // the index's handle 
        index.fields; // ['location'] 
        // the index has been created 
    });
});

Creates a fulltext index on the collection.

Parameter

  • fields: an array of document fields on which to create the index. Currently, fulltext indexes must cover exactly one field.
  • minLength (optional): minimum character length of words to index. Uses a server-specific default value if not specified.

If fields is a string, it will be wrapped in an array automatically.

For more information on fulltext indexes, see the HTTP API for fulltext indexes.

Examples

var db = require('arangojs')();
db.createCollection('some-collection', function (errcollection) {
    if (err) return console.error(err);
    collection.createFulltextIndex('description', function (errindex) {
        if (err) return console.error(err);
        index.id; // the index's handle 
        index.fields; // ['description'] 
        // the index has been created 
    });
    // -- or -- 
    collection.createFulltextIndex(['description'], function (errindex) {
        if (err) return console.error(err);
        index.id; // the index's handle 
        index.fields; // ['description'] 
        // the index has been created 
    });
});

Fetches information about the index with the given indexHandle and passes it to the given callback.

The value of indexHandle can either be a fully-qualified index.id or the collection-specific key of the index.

Examples

var db = require('arangojs')();
db.createCollection('some-collection', function (errcollection) {
    if (err) return console.error(err);
    collection.createFulltextIndex('description', function (errindex) {
        if (err) return console.error(err);
        collection.index(index.id, function (errresult) {
            if (err) return console.error(err);
            result.id === index.id;
            // result contains the properties of the index 
        });
        // -- or -- 
        collection.index(index.id.split('/')[1], function (errresult) {
            if (err) return console.error(err);
            result.id === index.id;
            // result contains the properties of the index 
        });
    });
});

Fetches a list of all indexes on this collection.

Examples

var db = require('arangojs')();
db.createCollection('some-collection', function (errcollection) {
    if (err) return console.error(err);
    collection.createFulltextIndex('description', function (err) {
        if (err) return console.error(err);
        collection.indexes(function (errindexes) {
            if (err) return console.error(err);
            indexes.length === 1;
            // indexes contains information about the index 
        });
    });
});

Deletes the index with the given indexHandle from the collection.

The value of indexHandle can either be a fully-qualified index.id or the collection-specific key of the index.

Examples

var db = require('arangojs')();
db.createCollection('some-collection', function (errcollection) {
    if (err) return console.error(err);
    collection.createFulltextIndex('description', function (errindex) {
        if (err) return console.error(err);
        collection.dropIndex(index.id, function (err) {
            if (err) return console.error(err);
            // the index has been removed from the collection 
        });
        // -- or -- 
        collection.dropIndex(index.id.split('/')[1], function (err) {
            if (err) return console.error(err);
            // the index has been removed from the collection 
        });
    });
});

This function implements the HTTP API for fulltext queries.

Note that a collection must have fulltext indexes in order to perform fulltext queries on it.

Performs a fulltext query searching for query in the given fieldName of all documents in this collection.

Parameter

  • fieldName: the name of the field to search.
  • query: a fulltext query string.
  • opts (optional): an object containing additional options for the query.

For more information on the properties of the opts object see the HTTP API for fulltext queries.

For more information on Cursor instances see the Cursor API above.

Examples

var db = require('arangojs')();
db.collection('some-collection', function (errcollection) {
    if (err) return console.error(err);
    collection.createFulltextIndex('description', function (err) {
        if (err) return console.error(err);
        collection.fulltext('description', 'hello', function (errcursor) {
            if (err) return console.error(err);
            // cursor is a Cursor instance for the query results 
        });
    });
});

These functions implement the HTTP API for geo-spatial queries.

Note that a collection must have geo-spatial indexes in order to perform geo-spatial queries on it.

Performs a geo-spatial query for documents near the given location.

Parameter

  • latitude: latitude of the target location.
  • longitude: longitude of the target location.
  • opts (optional): an object containing additional options for the query.

For more information on the properties of the opts object see the HTTP API for geo-spatial queries.

For more information on Cursor instances see the Cursor API above.

Examples

var db = require('arangojs')();
db.collection('some-collection', function (errcollection) {
    if (err) return console.error(err);
    collection.createGeoIndex('location', function (err) {
        if (err) return console.error(err);
        collection.near(0, 0, {
            limit: 100,
            distance: 'distance'
        }, function (errcursor) {
            if (err) return console.error(err);
            // cursor is a Cursor instance for the closest 100 query results 
            // each result has an additional property "distance" containing 
            // the document's distance to the target location in meters 
        });
    });
});

Performs a geo-spatial query for documents within the given radius of the given location.

Parameter

  • latitude: latitude of the target location.
  • longitude: longitude of the target location.
  • radius: the search radius (in meters).
  • opts (optional): an object containing additional options for the query.

For more information on the properties of the opts object see the HTTP API for geo-spatial queries.

For more information on Cursor instances see the Cursor API above.

Examples

var db = require('arangojs')();
db.collection('some-collection', function (errcollection) {
    if (err) return console.error(err);
    collection.createGeoIndex('location', function (err) {
        if (err) return console.error(err);
        collection.within(0, 0, 500, {
            limit: 100,
            distance: 'distance'
        }, function (errcursor) {
            if (err) return console.error(err);
            // cursor is a Cursor instance for the closest 100 query results 
            // within up to 500 meters of the target location 
            // each result has an additional property "distance" containing 
            // the document's distance to the target location in meters 
        });
    });
});

This function implements the HTTP API for bulk imports.

Bulk imports the given data into the collection.

The data can be an array of documents:

[
  {key1: value1, key2: value2}, // document 1 
  {key1: value1, key2: value2}, // document 2 
  ...
]

Or it can be an array of value arrays following an array of keys.

[
  ['key1', 'key2'], // key names 
  [value1, value2], // document 1 
  [value1, value2], // document 2 
  ...
]

If opts is set, it must be an object with any of the following properties:

  • waitForSync: Wait until the documents have been synced to disk. Default: false.
  • details: Whether the response should contain additional details about documents that could not be imported. Default: false.
  • type: Indicates which format the data uses. Can be "documents", "array" or "auto". Default: "auto".

If data is a JavaScript array, it will be transmitted as a line-delimited JSON stream. If opts.type is set to "array", it will be transmitted as regular JSON instead. If data is a string, it will be transmitted as it is without any processing.

For more information on the opts object, see the HTTP API documentation for bulk imports.

Examples

var db = require('arangojs')();
db.collection('users', function (errcollection) {
    if (err) return console.error(err);
    collection.import(
        [// document stream 
            {username: 'admin', password: 'hunter2', 'favorite-color': 'orange'},
            {username: 'jcd', password: 'bionicman', 'favorite-color': 'black'},
            {username: 'jreyes', password: 'amigo', 'favorite-color': 'white'},
            {username: 'ghermann', password: 'zeitgeist', 'favorite-color': 'blue'}
        ],
        function (errresult) {
            if (err) return console.error(err);
            result.created === 4;
        }
    );
    // -- or -- 
    collection.import(
        [// array stream with header 
            ['username', 'password', 'favourite_color'],
            ['admin', 'hunter2', 'orange'],
            ['jcd', 'bionicman', 'black'],
            ['jreyes', 'amigo', 'white'],
            ['ghermann', 'zeitgeist', 'blue']
        ],
        function (errresult) {
            if (err) return console.error(err);
            result.created === 4;
        }
    );
    // -- or -- 
    collection.import(
        (// raw line-delimited JSON array stream with header 
            '["username", "password", "favourite_color"]\r\n' +
            '["admin", "hunter2", "orange"]\r\n' +
            '["jcd", "bionicman", "black"]\r\n' +
            '["jreyes", "amigo", "white"]\r\n' +
            '["ghermann", "zeitgeist", "blue"]\r\n'
        ),
        function (errresult) {
            if (err) return console.error(err);
            result.created === 4;
        }
    );
});

These functions implement the HTTP API for manipulating documents.

Replaces the content of the document with the given documentHandle with the given data.

If opts is set, it must be an object with any of the following properties:

  • waitForSync: Wait until the document has been synced to disk. Default: false.
  • rev: Only replace the document if it matches this revision. Optional.
  • policy: Determines the behaviour when the revision is not matched:
  • if policy is set to "last", the document will be replaced regardless of the revision.
  • if policy is set to "error" or not set, the replacement will fail with an error.

The documentHandle can be either the _id or the _key of a document in the collection, or a document (i.e. an object with an _id or _key property).

For more information on the opts object, see the HTTP API documentation for working with documents.

Examples

var db = require('arangojs')();
db.collection('some-collection', function (errcollection) {
    if (err) return console.error(err);
    collection.save({number: 1, hello: 'world'}, function (errdoc) {
        if (err) return console.error(err);
        collection.replace(doc, {number: 2}, function (errdoc2) {
            if (err) return console.error(err);
            doc2._id === doc._id;
            doc2._rev !== doc._rev;
            doc2.number === 2;
            doc2.hello === ;
        });
    });
});

Updates (merges) the content of the document with the given documentHandle with the given data.

If opts is set, it must be an object with any of the following properties:

  • waitForSync: Wait until document has been synced to disk. Default: false
  • keepNull: If set to false, properties with a value of null indicate that a property should be deleted. Default: true.
  • mergeObjects: If set to false, object properties that already exist in the old document will be overwritten rather than merged. This does not affect arrays. Default: true.
  • rev: Only update the document if it matches this revision. Optional.
  • policy: Determines the behaviour when the revision is not matched:
  • if policy is set to "last", the document will be replaced regardless of the revision.
  • if policy is set to "error" or not set, the replacement will fail with an error.

The documentHandle can be either the _id or the _key of a document in the collection, or a document (i.e. an object with an _id or _key property).

For more information on the opts object, see the HTTP API documentation for working with documents.

Examples

var db = require('arangojs')();
db.collection('some-collection', function (errcollection) {
    if (err) return console.error(err);
    collection.save({number: 1, hello: 'world'}, function (errdoc) {
        if (err) return console.error(err);
        collection.update(doc, {number: 2}, function (errdoc2) {
            if (err) return console.error(err);
            doc2._id === doc._id;
            doc2._rev !== doc._rev;
            doc2.number === 2;
            doc2.hello === doc.hello;
        });
    });
});

Deletes the document with the given documentHandle from the collection.

If opts is set, it must be an object with any of the following properties:

  • waitForSync: Wait until document has been synced to disk. Default: false
  • rev: Only update the document if it matches this revision. Optional.
  • policy: Determines the behaviour when the revision is not matched:
  • if policy is set to "last", the document will be replaced regardless of the revision.
  • if policy is set to "error" or not set, the replacement will fail with an error.

The documentHandle can be either the _id or the _key of a document in the collection, or a document (i.e. an object with an _id or _key property).

For more information on the opts object, see the HTTP API documentation for working with documents.

Examples

var db = require('arangojs')();
db.collection('some-collection', function (errcollection) {
    if (err) return console.error(err);
    collection.remove('some-doc', function (err) {
        if (err) return console.error(err);
        // document 'some-collection/some-doc' no longer exists 
    });
    // -- or -- 
    collection.remove('some-collection/some-doc', function (err) {
        if (err) return console.error(err);
        // document 'some-collection/some-doc' no longer exists 
    });
});

Retrieves a list of all documents in the collection.

If type is set to "key", the result will be the _key of each document.

If type is set to "path", the result will be the document URI paths.

If type is set to "id" or not set, the result will be the _id of each document.

The DocumentCollection API extends the Collection API (see above) with the following methods.

Retrieves the document with the given documentHandle from the collection.

The documentHandle can be either the _id or the _key of a document in the collection, or a document (i.e. an object with an _id or _key property).

Examples

var db = require('arangojs')();
// assumes a document collection "my-docs" already exists 
db.collection('my-docs', function (errcollection) {
    if (err) return console.error(err);
    collection.document('some-key', function (errdoc) {
        if (err) return console.error(err);
        // the document exists 
        doc._key === 'some-key';
        doc._id === 'my-docs/some-key';
    });
    // -- or -- 
    collection.document('my-docs/some-key', function (errdoc) {
        if (err) return console.error(err);
        // the document exists 
        doc._key === 'some-key';
        doc._id === 'my-docs/some-key';
    });
});

Creates a new document with the given data.

Examples

var db = require('arangojs')();
db.createCollection('my-docs', function (errcollection) {
    if (err) return console.error(err);
    collection.save(
        {some: 'data'},
        function (errdoc) {
            if (err) return console.error(err);
            doc._key; // the document's key 
            doc._id === ('my-docs/' + doc._key);
            doc.some === 'data';
        }
    );
});

The EdgeCollection API extends the Collection API (see above) with the following methods.

Retrieves the edge with the given documentHandle from the collection.

The documentHandle can be either the _id or the _key of an edge in the collection, or an edge (i.e. an object with an _id or _key property).

Examples

var db = require('arangojs')();
// assumes an edge collection "edges" already exists 
db.collection('edges', function (errcollection) {
    if (err) return console.error(err);
    collection.edge('some-key', function (erredge) {
        if (err) return console.error(err);
        // the edge exists 
        edge._key === 'some-key';
        edge._id === 'edges/some-key';
    });
    // -- or -- 
    collection.edge('edges/some-key', function (erredge) {
        if (err) return console.error(err);
        // the edge exists 
        edge._key === 'some-key';
        edge._id === 'edges/some-key';
    });
});

Creates a new edge between the documents fromId and toId with the given data.

Examples

var db = require('arangojs')();
// assumes a collection "vertices" already exists 
db.createEdgeCollection('edges', function (errcollection) {
    if (err) return console.error(err);
    collection.save(
        {some: 'data'},
        'vertices/start-vertex',
        'vertices/end-vertex',
        function (erredge) {
            if (err) return console.error(err);
            edge._key; // the edge's key 
            edge._id === ('edges/' + edge._key);
            edge.some === 'data';
            edge._from === 'vertices/start-vertex';
            edge._to === 'vertices/end-vertex';
        }
    );
});

Retrieves a list of all edges of the document with the given documentHandle.

The documentHandle can be either the _id or the _key of a document in any collection, or a document (i.e. an object with an _id or _key property).

Examples

var db = require('arangojs')();
// assumes a collection "vertices" already exists 
db.createEdgeCollection('edges', function (errcollection) {
    if (err) return console.error(err);
    collection.import([
        ['_key', '_from', '_to'],
        ['x', 'vertices/a', 'vertices/b'],
        ['y', 'vertices/a', 'vertices/c'],
        ['z', 'vertices/d', 'vertices/a']
    ], function (err) {
        if (err) return console.error(err);
        collection.edges('vertices/a', function (erredges) {
            if (err) return console.error(err);
            edges.length === 3;
            edges.map(function (edge) {return edge._key;}); // ['x', 'y', 'z'] 
        });
    });
});

Retrieves a list of all incoming edges of the document with the given documentHandle.

The documentHandle can be either the _id or the _key of a document in any collection, or a document (i.e. an object with an _id or _key property).

Examples

var db = require('arangojs')();
// assumes a collection "vertices" already exists 
db.createEdgeCollection('edges', function (errcollection) {
    if (err) return console.error(err);
    collection.import([
        ['_key', '_from', '_to'],
        ['x', 'vertices/a', 'vertices/b'],
        ['y', 'vertices/a', 'vertices/c'],
        ['z', 'vertices/d', 'vertices/a']
    ], function (err) {
        if (err) return console.error(err);
        collection.inEdges('vertices/a', function (erredges) {
            if (err) return console.error(err);
            edges.lengt