cormo

About

CORMO is an ORM framework for Node.js.

Currently supports:

• multi-DB: MySQL, MongoDB, SQLite3, PostgreSQL
• constraints
• validations
• associations
• geospatial query
• callbacks
• aggregation
• nested column

See https://github.com/croquiscom/cormo/wiki/Future-Plans for future plans.

Overview

You can see detail guides on http://croquiscom.github.io/cormo/.

Define models

cormo = require 'cormo'
connection = new cormo.Connection 'mysql', database: 'test'

# this will create two tables - users, posts - in the database.

class User extends cormo.Model
  @column 'name', type: String
  @column 'age', type: cormo.types.Integer

class Post extends cormo.Model
  @column 'title', String # `String` is the same as `type: String`
  @column 'body', 'string' # you can also use `string` to specify a string type
  @column 'date', Date

var cormo = require('cormo');
var connection = new cormo.Connection('mysql', { database: 'test' });

// this will create two tables - users, posts - in the database.

var User = connection.model('User', {
  name: { type: String },
  age: { type: cormo.types.Integer }
});

var Post = connection.model('Post', {
  title: String, // `String` is the same as `type: String`
  body: 'string', // you can also use `string` to specify a string type
  date: Date
});

Create records

user1 = new User name: 'John Doe', age: 27
user1.save (error) ->
  console.log error

User.create name: 'John Doe', age: 27, (error, user2) ->
  console.log error

var user1 = new User({name: 'John Doe', age: 27});
user1.save(function (error) {
  console.log(error);
});

User.create({name: 'John Doe', age: 27}, function (error, user2) {
  console.log(error);
});

Retreive records

User.find 1, (error, user) ->

User.where name: 'John Doe', (error, users) ->

User.where(age: 27)
.select('name')
.order('name')
.limit(5)
.skip(100)
.exec (error, users) ->

User.where($or: [ { age: $lt: 20 }, { age: $gt: 60 } ])
.where(name: $contains: 'smi')
.exec (error, users) ->

User.find(1, function (error, user) {
});

User.where({name: 'John Doe'}, function (error, users) {
});

User.where({age: 27})
.select('name')
.order('name')
.limit(5)
.skip(100)
.exec(function (error, users) {
});

User.where({$or: [ { age: { $lt: 20 } }, { age: { $gt: 60 } } ]})
.where({name: { $contains: 'smi' }})
.exec(function (error, users) {
});

Count records

User.count (error, count) ->

User.count age: 27, (error, count) ->

User.count(function (error, count) {
});

User.count({age: 27}, function (error, count) {
});

Update records

User.find 1, (error, user) ->
  user.age = 30
  user.save (error) ->

User.find(1).update age: 10, (error, count) ->

User.where(age: 27).update age:10, (error, count) ->

User.find(1, function (error, user) {
  user.age = 30;
  user.save(function (error) {
  });
});

User.find(1).update({age: 10}, function (error, count) {
});

User.where({age: 27}).update({age:10}, function (error, count) {
});

Delete records

User.delete age: 27, (error, count) ->

User.delete({age: 27}, function (error, count) {
});

Constraint

class User extends cormo.Model
  @column 'name', type: String, required: true
  @column 'age', type: Number, required: true
  @column 'email', type: String, unique: true, required: true

var User = connection.model('User', {
  name: { type: String, required: true },
  age: { type: Number, required: true },
  email: { type: String, unique: true, required: true }
});

Validation

class User extends cormo.Model
  @column 'name', String
  @column 'age', Number
  @column 'email', String

  @addValidator (record) ->
    if record.age < 18
      return 'too young'

var User = connection.model('User', {
  name: String,
  age: Number,
  email: String
});

User.addValidator(function (record) {
  if (record.age<18) {
    return 'too young';
  }
});

Callbacks

class User extends cormo.Model
  @column 'name', String
  @column 'age', Number

  @beforeSave ->
    @name = @name.trim()

var User = connection.model('User', {
  name: String,
  age: Number
});

User.beforeSave(function () {
  this.name = this.name.trim();
});

Associations

class User extends cormo.Model
  @column 'name', String
  @column 'age', Number
  @hasMany 'posts'

class Post extends cormo.Model
  @column 'title', String
  @column 'body', String
  @belongsTo 'user'

var User = connection.model('User', {
  name: String,
  age: Number
});

var Post = connection.model('Post', {
  title: String,
  body: String
});

User.hasMany(Post);
Post.belongsTo(User);

Aggregation

Order.where price: $lt: 10
.group null, count: {$sum: 1}, total: {$sum: '$price'}
.order 'total'
.exec (error, records) ->

Order.group 'customer', min_price: { $min: '$price' }, max_price: { $max: '$price' }
.exec (error, records) ->

Order.where({price: {$lt: 10}})
.group(null, {count: {$sum: 1}, total: {$sum: '$price'}})
.order('total')
.exec(function (error, records) {
});

Order.group('customer', {min_price: {$min: '$price'}, max_price: {$max: '$price'}})
.exec(function (error, records) {
});

Geospatial query

class Place extends cormo.Model
  @column 'name', String
  @column 'location', cormo.types.GeoPoint

# create
Place.create name: 'Carrier Dome', location: [-76.136131, 43.036240]

# query
Place.query().near(location: [-5, 45]).limit(4).exec (error, places) ->
  console.log places

var Place = connection.model('Place', {
  name: String,
  location: cormo.types.GeoPoint
});

// create
Place.create({name: 'Carrier Dome', location: [-76.136131, 43.036240]});

// query
Place.query().near({location: [-5, 45]}).limit(4).exec(function (error, places) {
  console.log(places);
});

License

The MIT License (MIT)

Copyright (c) 2012-2014 Sangmin Yoon <[e-mail]>

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.