1. JugglingDB(3)
  2. JugglingDB
  3. JugglingDB(3)

NAME

JugglingDB - cross-database ORM for nodejs and browser

DESCRIPTION

JugglingDB 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 in-memory-storage.

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

Use npm to install core package:

npm install jugglingdb --save

Alternatively you can install jugglingdb core from github:

npm install 1602/jugglingdb

Then install adapter for specific database, for example jugglingdb-redis:

npm install jugglingdb-redis

See jugglingdb-adapters(3) for list of available adapters.

DOCUMENTATION

Autogenerated documentation available at jsdoc.info/1602/jugglingdb. Human-written manual sections are:

jugglingdb-schema(3)

Everything about schema, data types and model definition.

jugglingdb-model(3)

Model methods, features and internals.

jugglingdb-validations(3)

Built-in validators, creating custom validations, syncronous and asyncronous object validation.

jugglingdb-hooks(3)

Hooks and object lifecycle.

jugglingdb-adapter(3)

Adapter API explained.

ADAPTERS

All adapters available as separate packages at github.com/jugglingdb and published in npm.

CONTRIBUTION

TODO: briefly describe contribution

FUTURE

See jugglingdb-roadmap(3) and github issues to catch up current development and see how you can help jugglingdb to grow up.

BUGS

When you find issues, please report them:

github/core
https://github.com/1602/jugglingdb/issues
github/adapters
https://github.com/jugglingdb
email
compoundjs@googlegroups.com

Provide test case for reproducing error. When reporting issue to core mention adapter where problem could be reproduced.

HISTORY

See jugglingdb-changelog(3)

JugglingDB is Copyright (C) 2011 Anatoliy Chakkaev http://anatoliy.in

AUTHOR

CONTRIBUTORS

core contributors (more than 1%)

410 Anatoliy Chakkaev       73.9%
 31 Sebastien Drouyer       5.6%
 25 1602                    4.5%
  9 Muneeb Samuels          1.6%
  6 Henri Bergius           1.1%

adapters maintainers

NOTE: Other adapters waits for their maintainers, drop a line to mail@anatoliy.in if you want to maintain some adapter on regular basis.

SEE ALSO

  1. 1602 Software
  2. March 2013
  3. JugglingDB(3)