verdnatura-mirror
/
loopback-datasource-juggler
mirror of https://github.com/loopbackio/loopback-datasource-juggler
0
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'master' of github.com:1602/jugglingdb

This commit is contained in:
Anatoliy Chakkaev 2012-10-22 00:15:05 +04:00
parent 47bd310c92 52b830de40
commit 9332dc0473
1 changed files with 7 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
README.md
View File

@ -1,6 +1,6 @@
## About [<img src="https://secure.travis-ci.org/1602/jugglingdb.png" />](http://travis-ci.org/#!/1602/jugglingdb) ## About [<img src="https://secure.travis-ci.org/1602/jugglingdb.png" />](http://travis-ci.org/#!/1602/jugglingdb)
JugglingDB is cross-db ORM, providing **common interface** to access most popular database formats. JugglingDB is cross-db ORM for nodejs, providing **common interface** to access most popular database formats.
Currently supported are: mysql, mongodb, redis, neo4j and js-memory-storage (yep, Currently supported are: mysql, 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 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. existing adapters to learn how, it's super-easy, I guarantee.
@ -11,13 +11,14 @@ existing adapters to learn how, it's super-easy, I guarantee.
## Participation ## Participation
Check status of project on trello board: https://trello.com/board/jugglingdb/4f0a0b1e27d3103c64288388 - Check status of project on trello board: https://trello.com/board/jugglingdb/4f0a0b1e27d3103c64288388
Feel free to vote and comment on cards (tickets/issues), if you want to join team -- send me a message with your email. - 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.
## Usage ## Usage
```javascript ```javascript
var Schema = require('./jugglingdb').Schema; var Schema = require('jugglingdb').Schema;
var schema = new Schema('redis2', {port: 6379}); //port number depends on your configuration var schema = new Schema('redis2', {port: 6379}); //port number depends on your configuration
// define models // define models
var Post = schema.define('Post', { var Post = schema.define('Post', {
@ -167,9 +168,9 @@ Make sure, your adapter can be required (just put it into ./node_modules):
## Running tests ## Running tests
All tests are written using nodeunit: To run all tests (requires all databases):
nodeunit test/common_test.js npm test
If you run this line, of course it will fall, because it requres different databases to be up and running, If you run this line, of course it will fall, because it requres different databases to be up and running,
but you can use js-memory-engine out of box! Specify ONLY env var: but you can use js-memory-engine out of box! Specify ONLY env var:
@ -188,25 +189,6 @@ Now all common logic described in `./lib/*.js`, and database-specific stuff in `
If you have found a bug please write unit test, and make sure all other tests still pass before pushing code to repo. If you have found a bug please write unit test, and make sure all other tests still pass before pushing code to repo.
## Roadmap
### Common:
+ transparent interface to APIs
+ -before and -after hooks on save, update, destroy
+ scopes
+ default values
+ more relationships stuff
+ docs
### Databases:
+ riak
+ couchdb
+ low-level mysql
+ postgres
+ sqlite
## License ## License
MIT MIT