Skip to content

fogine/couchbase-odm

Repository files navigation

CouchbaseODM

Build Status Test Coverage npm version Gitter license

CouchbaseODM is a promise-based Node.js ODM for Couchbase. It strives for clean, easy-to-use API for your business logic, offering (reasonable) customizability.

Installation

npm install kouchbase-odm

Contributing

Please, fill a bug report at issues page if you find any.
Also, feedback, suggestions and pull requests are more than welcome!
Make sure to discuss an issue with the community before implementing a solution for the issue.

Features

  • Promises!
  • Model based
  • Hooks
  • Key generation strategies (eg. incremented integer, uuidv4 or user defined strategies)
  • Strictly typed schema definitions
  • Document associations
  • Advanced quering:
    • Application layer indexes (reference documents)
    • Views support (next minor release)
    • N1QL support (on Roadmap)
  • and more (see Public API Reference)!

Resources

Tests

npm test


Note: this project is using Semantic versioning
Note: this project is inspired by Sequelize - splendid promise-based ORM for Postgres, MySQL, MariaDB, SQLite and Microsoft SQL Server