sails-leveldb v0.10.1

Note: This is forked from here: https://github.com/mbinot/sails-leveldb for some minor changes and fixes and publishing to npm

sails-leveldb

Provides easy access to leveldb from Sails.js & Waterline.

This sails-leveldb stores indexes of unique attributes for relatively fast lookups. Collections with multiple unique constraints are supported as well.

Warning! This adapter will probably slow down on a high number of records.

Installation

To install this adapter, run:

$ npm install sails-leveldb

Usage

This adapter exposes the following methods:

Methods

- registerConnection
- teardown
- describe
- define
- drop
- find
- create
- update
- destroy

Configuration

The following connection configuration is available:

// default values inline
config: {
  database: 'path to the db file',
  options: {
  }
};

options

The underlying levelup() driver takes an optional options object; the following properties are accepted:

• 'createIfMissing' (boolean, default: true): If true, will initialise an empty database at the specified location if one doesn't already exist. If false and a database doesn't exist you will receive an error in your open() callback and your database won't open.

• 'errorIfExists' (boolean, default: false): If true, you will receive an error in your open() callback if the database exists at the specified location.

• 'compression' (boolean, default: true): If true, all compressible data will be run through the Snappy compression algorithm before being stored. Snappy is very fast and shouldn't gain much speed by disabling so leave this on unless you have good reason to turn it off.

• 'cacheSize' (number, default: `8 1024 1024`): The size (in bytes) of the in-memory LRU cache with frequently used uncompressed block contents.

• 'keyEncoding' and 'valueEncoding' (string, default: 'utf8'): The encoding of the keys and values passed through Node.js' Buffer implementation (see Buffer#toString()).

License

MIT © 2014 balderdashy & contributors(http://michaelmcneil.com), Balderdash & contributors

Sails is free and open-source under the MIT License.