https://github.com/salesflare/hapi-plugin-mysql
Hapi plugin for MySQL
https://github.com/salesflare/hapi-plugin-mysql
hapi hapi-plugin hapijs mysql plugin
Last synced: 7 months ago
JSON representation
Hapi plugin for MySQL
- Host: GitHub
- URL: https://github.com/salesflare/hapi-plugin-mysql
- Owner: Salesflare
- License: mit
- Created: 2015-01-14T15:40:52.000Z (about 11 years ago)
- Default Branch: main
- Last Pushed: 2023-12-05T11:31:04.000Z (about 2 years ago)
- Last Synced: 2025-06-23T23:47:47.184Z (8 months ago)
- Topics: hapi, hapi-plugin, hapijs, mysql, plugin
- Language: JavaScript
- Size: 393 KB
- Stars: 17
- Watchers: 7
- Forks: 4
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# hapi-plugin-mysql [](https://travis-ci.org/Salesflare/hapi-plugin-mysql)
> hapi plugin for MySQL
## What
Attaches a MySQL connection from a pool to every request.
## How
Via `request.app.db`.
You can also manually get a connection from the server via `server.getDb(function (err, connection) {})`.
```javascript
await server.register({
plugin: require('hapi-plugin-mysql'),
options: {
host: "localhost",
user: "root",
password: ""
}
});
server.route({
method: 'GET',
path: '/',
handler: async (request, h) => {
request.app.db.query(...);
return 'ok';
}
});
```
The options are the same options you can pass onto the `mysql` lib for making a connection. See for more info on the `mysql` lib itself.
The keyword `db` is used because `connection` was used by `<= hapi@16` and could have caused confusion/collision.
If you want more manual control or you want to use the same pool outside of the hapi part of your server
you can initialize the pool before the plugin registration by calling `await HapiPluginMysql.init(options)` and then call `require('hapi-plugin-mysql').getConnection` to get a connection from the pool.
If you still want to register the plugin (to get all the goodies) just don't pass any options to the plugin registration
and it will use the same pool as first created.
To manually stop the pool call `await HapiPluginMySQL.stop()`.
See the tests for more granular use cases.
## Catches
- Transactions are no longer a part of this plugin and should be handled (with care) in your code
## Testing
- almost 100% code coverage! If you know how to test these last case please do let me know or PR :O
- The tests requires you to have a `test` db with a table `test` and `{user: root, password: ""}`.
- See `.travis.yml` and the tests for more info.
## Changelog
See the [releases](https://github.com/Salesflare/hapi-plugin-mysql/releases) page