feathers-arangodb

A Feathers database adapter for ArangoDB using official NodeJS driver for ArangoDB.

$ npm install --save arangojs @bcc-code/feathers-arangodb

Important: @bcc-code/feathers-arangodb implements the Feathers Common database adapter API and querying syntax.

This adapter also requires a running ArangoDB database server.

Test the adapter

$ npm run test

Database Options

id (optional) : String : Translated ID key value in payloads. Actual storage in database is saved in the _key key/value within ArangoDB. Defaults to _key

expandData (optional) : Boolean : Adapter filters out _rev and _id from ArangoDB. Setting expandData to true will include these in the payload results. Defaults to false

collection (required) : Collection | String : Either a string name of a collection, which will be created if it doesn't exist in database, or a reference to an existing arangoDB collection object.

view (optional) : View | String : Either a string name of a view, which will be created if it doesn't exist in database, or a reference to an existing arangoDB view object.

database (required) : Database | String : Either a string name of a database, which will be created if it doesn't exist on the ArangoDB server, or a reference to an existing ArangoDB database object.

graph (optional) : Graph | { properties, opts } : Graph options to create a new graph. name is required in the properties. See Documentation

authType (optional) : String : String value of either BASIC_AUTH or BEARER_AUTH. Used to define the type of auth to ArangoDB (see documentation). Defaults to BASIC_AUTH

username (optional) : String : Used for auth, plaintext username

password (optional) : String : Used for auth, plaintext password

token (optional) : String : If token is supplied, auth uses token instead of username/password.

dbConfig (optional) : ArangoDbConfig : ArangoDB Config file for a new database. See Documentation

events (optional) : Array : FeathersJS Events - See Documentation

paginate (optional) : FeathersJS Paginate : FeathersJS Paginate - See Documentation

Copyright (c) 2018

Licensed under the MIT license.