openrecord
Version:
Active record like ORM for nodejs
48 lines (33 loc) • 2.17 kB
Markdown
==========
[](https://travis-ci.org/PhilWaldmann/openrecord)
[](https://coveralls.io/r/PhilWaldmann/openrecord)
[](https://npmjs.org/package/openrecord)
[](http://packagequality.com/#?package=openrecord)
[](https://lgtm.com/projects/g/PhilWaldmann/openrecord)
[](https://lgtm.com/projects/g/PhilWaldmann/openrecord/alerts)
OPENRECORD is an ActiveRecord inspired ORM for nodejs.
Currently it supports the following databases/datastores: SQLite3, MySQL, Postgres, Oracle, REST and LDAP (+ ActiveDirectory)
If you want to build a GraphQL endpoint for any of these databases, OPENRECORD has some built in features to support you!
As the name imply, it's open and very easy to extend. The whole package was build that way.
It has a lot of features, just take a look at the [docs](https://openrecord.js.org)!
## Usage example
Here is an example how to get a single `post` from an existing sqlite3 file (by primary key).
```js
const Store = require('openrecord/store/sqlite3')
const store = new Store({
file: './my-posts-db.sqlite3',
autoLoad: true
})
store.ready(async () => {
const post = await store.Model('Post').find(1)
console.log(post)
})
```
You don't have to define your model (optional) and you also don't have to define your model's attributes (optional).
Take a look at the [docs](https://openrecord.js.org) to get started!
## Contributing
If you've found a bug please report it via the [issues](https://github.com/PhilWaldmann/openrecord/issues) page.
Before you submit a pull request, please make sure all tests still pass.
---
Sponsored by [digitalbits.at](https://digitalbits.at)