FaunaDB Javascript Driver

A Javascript driver for FaunaDB.

View reference JSDocs here.

See the FaunaDB Documentation and Tutorials for guides and a complete database API reference.

Supported Runtimes

This Driver supports and is tested on:

Node.js
- LTS (v4)
- Stable (v6)
- v0.12.x
Chrome
Firefox
Safari
Internet Explorer 11

Using the Client

Installation

Node.js

npm install --save faunadb

See faunadb on NPM for more information.

Browsers

The browser release can be found in the fauna/faunadb-js-release repository.

This release can be installed via bower:

bower install faunadb

Or via CDN:

<script src="//cdn.jsdelivr.net/faunadb/2.5/faunadb.js"></script>

The minified version of the driver can also be used via CDN:

<script src="//cdn.jsdelivr.net/faunadb/2.5/faunadb-min.js"></script>

Use

The tutorials in the FaunaDB documentation contain driver-specific examples.

Requiring the Driver

var faunadb = require('faunadb'),
  q = faunadb.query;

This is the recommended require stanza. The faunadb.query module contains all of the functions to create FaunaDB Query expressions.

Instantiating a Client and Issuing Queries

var client = new faunadb.Client({ secret: 'YOUR_FAUNADB_SECRET' });

Once the client has been instantiated, it can be used to issue queries. For example, to create an instance in an existing class named test with the data: { testField: 'testValue' }:

var createP = client.query(q.Create(q.Class('test'), { testField: 'testValue' }));

All methods on faunadb.Client return ES6 Promises. So, if we wanted to handle the Promise to access the Ref of the newly created instance:

createP.then(function(response) {
  console.log(response.ref); // Would log the ref to console.
});

response is a JSON object containing the FaunaDB response. See the JSDocs for faunadb.Client, and the FaunaDB Developer Guide for more information on responses.

Pagination Helpers

This driver contains helpers to provide a simpler API for consuming paged responses from FaunaDB. See the FaunaDB Developer Guide and the Paginate Function Reference for a description of paged responses.

Using the helper to page over sets lets the driver handle cursoring and pagination state. For example, client.paginate:

var helper = client.paginate(q.Match(q.Index('test_index'), 'example-term'));

The return value, helper, is an instance of PageHelper. The each method will execute a callback function on each consumed page.

helper.each(function(page) {
  console.log(page); // Will log the page's contents, for example: [ Ref("classes/test/1234"), ... ]
});

Note that each returns a Promise<void> that is fulfilled on the completion of pagination.

The pagination can be transformed server-side via the FaunaDB query language via the map and filter functions.

For example, to retrieve the matched instances:

helper.map(function(ref) { return q.Get(ref); }).each(function(page) {
  console.log(page); // Will now log the retrieved instances.
});

See the JSDocs for more information on the pagination helper.

Client Development

Run npm install to install dependencies.

Code

As the driver targets multiple JS runtimes, it is developed in vanilla ES5. We use the es6-promise polyfill in order to provide Promise support.

Testing

npm run test: This will run tests against the current version of Node.js. nvm is useful for managing multiple versions of Node.js for testing.
npm run coverage: This will run tests with coverage enabled.
npm run browser-test-{mac|linux|win}: This will run tests against platform-specific browsers. Karma is used as the test runner.

Both Node.js and browser tests will read a testConfig.json file located in the root directory of this project for Fauna client configuration. A minimal testConfig.json file would contain your FaunaDB key:

{ "auth": "YOUR_FAUNA_KEY" }

Each test run will create a new database, and will attempt to clean it up when done. If the tests are cancelled, the test database will not get cleaned up. Therefore it is recommended to use a FaunaDB key scoped to an empty parent database created for this purpose, rather than your account's root key. This will make cleanup of test databases as easy as removing the parent database.

See the FaunaDB Multitenancy Tutorial for more information about nested databases.

Alternatively, tests can be run via a Docker container with FAUNA_ROOT_KEY="your-cloud-secret" make docker-test (an alternate Alpine-based NodeJS image can be provided via RUNTIME_IMAGE).

Documentation

npm run doc will generate JSDoc documentation for the project.

License

Licensed under the Mozilla Public License, Version 2.0 (the "License"); you may not use this software except in compliance with the License. You may obtain a copy of the License at

http://mozilla.org/MPL/2.0/

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

mcastre / faunadb-js