Morm NPM | npm.io

morm

A lightweight SQL ORM for node.js. Currently supports MSSQL and SqlLite3

Well I use the term ORM loosely, it's currently more of a facade which makes interacting with MSSQL from node a little less painful. More ORM features are coming soon - but for now check the tests for implemented stuff.

WARNING: This module is far from complete, i'd probably not use it if I were you. However if you do use it, please feel free to submit issues or even contribute yourself.

TODO

Need to improve how I return the identity from an insert statement in SQL.. it all feels a bit hacky right now and I should be using @@IDENTITY instead - just makes it harder to test as sql lite doesnt support that. But hey, it works.
One to Many / Many to Many relationships etc.
Change the way we're using sqlite for the tests - as we're not actually testing lib/dal in any way.

Getting Started

npm install morm

Documentation

See the tests for currently implemented stuff.

Examples

ORM Operations

Insert a row into a table: After it's been inserted it is being "tracked" and you can subsequently modify it and re-save and an update will be performed.

var morm = require('morm');
var config = {
  user: 'example_user',
  password: 'example_user_password',
  server: '127.0.0.1',
  database: 'example_database'
};
var dal = new morm.Dal(config);

// Or if you're using Sql Azure:
var config = {
  user: 'example_user',
  password: 'example_user_password',
  server: '127.0.0.1',
  database: 'example_database',
  options: {
    encrypt: true
  }
};
var dal = new morm.Dal(config);

// Or if you're using SqlLite3
var dal = new morm.Dal(':memory:', 'sqlite3');

var model = new morm.Model({
  table: 'example_table',
  identity: 'id',
  dal: dal
});

var row1 = model.create({
  column1: 'col1',
  column2: 'col2'
});

model.save()
.then(function() {
  console.log(row1.id);
});

This would allow you to update an existing object without first reading it from the database.

var model = new morm.Model({
  table: 'example_table',
  identity: 'id',
  dal: dal
});

model.create({
  id: 1,
  column1: 'col1',
  column2: 'col2'
}, {
  existing: true
});

model.save();

This will allow you to read a bunch of objects and return tracked instances of them which can be modified and updated. Please note the syntax here is using squel https://github.com/hiddentao/squel as that's what i'm using under the hood to generate the SQL.

var model = new morm.Model({
  table: 'example_table',
  identity: 'id',
  dal: dal
});
model.select()
  .where('id > 1')
  .where('id < 10')
  .go()
  .then(function(results) {
    console.log(results);
  });

This will allow you to delete a bunch of objects.

var model = new morm.Model({
  table: 'example_table',
  identity: 'id',
  dal: dal
});
model.delete()
  .where('id > 1')
  .where('id < 10')
  .go()
  .then(function() {
    console.log('done!');
  });

Bulk Operations

This will allow you to do a bulk insert of rows rather than individual update statements.
NOTE: By doing this you'll skip the post insert ID lookup which means you wont have tracking of these objects - but obviously its a lot faster.

var model = new morm.Model({
  table: 'example_table',
  identity: 'id',
  dal: dal
});

model.create({
  column1: 'col1',
  column2: 'col2'
});

model.create({
  column1: 'col1',
  column2: 'col2'
});

model.save({ bulk: true });

This will allow you to return a raw list of objects, untracked (ie no meta data attached).

var model = new morm.Model({
  table: 'example_table',
  identity: 'id',
  dal: dal
});

model.select({ bulk: true })
  .where('id > 1')
  .where('id < 10')
.then(function(results) {
  console.log(results);
});

Contributing

In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using Grunt.

Release History

0.1.0 Stuck onto NPM just to get the ball rolling
0.1.1 Fixed an issue with updates
0.1.2 Huge fixes with the promises for sync operation of the insert and update tasks.
0.1.3 Implemented the mssql last inserted id lookup, starting to become an orm...
0.1.4 Implemented bulk inserts
0.1.5 Cleaning up and performance improvements in the model.
0.1.6 Added read and delete.
0.1.8 Bug fixes.
0.1.9 Added bulk reads.
0.1.10 Bug fixes.
0.1.11 Bulk inserted items are removed from tracking array.
0.1.12 Enabled Sqlite3 as a valid Dal