From 7cb56da8326bd111cca01fc6e0047b0321c1051b Mon Sep 17 00:00:00 2001 From: Melroy van den Berg Date: Sun, 7 Apr 2024 00:29:32 +0200 Subject: [PATCH] docs: Add important disclaimer about using connectionString Signed-off-by: Melroy van den Berg --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index c6044ea..0dba5cb 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,9 @@ [![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat)](https://standardjs.com/) Fastify MySQL connection plugin; with this you can share the same MySQL connection pool in every part of your server. -Under the hood the [mysql2](https://github.com/sidorares/node-mysql2) is used. If you don't use the `connectionString` option, the options that you pass to `register` will be passed to the MySQL pool builder. +Under the hood the [mysql2](https://github.com/sidorares/node-mysql2) is used. If you don't use the `connectionString` option, the options that you pass to `register` will be passed to the MySQL pool builder. + +_Important:_ All MySQL2 options will be ignored when using `connectionString`, if you want to pass additional options to MySQL2 use `uri` instead of `connectionString`. ## Install ```