\n\t
\n\t![\"Lounge\"](\"docs/.vuepress/public/sofa256.png\")
\n\t
\n
\n
\n\n# Lounge\n\n> Simple Mongoose-inspired ODM for [Couchbase](http://www.couchbase.com).\n\n[](https://www.npmjs.com/package/lounge)\n[](https://travis-ci.org/bojand/lounge)\n[](https://standardjs.com)\n[](https://raw.githubusercontent.com/bojand/lounge/master/LICENSE.txt)\n\n## Installation\n\n`npm install lounge`\n\n## Overview\n\nLounge is a simple, somewhat opinionated, Mongoose-inspired ODM for [Couchbase](http://www.couchbase.com). Main goal is\nto provide modeling tool framework for working with Couchbase databases in an asynchronous environment of Node.js.\n\n```js\nvar lounge = require('lounge')\nlounge.connect({\n connectionString: 'couchbase://127.0.0.1',\n bucket: 'lounge_test'\n})\n\nvar schema = lounge.schema({ name: String })\nvar Cat = lounge.model('Cat', schema)\n\nvar kitty = new Cat({ name: 'Zildjian' })\nkitty.save(function (err) {\n if (err) // ...\n console.log('meow')\n})\n```\n\n### Features:\n\n* Schema definition\n* Strict modeling based on schema\n* Schema extension\n* Automatic type validation and custom validation\n* Document upsert and removal\n* Embedded (referenced) documents\n* Automatic and manual population of embedded (referenced) document\n* Middleware including pre and post hooks\n* Indexing using [reference lookup documents](http://docs.couchbase.com/developer/dev-guide-3.0/lookups.html)\n* Promise support\n\n### Outside of the scope of this module:\n\n* Document and view management. There are too many patterns and ways of performing document and view management and\n view lookup that it is impractical to accommodate anything sane within a simple ODM. This can easily be expanded\n on top of Lounge.\n* View queries. For same reasons this falls outside of the scope of Lounge.\n* N1QL index management and N1QL queries. For the same reasons this falls outside of the scope of this library.\n* Full Text Search index management and FTL queries. For the same reasons this falls outside of the scope of this library.\n* Automatic document removal on key change. That is if a document key property changes, the new document is saved under\nthe new key. The old document sticks around under the old key. There are too many implications if we start automatically\nhandling document removal in this scenario. This should be handled by the user of this module. In most use cases this\nshould not really be an issue.\n\n## Documentation\n\n* [Guide & API Documentation](http://bojand.github.io/lounge)\n\n## Tests\n\nModule automated tests can be run using `npm test` command. The tests are executed using [Couchbase mocking](https://github.com/couchbase/couchnode#mock-testing).\nTo run tests against an actual local database create a bucket `lounge_test` and remove `LOUNGE_COUCHBASE_MOCK=true` from\n`test` script property in `package.json`.\n\n## Credits\n\nLots of code and design inspired by [Mongoose](http://mongoosejs.com/).\nIcon made by \n\t
\n\t\n
\n