# fastify-mariadb > Fastify MariaDB connection Pool plugin Latest version **2.0.0** (published 2020-09-15) · MIT license · 0 weekly downloads ## Install ```sh npm install fastify-mariadb pnpm add fastify-mariadb yarn add fastify-mariadb bun add fastify-mariadb ``` ## Health **Score 25/100 (F)** — status: abandoned. Positive: no vulnerabilities. Warnings: low downloads; no types; no esm support. Negative: abandoned. ## Facts | | | |---|---| | Version | 2.0.0 | | Published | 2020-09-15 | | First published | 2018-12-07 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | none | | Module format | CommonJS | | Node | >= 10.13 | | Dependencies | 3 | | Unpacked size | 18.5 KB | | Known vulnerabilities | 0 (+3 in 1 direct dependencies) | | Install scripts | no | | GitHub stars | 4 | | Author | Jimmy Huang | | Maintainers | victor0801x | | Keywords | fastify, mariadb, mysql, database, connection pool, sql | ## Links - npm: https://www.npmjs.com/package/fastify-mariadb - Repository: https://github.com/victor0801x/fastify-mariadb - Homepage: https://github.com/victor0801x/fastify-mariadb#readme - Issues: https://github.com/victor0801x/fastify-mariadb/issues - npm.io page: https://npm.io/package/fastify-mariadb ## Dependencies (3) - [mariadb](https://npm.io/package/mariadb.md) ^2.4.2 - [sqlstring](https://npm.io/package/sqlstring.md) ^2.3.2 - [fastify-plugin](https://npm.io/package/fastify-plugin.md) ^2.3.4 ## Alternatives - [@libsql/sqlite3](https://npm.io/package/@libsql/sqlite3.md) — 39.8K weekly downloads - [@fortemi/core](https://npm.io/package/@fortemi/core.md) — 461 weekly downloads - [cdb-converter](https://npm.io/package/cdb-converter.md) — 341 weekly downloads - [@uplo/adapter-prisma](https://npm.io/package/@uplo/adapter-prisma.md) — 75 weekly downloads - [typeorm-aios](https://npm.io/package/typeorm-aios.md) — 30 weekly downloads ## Recent versions - 2.0.0 (latest) — 2020-09-15 - 3.0.0-beta.1 (beta) — 2023-05-05 - 1.2.2 — 2020-07-22 - 1.2.1 — 2020-03-22 - 1.2.0 — 2019-12-11 - 1.1.0 — 2019-07-15 - 1.0.7 — 2019-05-17 - 1.0.6 — 2019-04-12 - 1.0.5 — 2019-03-14 - 1.0.4 — 2019-03-14 - 1.0.3 — 2019-02-09 - 1.0.2 — 2019-02-01 - 1.0.1 — 2019-02-01 - 1.0.0-rc2 — 2019-01-04 - 1.0.0-rc1 — 2018-12-22 - … 5 more at https://npm.io/package/fastify-mariadb/versions ## README # Fastify MariaDB Pool plugin [![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat)](http://standardjs.com/) ![CI](https://github.com/victor0801x/fastify-mariadb/workflows/CI/badge.svg) [![npm version](https://img.shields.io/npm/v/fastify-mariadb.svg?style=flat)](https://www.npmjs.com/package/fastify-mariadb) [![npm downloads](https://img.shields.io/npm/dm/fastify-mariadb.svg?style=flat)](https://www.npmjs.com/package/fastify-mariadb) Fastify MariaDB **connection Pool** plugin, with this you can share the same MariaDB connection pool in every part of your server. Under the hood the official [MariaDB Node.js connector](https://github.com/MariaDB/mariadb-connector-nodejs) is used, the options that you pass to `register` will be passed to the MariaDB pool builder. **Note: start v2.x required Node.js 10+** ## Install ``` npm install fastify-mariadb --save ``` ## Usage Add it to your project with `register` and you are done! This plugin will add the `mariadb` namespace in your Fastify instance, with the following properties: ``` pool: the pool instance query: an utility to perform a query without a transaction getConnection: get a connection from the pool ``` Example: ```js const fastify = require('fastify')() fastify.register(require('fastify-mariadb'), { host: 'localhost', user: 'root', database: 'mysql', connectionLimit: 5 }) fastify.get('/user/:id', (req, reply) => { // `pool.getConnection` -> `conn.query` -> `conn.release` fastify.mariadb.getConnection((err, conn) => { if (err) return reply.send(err) conn.query('SELECT username FROM users WHERE id=?', [req.params.id], (err, result) => { conn.release() reply.send(err || result) }) }) }) fastify.get('/mariadb/time', (req, reply) => { // `pool.query` fastify.mariadb.query('SELECT now()', (err, result) => { reply.send(err || result) }) }) fastify.listen(3000, (err) => { if (err) throw err console.log(`server listening on ${fastify.server.address().port}`) }) ``` As you can see there is no need to close the client, since is done internally. Async await is supported, when register `promise` option is `true`: ```js const fastify = require('fastify')() fastify.register(require('fastify-mariadb'), { promise: true, connectionString: 'mariadb://root@localhost/mysql' }) fastify.get('/user/:id', async (req, reply) => { const mariadb = fastify.mariadb const connection = await mariadb.getConnection() const result = await mariadb.query('SELECT username FROM users WHERE id=?', [req.params.id]) connection.release() return result[0] }) fastify.listen(3000, (err) => { if (err) throw err console.log(`server listening on ${fastify.server.address().port}`) }) ``` ## options * `promise` - `Boolean` (optional, if not present will use `callback` style pool) * `connectionString` - `String` (optional, url string) For example: `mariadb://user:pass@host/db?debug=true` * `Pool options` - [Pool options](https://github.com/MariaDB/mariadb-connector-nodejs/blob/master/documentation/promise-api.md#pool-options) includes `connection options` that will be used when creating new connections. `MariaDB connector/Node.js` most options are similar to `mysql/mysql2` driver with more features and performant. More usage, please see [mariadb-connector-nodejs](https://github.com/MariaDB/mariadb-connector-nodejs) * [`Promise API`](https://github.com/MariaDB/mariadb-connector-nodejs/blob/master/documentation/promise-api.md#promise-api) * [`Callback API`](https://github.com/MariaDB/mariadb-connector-nodejs/blob/master/documentation/callback-api.md#callback-api) ## Acknowledgements - Most of codes are copied from [fastify-mysql](https://github.com/fastify/fastify-mysql). ## License Licensed under [MIT](./LICENSE). --- _Source: https://npm.io/package/fastify-mariadb · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._