Ottoman is an ODM built for Couchbase and Node.js.
Ottoman's goal is to provide a better development experience while using Couchbase, bringing to developers a reliable tool to build systems that are easy-to-design, to maintain and to scale.
npm install ottoman
That's it, you are ready to use Ottoman.
Supported version are:
|Ottoman||Nodejs||Couchbase SDK||Couchbase Server|
Notice: make sure you are using supported versions
;;const User = ;const user = name:'Jane Doe';user;
Ottoman v2 main goals
- To add support to Couchbase SDK 3.
- To add typescript support.
- To have a powerful query builder built-in.
- To allow adding indexes to improve queries performance.
- To have extendable Schemas using statics, methods, hooks.
- To have Pluggable Schemas.
To check out
examples and docs, visit ottomanjs.com.
Please make sure to read the Issue Reporting Checklist before opening an issue.
Detailed changes for each release are documented in the release notes.
Stay In Touch
Please make sure to read the
Contributing Guide before making a pull request.
Thank you to all the people who already contributed to Couchbase Ottoman!
Guide for Developers
Get the repo and install dependencies
$ git clone https://github.com/couchbaselabs/node-ottoman.git $ cd node-ottoman $ yarn install
- Available scripts
$ yarn dev $ yarn build $ yarn lint $ yarn test $ yarn test --coverage $ yarn docs
Check results on http://localhost:8091/ couchbase web client
© Copyright 2013 Couchbase Inc.
Licensed under the Apache License, Version 2.0. See the Apache 2.0 license.