LoopbackData(3) - cross-database ORM for nodejs and browser ========================================================= ## DESCRIPTION LoopbackData is a cross-db ORM for nodejs, providing **common interface** to access most popular database formats. Currently supported db formats are: mysql, sqlite3, postgres, couchdb, mongodb, redis, neo4j and in-memory-storage. LoopbackData also works on client-side (using WebService and Memory adapters), which allow to write rich client-side apps talking to server using JSON API. ## INSTALLATION Use npm to install core package: npm install loopback-data --save Alternatively you can install loopback-data core from github: npm install 1602/loopback-data Then install adapter for specific database, for example `loopback-connector-redis`: npm install loopback-connector-redis See [ADAPTERS][] for list of available adapters. ## DOCUMENTATION Autogenerated documentation available at [jsdoc.info/1602/loopback-data]. Human-written manual sections are: * loopback-connector-schema(3): Everything about schema, data types and model definition. * loopback-connector-model(3): Model methods, features and internals. * loopback-connector-validations(3): Built-in validators, creating custom validations, syncronous and asyncronous object validation. * loopback-connector-hooks(3): Hooks and object lifecycle. * loopback-connector-adapter(3): Adapter API explained. ## ADAPTERS All adapters available as separate packages at [github.com/loopback-data] and published in npm. * MySQL: [github][loopback-connector-mysql] [npm][mysql-adapter-npm] * SQLite3: [github][loopback-connector-sqlite3] [npm][sqlite3-adapter-npm] * Postgres: [github][loopback-connector-postgres] [npm][postgres-adapter-npm] * Redis: [github][loopback-connector-redis] [npm][redis-adapter-npm] * MongoDB: [github][loopback-connector-mongodb] [npm][mongodb-adapter-npm] * CouchDB/nano: [github][loopback-connector-nano] [npm][nano-adapter-npm] * Firebird: [github][loopback-connector-firebird] [npm][firebird-adapter-npm] ## CONTRIBUTION You can take part in improvement of loopback-data codebase and documents. If you see that some improvements can be done to loopback-data, then fork repository, make proposed changes and then create new pull request. Please remember that your contribution is highly supported. Be sure to follow the discussion in google group and see [github issues][issues] before you make changes. It preferable that you post new comment in google group or in github before you make changes and create pull request. ## FUTURE See loopback-connector-roadmap(3) and [github issues][issues] to catch up current development and see how you can help loopback-data to grow up. ## BUGS When you find issues, please report them: * github/core: * github/adapters: * email: Provide test case for reproducing error. When reporting issue to core mention adapter where problem could be reproduced. ## HISTORY See loopback-connector-changelog(3) ## COPYRIGHT LoopbackData is Copyright (C) 2011 Anatoliy Chakkaev http://anatoliy.in ## AUTHOR * [blog](http://anatoliy.in/) * [github/1602](https://github.com/1602/) * [github/anatoliychakkaev](https://github.com/anatoliychakkaev/) * [twitter@1602](http://twitter.com/1602) * ## 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 * [loopback-connector-nano] - [Nicholas Westlake](https://github.com/nrw) * [loopback-connector-mysql] - [dgsan](https://github.com/dgsan) * [loopback-connector-firebird] - [Henri Gourvest](https://github.com/hgourvest) *NOTE:* Other adapters waits for their maintainers, drop a line to if you want to maintain some adapter on regular basis. ## SEE ALSO loopback-connector-schema(3)