@eugabrielsilva/rapidsql

rapidSQL

A very simple and easy to use promise-based MySQL wrapper for Node.js.

Installation

npm install @eugabrielsilva/rapidsql

Setting up

const rapidSQL = require('@eugabrielsilva/rapidsql');
const db = new rapidSQL({host: DB_HOST, user: DB_USER, password: DB_PASSWORD, database: DB_DATABASE});

Provide the connection options as an object in the database constructor. Valid options are:

• host (optional): The hostname of the database you are connecting to. (Defaults to localhost)
• user (optional): The MySQL user to authenticate as. (Defaults to root)
• password (optional): The password of that MySQL user. (Defaults to empty)
• database (required): Name of the database to use for this connection.
• port (optional): The port number to connect to. (Defaults to 3306)
• connectionLimit (optional): The maximum number of connections to create at once. (Defaults to 10)
• stringifyObjects (optional): Stringify objects instead of converting to values. (Defaults to false)
• debug (optional): Prints protocol details to STDOUT. (Defaults to false)

Connecting to the database

This library uses connection pools as default. You only need to connect to the database once. The connection is made asynchronously.

db.connect().then(() => {
    console.log('Successfully connected!');
}).catch((err) => {
    console.log(err);
});

Running SQL queries

You can run SQL queries by using the sql() method. All queries are made asynchronously and will respond with a result object or an array of objects.

db.sql('SELECT * FROM table_name').then((result) => {
    console.log(result);
}).catch((err) => {
    console.log(err);
});

Escaping query values

In order to avoid SQL Injection attacks, you should always escape any user provided data before using it inside a SQL query. You can do this by using ? characters as placeholders for values you would like to have escaped like this:

let userID = 5;
db.sql('SELECT * FROM users WHERE ID = ?', [userID]).then((result) => {
    console.log(result);
}).catch((err) => {
    console.log(err);
});

Multiple placeholders are mapped to values in the same order as passed. For example, in the following query foo equals a, bar equals b, baz equals c, and ID will be userID:

let userID = 5;
db.sql('UPDATE users SET foo = ?, bar = ?, baz = ? WHERE ID = ?', ['a', 'b', 'c', userID]).then((result) => {
    console.log(result);
}).catch((err) => {
    console.log(err);
});

Closing the connection

If you are not going to use the connection anymore, you can close it by using the close() method. This method will wait until all pending queries are executed.

db.close().then(() => {
    console.log('Successfully disconnected!');
}).catch((err) => {
    console.log(err);
});

Credits

Library developed and currently maintained by Gabriel Silva.