docs: Add important disclaimer about using connectionString #137
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add this important note, it's currently not clear unless you read your plugin code.
When using
connectionString
with fastify-mysql, it will NO longer pass any options towards mysql2. This could be confusing for some people.If you however still want to use a database URI string together with additional mysql configuration options for the mysql2 package, then consider using
uri
option instead together with your additional options (let's say you also want to changeconnectionLimit
as well and still use a database URI).Checklist
npm run test
andnpm run benchmark
and the Code of conduct