node package manager


A Promise/A+ Based Object Relational Mapping Module With Cache(Memcached/Redis) Enabled For Mysql/PostgreSQL/more. [under development]

A Simple ORM Module

[] Improve cache system. [] Rewrite inner code with promise and simplify it.

Install: npm install dbcover

Common Usage (in coffeescript):

{ObserveModelValidators}   = require 'dbcover'
# Require whatever validator you need. 
# List of validators: integer, string, email, required 
# Define database connection 
Observe.define 'repo',
  name: 'default'
    type: 'mysql'
      host: 'localhost'
      port: 3306
      password: '123123'
      user: 'root'
      database: 'test'
Observe.define 'repo',
  name: 'pg'
    type: 'postgresql'
      host: 'localhost'
      port: 3306
      password: '123123'
      user: 'root'
      database: 'test'
Observe.define 'cache',
  name: 'default'
    type: 'redis'
      host: 'localhost'
      port: 6379
# Define an model 
User = new Model
    table: 'users'
    repo: 'pg'   # default repo name is 'default' 
    cache: 'default' # leave meta.cache blank or set it false to disable caching 
    ttl: 10  # cache expire time(seconds), must be set if cache is enabled for this model. if ttl < 1, then no expire time would be applied. 
    fields: [
      # set auto to true to support auto increment columns 
      {name: 'id'type: 'integer'auto: trueprimkey: trueuniq: true}
      {name: 'email',   type: 'string'validator: 'email'primkey: trueuniq: true}
      {name: 'random_key'type: 'string'primkey: true}
      {name: 'age',     type: 'integer'validator: new Validators.integer(10100)}
      {name: 'extra',   type: 'json'}
      {name: 'created'type: 'timestamp'}
    # primkey(s) with one or more columns. remember to use the name you definded above, not the real column name. 
    indices: [
      {name: 'pk'fields: ['email''age']}
  sayHi: () ->
    console.log 'hi'
  rename: (name, id)->
    deferred = Q.defer()
    raw_sql = "UPDATE #{@$table} SET name = ?, updated_at='#{new Date}' WHERE id = ?"
    # You may use @$repo.query to make customized queries. 
    # Use ? or :var instead of raw variables to avoid SQL injection. 
    @$repo.query raw_sql[nameid](err, result)->
      deferred.reject err if err?
      deferred.resolve result
    return deferred.promise
# Turn on debug, default is false 
# Creating instance 
user =
  userId: 23
  email: ''
  age: 22
# Save instance  
promise =
# Updating attributes  
user.age = 23
user.extra = { nick: 'rankjie' }
promise = user.update()
# Deleting instance  
promise = user.delete()
# Count rows 
promise = user.count()
# Count rows with WHERE age > 30 
promise = user.count("age > 30")
# Query  
# All promises returned by Query or findBy, will be resolved with a set of instances ( first() and findByIndeices which has `uniq:true` will return just one object ) 
# Or, rejected with errors. 
promise = User.findById(123)
# You can append '__gt' or '__lt' to the field name, that would equals to '>' and '<' 
promise = User.find(age: 30created__gt: 2334343).first()
promise = User.find(age__lt: 30created: 2334343).first()
# Get all the entries 
promise = User.find(age: 30).all()
# Find by primkeys  
promise = User.findByPk(userID: 234age: 99)
# prim keys like random_key will be transformed to camel case like RandomKey 
promise = User.findByRandomKey('someValue')
# list all the data 
promise = User.find()
# list from 0 to 10 
promise = User.find('age > ? and created > ?'[30234242])
# get them all 
promise = User.find('age > :age and created > :created')
  .set(age: 30created: 1234324234)
# get the first one 
promise = User.find('age > :age and created > :created')
  .set(age: 30created: 1234324234)