Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/eugabrielsilva/rapidsql
A very simple and easy to use promise-based MySQL wrapper for Node.js
https://github.com/eugabrielsilva/rapidsql
database-wrapper mysql nodejs
Last synced: about 2 months ago
JSON representation
A very simple and easy to use promise-based MySQL wrapper for Node.js
- Host: GitHub
- URL: https://github.com/eugabrielsilva/rapidsql
- Owner: eugabrielsilva
- License: mit
- Created: 2020-09-17T03:39:53.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2022-10-07T11:20:23.000Z (about 2 years ago)
- Last Synced: 2024-03-26T02:44:06.211Z (9 months ago)
- Topics: database-wrapper, mysql, nodejs
- Language: JavaScript
- Homepage: https://npmjs.com/package/@eugabrielsilva/rapidsql
- Size: 17.6 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# rapidSQL
A very simple and easy to use promise-based MySQL wrapper for Node.js.
### Installation
```
npm install @eugabrielsilva/rapidsql
```
### Setting up
```js
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.
```js
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.
```js
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:
```js
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`:
```js
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.
```js
db.close().then(() => {
console.log('Successfully disconnected!');
}).catch((err) => {
console.log(err);
});
```
### Credits
Library developed and currently maintained by [Gabriel Silva](https://github.com/eugabrielsilva).