Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/phanxgames/mysql-suspend
MySQL wrapper for Node.js Using Es6 Generator control flow
https://github.com/phanxgames/mysql-suspend
Last synced: about 5 hours ago
JSON representation
MySQL wrapper for Node.js Using Es6 Generator control flow
- Host: GitHub
- URL: https://github.com/phanxgames/mysql-suspend
- Owner: phanxgames
- License: gpl-3.0
- Created: 2017-04-19T08:28:32.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2017-04-19T08:40:17.000Z (over 7 years ago)
- Last Synced: 2024-03-25T23:23:49.769Z (8 months ago)
- Language: JavaScript
- Homepage:
- Size: 29.3 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project
README
mysql-suspend
=================
MySQL database wrapper that provides helpers to query the database.
* Select, Insert, Update and Delete Query Builders
* Merge Command allowing insert or update in one command
* Suspend integration for generator-based async control-flow
* Idle Connection Auto Closer
* No transpiling required
### requirements
* ECMAScript 2015 (ES6)
* Node.JS 6.2.2 or later (tested on 6.2.2)
### install
```
npm install mysql-suspend
```
Copy the dbConfig.ex.json file into your project source folder, rename to dbConfig.json,
and update with your database connection information.
### asynchronous nature
All methods that include a callback (cb) have been designed to be used with the
suspend library and may be placed behind a yield command. Be sure to leave the cb
parameter null to use the suspend.resume functionality automatically.
IMPORTANT: You will also need to set the resume reference in the constructor or the
setResume() method, before the suspend.resume functionality will
be enabled.
If you do provide a callback, the 3rd parameter, "next" (ex: cb(err,result, next))
will be the suspend.resume function reference so you may resume execution
to move past the next yield command.
### basic example
```
var suspend = require("suspend");
var MysqlSuspend = require("mysql-suspend");
//Attach your dbConfig to the mysql-suspend module
MysqlSuspend.config = require('./dbConfig.json');
var db = new MysqlSuspend(suspend.resume);
suspend(function*() {
yield db.start();
//... place query methods here ...
yield db.end();
})();
```
### accessing rows
There are 3 ways to loop over the resulting rows of a query.
1: Standard callback.
```
yield db.query("select email from friends where user_id=? ;",[userid],
function(err,rows,cbResume) {
for (let row of rows) {
console.log(row.email);
}
//move past the yield
cbResume();
});
```
2: Rows Getter.
```
yield db.query("select email from friends where user_id=? ;",[userid]);
for (let row of db.rows) {
console.log(row.email);
}
```
3: Async Looping (non-blocking)
```
yield db.query("select email from friends where user_id=? ;",[userid]);
yield db.asyncForEach(function(index,row,cbNext) {
console.log(row.email);
cbNext();
});
```
### checking for errors and rowcount
After every query you should check if it was an error.
```
if (db.error()) {
console.error("Database error: ",db.error());
return;
}
```
And you may also want to check how many rows were returned before looping.
```
if (db.rowCount > 0) {
//.. loop
} else {
console.log("No rows found.");
}
```
### auto closer
Enabling auto closer in the dbConfig.json file allows database connections that you
leave open to be automatically close after a timeout interval provided in minutes.
By default this is not enabled, however you may want to keep this enabled and watch the
console to see if the auto closer picks up on any open connections so you can address
it and proprely close it when you are done.
### merge utility
Conditionally insert or update a row.
If the row exists, update the columns; otherwise, insert as a new row.
See Merge Helper below.
### query helpers examples
The Helpers will help you build SQL statements and provide parameterized values which
safeguard your queries from SQL injections. Any property that is labled as "value" will
be converted to a parameter internally.
##### Select Helper
```
//..
yield db.selectHelper({
table:"users",
columns:["username","email"],
where: db.whereHelper({
"username -like":"t%"
}),
orderBy: db.orderByHelper({
"email":"ASC"
})
});
for (let row of db.rows) {
console.log(row);
//Output example: {username:"Tester",email:"[email protected]"}
}
//..
```
##### Insert Helper
```
//..
yield db.insertHelper({
table:"users",
columns:{
"username":"tester",
"email":"[email protected]"
}
});
//..
```
##### Update Helper
```
//..
yield db.updateHelper({
table: "users",
columns: {
"email":"[email protected]"
},
where: db.whereHelper({
"username":"tester"
})
});
//..
```
##### Delete Helper
```
//..
yield db.deleteHelper({
table: "users",
where: db.whereHelper({
"username":"tester"
})
});
//..
```
##### Merge Helper
```
//..
yield db.mergeHelper({
table: "users",
columns: {
"username":"tester",
"email":"[email protected]"
},
where: db.whereHelper({
"username":"tester"
})
});
//..
```
### Module Dependencies
- [mysql](https://github.com/mysqljs/mysql)
- [suspend](https://github.com/jmar777/suspend)
- [dictionaryjs](https://github.com/phanxgames/dictionaryjs)