Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/neumino/thinky
JavaScript ORM for RethinkDB
https://github.com/neumino/thinky
Last synced: 21 minutes ago
JSON representation
JavaScript ORM for RethinkDB
- Host: GitHub
- URL: https://github.com/neumino/thinky
- Owner: neumino
- License: other
- Created: 2013-06-22T19:11:04.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2021-11-21T19:39:17.000Z (about 3 years ago)
- Last Synced: 2024-12-06T20:29:57.652Z (7 days ago)
- Language: JavaScript
- Homepage: http://justonepixel.com/thinky/
- Size: 2.44 MB
- Stars: 1,120
- Watchers: 24
- Forks: 128
- Open Issues: 106
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- awesome-github-star - thinky
- awesome-rethinkdb - Thinky
README
# Thinky
===============================
Light Node.js ORM for RethinkDB.
### Quick start
Install:
```
npm install thinky
```
Use:
```javascript
var thinky = require('thinky')();
var type = thinky.type;
// Create a model - the table is automatically created
var Post = thinky.createModel("Post", {
id: String,
title: String,
content: String,
idAuthor: String
});
// You can also add constraints on the schema
var Author = thinky.createModel("Author", {
id: type.string(), // a normal string
name: type.string().min(2), // a string of at least two characters
email: type.string().email() // a string that is a valid email
});
// Join the models
Post.belongsTo(Author, "author", "idAuthor", "id");
```
Save a new post with its author.
```js
// Create a new post
var post = new Post({
title: "Hello World!",
content: "This is an example."
});
// Create a new author
var author = new Author({
name: "Michel",
email: "[email protected]"
});
// Join the documents
post.author = author;
post.saveAll().then(function(result) {
/*
post = result = {
id: "0e4a6f6f-cc0c-4aa5-951a-fcfc480dd05a",
title: "Hello World!",
content: "This is an example.",
idAuthor: "3851d8b4-5358-43f2-ba23-f4d481358901",
author: {
id: "3851d8b4-5358-43f2-ba23-f4d481358901",
name: "Michel",
email: "[email protected]"
}
}
*/
});
```
Retrieve the post with its author.
```js
Post.get("0e4a6f6f-cc0c-4aa5-951a-fcfc480dd05a").getJoin().run().then(function(result) {
/*
result = {
id: "0e4a6f6f-cc0c-4aa5-951a-fcfc480dd05a",
title: "Hello World!",
content: "This is an example.",
idAuthor: "3851d8b4-5358-43f2-ba23-f4d481358901",
author: {
id: "3851d8b4-5358-43f2-ba23-f4d481358901",
name: "Michel",
email: "[email protected]"
}
}
*/
});
```
### Documentation
[https://www.justonepixel.com/thinky](https://www.justonepixel.com/thinky) (branch `gh-pages).
### Help
No SLA, but a few developers hang out there and may be able to help:
- [irc://irc.freenode.org/rethinkdb](irc://irc.freenode.org/rethinkdb)
- [https://gitter.im/neumino/thinky](https://gitter.im/neumino/thinky)
### Run the tests
```
npm test
```
### Contribute
You are welcome to do a pull request.
### Roadmap
The roadmap is defined with the issues/feedback on GitHub. Checkout:
[https://github.com/neumino/thinky/issues](https://github.com/neumino/thinky/issues)
### Author
- Michel Tu -- [email protected] -- [blog](http://blog.justonepixel.com) -- [twitter](https://twitter.com/neumino)
### Contributors
- [chrisfosterelli](https://github.com/chrisfosterelli)
- [colprog](https://github.com/colprog)
- [dulichan](https://github.com/dulichan)
- [flienteen](https://github.com/flienteen)
- [marshall007](https://github.com/marshall007)
- [mindjuice](https://github.com/mindjuice)
- [Morhaus](https://github.com/Morhaus)
- [primitive-type](https://github.com/primitive-type)
- [nikaspran](https://github.com/nikaspran)
- [rasapetter](https://github.com/rasapetter)
- [simonratner](https://github.com/simonratner)
- [wezs](https://github.com/wezs)
### License
MIT, see the [LICENSE](https://github.com/neumino/thinky/blob/master/LICENSE) file