Seed Filestore

This module provides a storage addon for Seed that allows for datasets to be stored in JSON files.

Installation

Module is available through npm. To use it in your project you must also have seed installed, as it is not provided as package.json requirement.

  npm install seed seed-filestore

What is Seed?

Seed, which stands for storage-agnostic, event emitting datasets, is a library of components that provide a common API for working with data, no matter the source. These compoents are Hash, Model, Graph, and Schema. Redis can be one the many sources used in the construction eventful, data-centric applications.

Visit the Seed project page to learn more.

Usage

This storage engine can be used for both models and collections.

var Seed = require('seed')
  , RedisStore = require('seed-filestore')
  , dir = require('path').join(__dirname, 'data')
  , store = new FileStore(dir);

var Person = Seed.Model.extend('person', {
  store: store
});

var arthur = new Person({
    id: 'arthur'
  , name: 'Arthur Dent'
  , occupation: 'Traveller'
});

arthur.save(function (err) {
  if (err) return console.error(err);
  console.log('Arthur has been saved!');
});

Querying

In short, 'querying' takes place in-process.

When fetching from a Graph, seed-filestore will load all documents of the requested type into memory then filter the result-set given a provided query. Queries must be written in using seed's included query language (which is very similiar to MongoDb's query style). For more information on constructing well-formed queries, check out Seed's documentation on query language.

var HitchhikersGuide = Seed.Graph.extend({
    store: store
  , initialize: function () {
      this.define(Person);
    }
});

var myGuide = new HitchhikersGuide();
myGuide.fetch('person', { 'name': 'Arthur Dent' }, function (err) {
  var arthur = self.get('/person/arthur');
});

Tests

Tests are writting in Mocha using the Chai should BDD assertion library. Make sure you have that installed, clone this repo, install dependacies using npm install.

$ make test

Getting Help

All issues related to this project should be posted in seed-filestore GitHub Issues. For all general seed related issues, please visit seed's GitHub Issues. There is also a community forum is available at the Seed Google Group.

Contributors

Interested in contributing? Fork to get started. Contact @logicalparadox if you are interested in being regular contributor.

• Jake Luer (@logicalparadox)

License

(The MIT License)

Copyright (c) 2012 Jake Luer

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.