node-mysql-promise2

node-mysql API wrapper with Promise

** No extra depedencies except node-mysql **

Requirements

Node >= 4.0 is required

Install

npm install --save node-mysql-promise2

Samples

Connnection

connect to a database and execute a query;

1const mysql = require('node-mysql-promise2');
2
3// get a connection
4mysql.createConnection({
5    host: 'localhost',
6    user: 'root',
7    password: 'helloworld',
8    database: 'sample'
9}).then(function (connection) {
10    // Execute a query
11    return connection.query(`SELECT * FROM user`);
12}).then(function (users) {
13    console.log(users);
14}).catch(function (error) {
15    console.error(error);
16});

Pool

1
2const mysql = require('node-mysql-promise2');
3const pool = mysql.createPool({
4    host: 'localhost',
5    user: 'root',
6    password: 'helloworld',
7    database: 'sample',
8    connectionLimit: 10
9});
10
11pool.getConnection().then(function (connection) {
12    // Execute a query
13    return connection.query(`SELECT * FROM user`);
14}).then(function (users) {
15    console.log(users);
16}).catch(function (error) {
17    console.error(error);
18});
19

Others

We also export the following API & Constants from node-mysql:

• Types
• escape
• escapeId
• format

So you can do this:

1const mysql = require('node-mysql-promise2');
2var userId = 'some user provided value';
3var sql    = 'SELECT * FROM users WHERE id = ' + mysql.escape(userId);
4connection.query(sql).then(function () {
5    // ...
6});