11 KiB
About
JugglingDB(3) is cross-db ORM for nodejs, providing common interface to access most popular database formats. Currently supported are: mysql, sqlite3, postgres, couchdb, mongodb, redis, neo4j and js-memory-storage (yep, self-written engine for test-usage only). You can add your favorite database adapter, checkout one of the existing adapters to learn how, it's super-easy, I guarantee.
Jugglingdb also works on client-side (using WebService and Memory adapters), which allows to write rich client-side apps talking to server using JSON API.
Installation
npm install jugglingdb
plus you should install appropriated adapter, for example for redis:
npm install jugglingdb-redis
check following list of available adapters
JugglingDB adapters
<!-- MongoDB -->
<tr>
<td><a href="http://www.mongodb.org"><img src="http://mongodb.ru/favicon.ico" alt="MongoDB" /></a> MongoDB</td>
<td><a href="https://github.com/jugglingdb/mongodb-adapter">jugglingdb/mongodb-adapter</a></td>
<td><a href="https://github.com/anatoliychakkaev">Anatoliy Chakkaev</a></td>
<td><a href="https://travis-ci.org/jugglingdb/mongodb-adapter"><img src="https://travis-ci.org/jugglingdb/mongodb-adapter.png?branch=master" alt="Build Status" /></a></td>
</tr>
<!-- MySQL -->
<tr>
<td><a href="http://www.mysql.com/"><img src="https://github.com/1602/jugglingdb/raw/master/media/mysql.ico" style="vertical-align:middle"" alt="MySQL" /></a> MySQL</td>
<td><a href="https://github.com/jugglingdb/mysql-adapter">jugglingdb/mysql</a></td>
<td><a href="https://github.com/dgsan">dgsan</a></td>
<td><a href="https://travis-ci.org/jugglingdb/mysql-adapter"><img src="https://travis-ci.org/jugglingdb/mysql-adapter.png?branch=master" alt="Build Status" /></a></td>
</tr>
<!-- CouchDB / nano -->
<tr>
<td><a href="http://couchdb.apache.org/"><img width="16" src="http://couchdb.apache.org/favicon.ico" style="vertical-align:middle"" alt="CouchDB" /></a> CouchDB / nano</td>
<td><a href="https://github.com/jugglingdb/nano-adapter">jugglingdb/nano-adapter</a></td>
<td><a href="https://github.com/nrw">Nicholas Westlake</a></td>
<td><a href="https://travis-ci.org/jugglingdb/nano-adapter"><img src="https://travis-ci.org/jugglingdb/nano-adapter.png?branch=master" alt="Build Status" /></a></td>
</tr>
<!-- PostgreSQL -->
<tr>
<td><a href="http://www.postgresql.org/"><img src="http://www.postgresql.org/favicon.ico" style="vertical-align:middle"" alt="PostgreSQL" /></a> PostgreSQL</td>
<td><a href="https://github.com/jugglingdb/postgres-adapter">jugglingdb/postgres-adapter</a></td>
<td><a href="https://github.com/anatoliychakkaev">Anatoliy Chakkaev</a></td>
<td><a href="https://travis-ci.org/jugglingdb/postgres-adapter"><img src="https://travis-ci.org/jugglingdb/postgres-adapter.png?branch=master" alt="Build Status" /></a></td>
</tr>
<!-- Redis -->
<tr>
<td><a href="http://redis.io/"><img src="http://redis.io/images/favicon.png" alt="Redis" /></a> Redis</td>
<td><a href="https://github.com/jugglingdb/redis-adapter">jugglingdb-redis</a></td>
<td><a href="https://github.com/anatoliychakkaev">Anatoliy Chakkaev</a></td>
<td><a href="https://travis-ci.org/jugglingdb/redis-adapter"><img src="https://travis-ci.org/jugglingdb/redis-adapter.png?branch=master" alt="Build Status" /></a></td>
</tr>
<!-- SQLite -->
<tr>
<td><a href="http://www.sqlite.org/"><img width="16" src="https://github.com/1602/jugglingdb/raw/master/media/sqlite.png" style="vertical-align:middle"" alt="SQLite" /></a> SQLite</td>
<td><a href="https://github.com/jugglingdb/sqlite3-adapter">jugglingdb/sqlite3-adapter</a></td>
<td><a href="https://github.com/anatoliychakkaev">Anatoliy Chakkaev</a></td>
<td><a href="https://travis-ci.org/jugglingdb/sqlite3-adapter"><img src="https://travis-ci.org/jugglingdb/sqlite3-adapter.png?branch=master" alt="Build Status" /></a></td>
</tr>
<tr>
<td>WebService</td>
<td>built-in</td>
<td><a href="https://github.com/anatoliychakkaev">Anatoliy Chakkaev</a></td>
<td>n/a</td>
</tr>
<tr>
<td>Memory (bogus)</td>
<td>built-in</td>
<td><a href="https://github.com/anatoliychakkaev">Anatoliy Chakkaev</a></td>
<td>n/a</td>
</tr>
<tr>
<td>Neo4j</td>
<td>built-in <i>TODO: move</i></td>
<td><a href="https://github.com/anatoliychakkaev"><strike>Anatoliy Chakkaev</strike></a> <u>/!\</u> Looking for
maintainer</td>
<td>n/a</td>
</tr>
Database type | Package name | Maintainer | Build status |
---|---|---|---|
Firebird | jugglingdb-firebird | Henri Gourvest |
Participation
- Check status of project on trello board: https://trello.com/board/jugglingdb/4f0a0b1e27d3103c64288388
- Make sure all tests pass (
npm test
command) - Feel free to vote and comment on cards (tickets/issues), if you want to join team -- send me a message with your email.
If you want to create your own jugglingdb adapter, you should publish your
adapter package with name jugglingdb-ADAPTERNAME
. Creating adapter is simple,
check jugglingdb/redis-adapter for example. JugglingDB core
exports common tests each adapter should pass, you could create your adapter in
TDD style, check that adapter pass all tests defined in test/common_test.js
.
Usage
var Schema = require('jugglingdb').Schema;
var schema = new Schema('redis', {port: 6379}); //port number depends on your configuration
// define models
var Post = schema.define('Post', {
title: { type: String, length: 255 },
content: { type: Schema.Text },
date: { type: Date, default: function () { return new Date;} },
timestamp: { type: Number, default: Date.now },
published: { type: Boolean, default: false, index: true }
});
// simplier way to describe model
var User = schema.define('User', {
name: String,
bio: Schema.Text,
approved: Boolean,
joinedAt: Date,
age: Number
}, {
restPath: '/users' // tell WebService adapter which path use as API endpoint
});
// define any custom method
User.prototype.getNameAndAge = function () {
return this.name + ', ' + this.age;
};
// models also accessible in schema:
schema.models.User;
schema.models.Post;
// setup relationships
User.hasMany(Post, {as: 'posts', foreignKey: 'userId'});
// creates instance methods:
// user.posts(conds)
// user.posts.build(data) // like new Post({userId: user.id});
// user.posts.create(data) // build and save
Post.belongsTo(User, {as: 'author', foreignKey: 'userId'});
// creates instance methods:
// post.author(callback) -- getter when called with function
// post.author() -- sync getter when called without params
// post.author(user) -- setter when called with object
schema.automigrate(); // required only for mysql NOTE: it will drop User and Post tables
// work with models:
var user = new User;
user.save(function (err) {
var post = user.posts.build({title: 'Hello world'});
post.save(console.log);
});
// or just call it as function (with the same result):
var user = User();
user.save(...);
// Common API methods
// just instantiate model
new Post
// save model (of course async)
Post.create(cb);
// all posts
Post.all(cb)
// all posts by user
Post.all({where: {userId: user.id}, order: 'id', limit: 10, skip: 20});
// the same as prev
user.posts(cb)
// get one latest post
Post.findOne({where: {published: true}, order: 'date DESC'}, cb);
// same as new Post({userId: user.id});
user.posts.build
// save as Post.create({userId: user.id}, cb);
user.posts.create(cb)
// find instance by id
User.find(1, cb)
// count instances
User.count([conditions, ]cb)
// destroy instance
user.destroy(cb);
// destroy all instances
User.destroyAll(cb);
// Setup validations
User.validatesPresenceOf('name', 'email')
User.validatesLengthOf('password', {min: 5, message: {min: 'Password is too short'}});
User.validatesInclusionOf('gender', {in: ['male', 'female']});
User.validatesExclusionOf('domain', {in: ['www', 'billing', 'admin']});
User.validatesNumericalityOf('age', {int: true});
User.validatesUniquenessOf('email', {message: 'email is not unique'});
user.isValid(function (valid) {
if (!valid) {
user.errors // hash of errors {attr: [errmessage, errmessage, ...], attr: ...}
}
})
Callbacks
The following callbacks supported:
- afterInitialize
- beforeCreate
- afterCreate
- beforeSave
- afterSave
- beforeUpdate
- afterUpdate
- beforeDestroy
- afterDestroy
- beforeValidate
- afterValidate
Each callback is class method of the model, it should accept single argument: next
, this is callback which
should be called after end of the hook. Except afterInitialize
because this method is syncronous (called after new Model
).
Object lifecycle:
var user = new User;
// afterInitialize
user.save(callback); // If Model.id isn't set, save will invoke Model.create() instead
// beforeValidate
// afterValidate
// beforeSave
// beforeUpdate
// afterUpdate
// afterSave
// callback
user.updateAttribute('email', 'email@example.com', callback);
// beforeValidate
// afterValidate
// beforeSave
// beforeUpdate
// afterUpdate
// afterSave
// callback
user.destroy(callback);
// beforeDestroy
// afterDestroy
// callback
User.create(data, callback);
// beforeValidate
// afterValidate
// beforeCreate
// beforeSave
// afterSave
// afterCreate
// callback
Read the tests for usage examples: ./test/common_test.js Validations: ./test/validations.test.js
Your own database adapter
To use custom adapter, pass it's package name as first argument to Schema
constructor:
var mySchema = new Schema('mycouch', {host:.., port:...});
In that case your adapter should be named as 'jugglingdb-mycouch' npm package.
Testing
Core of jugglingdb tests only basic features (database-agnostic) like
validations, hooks and runs db-specific tests using memory storage. It also
exports complete bucket of tests for external running. Each adapter should run
this bucket (example from jugglingdb-redis
):
var jdb = require('jugglingdb'),
Schema = jdb.Schema,
test = jdb.test;
var schema = new Schema(__dirname + '/..', {host: 'localhost', database: 1});
test(module.exports, schema);
Each adapter could add specific tests to standart bucket:
test.it('should do something special', function (test) {
test.done();
});
Or it could tell core to skip some test from bucket:
test.skip('name of test case');
To run tests use this command:
npm test
Before running make sure you've installed package (npm install
) and if you
running some specific adapter tests, ensure you've configured database
correctly (host, port, username, password).
Contributing
If you have found a bug please write unit test, and make sure all other tests still pass before pushing code to repo.
License
MIT