Formalize

Formalize is a node.js ActiveRecord ORM layer for FoundationDB.

This module is still early alpha and work is in progress. All contributions are welcome.

Example Usage

Transactional

var Formalize = require('formalize');

Formalize('MyDatabase', function (provider) {
  var options = {
    schema: {
      firstName: 'f',
      lastName: 'l'
    }
  };

  provider.ActiveRecord('People', options, function (Person) {
    var p = new Person();
    p.firstName = 'Ashley';
    p.lastName = 'Brener';

    function transaction(tr, callback) {
      p.save(tr, function (err) {
        if (err) {
          console.error(err);
        }
        else {
          Person.all(tr, callback);
        }
      });
    }

    function complete(err, people) {
      if (!err) {
        console.log(people);
      }
    }

    provider.db.doTransaction(transaction, complete);
  });
});

Non-Transactional

var Formalize = require('formalize');

Formalize('MyDatabase', function (provider) {
  var options = {
    schema: {
      firstName: 'f',
      lastName: 'l'
    }
  };

  provider.ActiveRecord('People', options, functions (Person) {
    var p = new Person();
    p.firstName = 'Ashley';
    p.lastName = 'Brener';

    p.save(function (err) {
      if (err) {
        console.error(err);
      }
      else {
        Person.all(function (err, people) {
          if (!err) {
            console.log(people);
          }
        });
      }
    });
  });
});

Installation

npm install formalize

License

(The MIT License)

Copyright (c) frisB.com <[email protected]>

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.