Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yorkie/sqoosel
SQL-based Application Framework for Node.js
https://github.com/yorkie/sqoosel
Last synced: 5 days ago
JSON representation
SQL-based Application Framework for Node.js
- Host: GitHub
- URL: https://github.com/yorkie/sqoosel
- Owner: yorkie
- Created: 2014-10-19T16:44:30.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2014-10-19T17:05:46.000Z (about 10 years ago)
- Last Synced: 2024-10-19T19:35:46.435Z (24 days ago)
- Language: JavaScript
- Size: 133 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Sqoosel
============================
[](https://travis-ci.org/yorkie/sqoosel)
SQL-based Application Framework for Node.js
[](https://nodei.co/npm/sqoosel/)
[](https://nodei.co/npm/sqoosel/)
### Installation
```sh
$ npm install sqoosel --save
```
### Usage
##### Define your SQL engine
```js
var sqoosel = require('sqoosel');
sqoosel({
// this function will be called in your every query to your SQL-based database
query: function(exec) {
pg.connect('postgres://postgres@localhost:5432/ci_test', function(err, client, close) {
exec(err, client.query, close, client);
});
}
});
```
The passing callback `exec` will receive 4 arguments, then they are: `exec(err, queryfn, closefn, client)`.
##### Define your schema and model
```js
var sqoosel = require('sqoosel');
var UserSchema = new sqoosel.Schema({
'id': sqoosel.types.bigserial().asPrimary(),
'username': sqoosel.types.char(128).required(),
'password': sqoosel.types.char(256).required(),
'createDate': sqoosel.types.timestamp().setDefault('now()')
});
module.exports = sqoosel.model('user', UserSchema);
```
So close to [mongoose](https://github.com/mongoose/mongoose) ?
##### Using your model in your controller or anywhere that you want to use
```js
var User = require('../find/your/model');
router.get('/register/', function(req, res, next) {
var username = req.body.username;
var password = req.body.password;
// encoding your infomation or other business logic
// ...
User.insert({username: username, password: password})
.exec(function(err, result) {
// this function's arguments will depend on engine, your sql library, here we are using node-postgres
if (err)
res.status(500).end();
else
res.status(200).end();
});
});
```
For more function-based SQL generation, you should move forward to [brianc/node-sql](https://github.com/brianc/node-sql)
##### It's SQL database, we need to apply your schemas, very simple to call `createReadStream` with your model
Now show you howto generate `.sql` init script:
```js
// load your models
var User = require('../find/your/model');
User.createReadStream().pipe(fs.createWriteStream('/path/to/your/sql/file'));
```
Then you will get the `.sql` script like:
```sql
CREATE TABLE IF NOT EXIST user(
...
);
```
How to pipe multiple models to one file? [dominictarr/event-stream](https://github.com/dominictarr/event-stream) is the anwser:
```js
var es = require('event-stream');
es.merge(
Model1.createReadStream(),
Model2.createReadStream(),
...
).pipe(fs.createWriteStream('/path/to/your/sql/file'));
```
If you want to check your SQL schema string, `toString` are available for you as well:
```js
var Model = require('...');
console.log(Model.toString());
```
### License
MIT