https://github.com/lagden/mysql-pool
Make pooling connections with MySQL
https://github.com/lagden/mysql-pool
connection-pool mysql nodejs pool query
Last synced: 2 months ago
JSON representation
Make pooling connections with MySQL
- Host: GitHub
- URL: https://github.com/lagden/mysql-pool
- Owner: lagden
- License: mit
- Created: 2017-12-05T23:34:53.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2025-03-11T20:00:18.000Z (2 months ago)
- Last Synced: 2025-03-11T20:35:13.643Z (2 months ago)
- Topics: connection-pool, mysql, nodejs, pool, query
- Language: JavaScript
- Homepage: https://lagden.github.io/mysql-pool
- Size: 692 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# mysql-pool
[![NPM version][npm-img]][npm] [![Build Status][ci-img]][ci] [![Coverage Status][coveralls-img]][coveralls]
[npm-img]: https://img.shields.io/npm/v/@tadashi/mysql-pool.svg
[npm]: https://www.npmjs.com/package/@tadashi/mysql-pool
[ci-img]: https://github.com/lagden/mysql-pool/actions/workflows/nodejs.yml/badge.svg
[ci]: https://github.com/lagden/mysql-pool/actions/workflows/nodejs.yml
[coveralls-img]: https://coveralls.io/repos/github/lagden/mysql-pool/badge.svg?branch=master
[coveralls]: https://coveralls.io/github/lagden/mysql-pool?branch=master
Make pooling connections with [MySQL](https://sidorares.github.io/node-mysql2/docs/examples/connections/create-pool#pooloptions)
## Install
```
$ npm i @tadashi/mysql-pool
```
## Environment variable
| Variable | Type | Required | Default | Description |
| -------------------- | ------- | -------- | --------- | ----------------------------------- |
| MYHOST | string | no | localhost | Hostname or server address |
| MYPORT | number | no | 3306 | Port number for the connection |
| MYUSER | string | no | root | User authentication |
| MYPASS | string | no | | Authentication password |
| MYLIMIT | number | no | 5 | Limit or threshold value |
| MYCONNECTTIMEOUT | number | no | 30000 | Connection timeout in milliseconds |
| MYMULTIPLE | boolean | no | true | Allowing multiple statements |
| MYWAITFORCONNECTIONS | boolean | no | true | Waiting for available connections |
| MYENCODE | number | no | 0 | MYUSER and MYPASS encoded in base64 |
## Usage
```js
import MysqlPool from '@tadashi/mysql-pool'
const pool = new MysqlPool() // => https://sidorares.github.io/node-mysql2/docs/examples/connections/create-pool
const { results: [{ total }] } = await pool.query('SELECT 1 + ? as total', [1])
// => 2
// Closing all the connections in a pool
await pool.end()
```
## Team
[
](https://github.com/lagden)
---
> [!IMPORTANT]\
> Buy me a coffee!\
> BTC: `bc1q7famhuj5f25n6qvlm3sssnymk2qpxrfwpyq7g4`
## License
MIT © [Thiago Lagden](https://github.com/lagden)