Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/namshi/node-mysql
https://github.com/namshi/node-mysql
Last synced: 1 day ago
JSON representation
- Host: GitHub
- URL: https://github.com/namshi/node-mysql
- Owner: namshi
- Created: 2017-04-11T04:59:00.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2022-01-26T08:26:06.000Z (almost 3 years ago)
- Last Synced: 2024-10-30T01:37:18.618Z (9 days ago)
- Language: JavaScript
- Size: 5.53 MB
- Stars: 0
- Watchers: 35
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# node-mysql
This wrapper provides some enhancements for [`node-mysql2`](https://github.com/sidorares/node-mysql2)
[](https://travis-ci.com/namshi/node-mysql)
## Installation
This module can be installed with either yarn or npm:
``` bash
$ yarn add namshi-node-mysql
```
``` bash
$ npm install namshi-node-mysql --save
```
## Example Usage of query
`query()` uses [prepared statements](https://github.com/sidorares/node-mysql2#prepared-statements) but does not support bulk operations.
``` js
let config = {
host: "localhost",
user: "foo",
password: "bar",
database: "db"
}
let db = require('namshi-node-mysql')(config);
db.query('UPDATE foo SET key = ?', ['value']).then(() => {
return db.query('SELECT * FROM foo');
}).spread(rows => {
console.log('Look at all the foo', rows);
});
// using multiple databases, you can add a "name" key to your config object. For example:
let config = {
name: "second-db",
host: "localhost",
user: "foo",
password: "bar",
database: "db"
}
let db2 = require('namshi-node-mysql')(config);
db2.query('SELECT * FROM users').spread(users => {
console.log('Hello users', users);
});
```
## Enable DEBUG mode to log the query being executed and its parameters.
``` js
// You can enable debugging by passing the `debug` parameter as follow:
// by default it is set to false.
let config = {
host: "localhost",
user: "foo",
password: "bar",
database: "db",
debug: true;
}
```
## Example Usage of bulk
`bulk()` uses `execute` which supports prepared statements and we use prepared statements for bulk.
``` js
let config = {
host: "localhost",
user: "foo",
password: "bar",
database: "db"
}
var values = [
['demian', '[email protected]', 1],
['john', '[email protected]', 2],
['mark', '[email protected]', 3],
['pete', '[email protected]', 4]
];
let db = require('namshi-node-mysql')(config);
db.bulk('INSERT INTO foo (name, email, n) VALUES ?', values).then(() => {
return db.query('SELECT * FROM foo');
}).spread(rows => {
console.log('Look at all the foo', rows);
});
```
## Example of prepareBulk
`prepareBulk()` can be used if you want to format a query for bulk operation with a connection reused for a transaction.
``` js
let config = {
host: "localhost",
user: "foo",
password: "bar",
database: "db"
}
var values = [
['demian', '[email protected]', 1],
['john', '[email protected]', 2],
['mark', '[email protected]', 3],
['pete', '[email protected]', 4]
];
let db = require('namshi-node-mysql')(config);
let connection;
db.startTransaction().then(conn => {
connection = conn;
}).then(() => {
let [query, params] = db.prepareBulk('INSERT INTO foo (name, email, n) VALUES ?', [values]);
return connection.execute(query, params);
}).then(result => {
return db.commit(connection);
}).then(result => {
console.log('Rows committed');
}).catch(err => {
db.rollback(connection).then(result => {
console.log('Rollback executed due to ', err.message);
});
})
```
## Example usage of [namedPlaceholders]((https://github.com/sidorares/node-mysql2#named-placeholders))
``` js
let config = {
host: "localhost",
user: "foo",
password: "bar",
database: "db",
namedPlaceholders: true
}
let db = require('namshi-node-mysql')(config);
db.query('SELECT * FROM users WHERE LIMIT = :limit', {limit: 10}).spread( users => {
console.log('Hello users', users);
});
```
## Example usage of startTransaction, commit and rollback
``` js
let config = {
host: "localhost",
user: "foo",
password: "bar",
database: "db"
}
let db = require('namshi-node-mysql')(config);
let connection;
db.startTransaction(30).then(conn => {
connection = con;
}).catch(err) {
//handle error
};
//default timeout here is set to 20
db.startTransaction().then(conn => {
connection = con;
}).catch(err) {
//handle error
};
db.commit(connection).catch(err => {
//handle err
});
db.rollback(connection).catch(err => {
//handle err
});
```
## Credits
This library depends on [node-mysql2](https://github.com/sidorares/node-mysql2). It is also considered a breaking-change upgrade of [node-mysql2-promise](https://github.com/namshi/node-mysql2-promise).