https://github.com/cvent/lounge
Simple Mongoose-inspired ODM for Couchbase.
https://github.com/cvent/lounge
couchbase odm
Last synced: 5 months ago
JSON representation
Simple Mongoose-inspired ODM for Couchbase.
- Host: GitHub
- URL: https://github.com/cvent/lounge
- Owner: cvent
- License: mit
- Created: 2014-06-24T01:41:50.000Z (almost 12 years ago)
- Default Branch: master
- Last Pushed: 2025-09-02T01:20:22.000Z (10 months ago)
- Last Synced: 2025-09-02T03:26:27.131Z (10 months ago)
- Topics: couchbase, odm
- Language: JavaScript
- Homepage: http://bojand.github.io/lounge
- Size: 5.32 MB
- Stars: 28
- Watchers: 6
- Forks: 10
- Open Issues: 62
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Lounge
> Simple Mongoose-inspired ODM for [Couchbase](http://www.couchbase.com).
[](https://www.npmjs.com/package/lounge)
[](https://travis-ci.org/bojand/lounge)
[](https://standardjs.com)
[](https://raw.githubusercontent.com/bojand/lounge/master/LICENSE.txt)
## Installation
`npm install lounge`
## Overview
Lounge is a simple, somewhat opinionated, Mongoose-inspired ODM for [Couchbase](http://www.couchbase.com). Main goal is
to provide modeling tool framework for working with Couchbase databases in an asynchronous environment of Node.js.
```js
var lounge = require('lounge')
lounge.connect({
connectionString: 'couchbase://127.0.0.1',
bucket: 'lounge_test'
})
var schema = lounge.schema({ name: String })
var Cat = lounge.model('Cat', schema)
var kitty = new Cat({ name: 'Zildjian' })
kitty.save(function (err) {
if (err) // ...
console.log('meow')
})
```
### Features:
* Schema definition
* Strict modeling based on schema
* Schema extension
* Automatic type validation and custom validation
* Document upsert and removal
* Embedded (referenced) documents
* Automatic and manual population of embedded (referenced) document
* Middleware including pre and post hooks
* Indexing using [reference lookup documents](http://docs.couchbase.com/developer/dev-guide-3.0/lookups.html)
* Promise support
### Outside of the scope of this module:
* Document and view management. There are too many patterns and ways of performing document and view management and
view lookup that it is impractical to accommodate anything sane within a simple ODM. This can easily be expanded
on top of Lounge.
* View queries. For same reasons this falls outside of the scope of Lounge.
* N1QL index management and N1QL queries. For the same reasons this falls outside of the scope of this library.
* Full Text Search index management and FTL queries. For the same reasons this falls outside of the scope of this library.
* Automatic document removal on key change. That is if a document key property changes, the new document is saved under
the new key. The old document sticks around under the old key. There are too many implications if we start automatically
handling document removal in this scenario. This should be handled by the user of this module. In most use cases this
should not really be an issue.
## Documentation
* [Guide & API Documentation](http://cvent.github.io/lounge)
## Tests
Module automated tests can be run using `npm test` command. The tests are executed using [Couchbase mocking](https://github.com/couchbase/couchnode#mock-testing).
To run tests against an actual local database create a bucket `lounge_test` and remove `LOUNGE_COUCHBASE_MOCK=true` from
`test` script property in `package.json`.
## Credits
Lots of code and design inspired by [Mongoose](http://mongoosejs.com/).
Icon made by Cursor Creative from www.flaticon.com is licensed by CC 3.0 BY
## License
Copyright 2015 - 2017 Bojan D.
Licensed under the MIT License.