Download Release Notes Changelog

Release date: 25 Jul 2025

For the highlights of this release, see the release notes.

The revision number links will take you to the revision's page on GitHub. On GitHub you can view more details of the revision and view diffs of the code modified in that revision.

• Revision #6baf970 bump 3.4.5

• [misc] update dependencies

• [] revert TypeScript dependency #320

• [misc] update TS file to ES module syntax

• [] correcting TypeError: validationFunction is not a function

• [misc] client side parsing removing "//" single line comment

Download | Release Notes | Changelog |

Release date: 25 Apr 2025

For the highlights of this release, see the release notes.

The revision number links will take you to the revision's page on GitHub. On GitHub you can view more details of the revision and view diffs of the code modified in that revision.

• Revision #d8fc60a only run benchmark on the master branch to speed up tests

• Revision #bb093c6 bump 3.4.2 version

• [] enable the permitRedirect option by default only when SSL is enabled

• [misc] micro optimization

• [misc] text decoder small improvement

• [misc] column parsing improvements

• [misc] Revised the buffer reading methods to increment this.pos once per function call when possible

• [misc] Replaces repetitive query[i]

• [] Repeated named placeholders causes "Placeholder is not defined" #311

Download | Release Notes | Changelog |

Release date: 3 May 2023

For the highlights of this release, see the release notes.

The revision number links will take you to the revision's page on GitHub. On GitHub you can view more details of the revision and view diffs of the code modified in that revision.

• Revision #f56bd14 - Merge tag '3.1.2' into develop

• Revision #193a13d - Merge branch 'release/3.1.2'

• - bump 3.1.2 version

• - [] add connection.listeners function to permit TypeORM compatibility

• - [] Ensuring not importing file after pool.end() #239

• - [] Improve error message when having set named parameter option and executing standard question mark command #238

• - Merge tag '3.1.1' into develop

Download | Release Notes | Changelog |

Release date: 18 Sep 2024

For the highlights of this release, see the release notes.

The revision number links will take you to the revision's page on GitHub. On GitHub you can view more details of the revision and view diffs of the code modified in that revision.

• Revision #1a8c536 [misc] adding missing changelog issue

• Revision #9086a6a bump version to 3.3.2

• bump dependencies

• [] TypeScript type definition file for SqlError constructor does not match actual constructor

• [] ensure identity validation only when certificate validation was required

• [misc] test stability addition

• [] temporary disabling TLS identity validation until certificate automatic resolution

• [misc] helping trace travis issue

• Merge branch 'master' into develop

• Mention the new NodeJS 20 "--env-file"

• [] Typescript wrong named longlong in place of bigint

• Merge branch 'biginttype' into develop

• [] adding testing for typescript connection queryTimeout and query timeout options

• Merge branch 'timeout_to_queryTimeout' into develop

• [misc] ensure not using private properties with nestTables options

• [misc] permit travis test stability with RC server version

• fix ConnectionConfig typing, revert QueryConfig typing changes

• fix the typing of timeout to queryTimeout in interface QueryConfig

• Add missing BIGINT Type enum

Download | Release Notes | Changelog |

Release date: 24 Oct 2024

For the highlights of this release, see the release notes.

The revision number links will take you to the revision's page on GitHub. On GitHub you can view more details of the revision and view diffs of the code modified in that revision.

• Revision #d089e89 - bump 3.4.0 version

• Revision #31e3913 - [CONJS-295] add mysql2 option jsonStrings option to return MySQL Json field as string

• - [] Add option enableKeepAlive / keepAliveInitialDelay alias for keepAliveDelay

• - Merge branch 'develop' of into develop

• - Merge branch 'parsec' into develop

• - Merge branch 'master' into develop

• - Merge pull request #295

• - Update tests for ephemeral certificates in MaxScale

• - [misc] adding gclib for node 20

• - [misc] improve test stability

• - Merge branch 'master' into develop

• - [] DMLs are not returning any output when streaming #293

• - [] Parsec authentication implementation

Download Release Notes Changelog

Release date: 3 Jul 2025

For the highlights of this release, see the release notes.

The revision number links will take you to the revision's page on GitHub. On GitHub you can view more details of the revision and view diffs of the code modified in that revision.

• Revision #831fd11 bump 3.4.4

• [] TypeScript types/share.d.ts and types/callback.d.ts are not published

Release date: 2 Jul 2025

For the highlights of this release, see the .

The revision number links will take you to the revision's page on GitHub. On you can view more details of the revision and view diffs of the code modified in that revision.

• [misc] update CHANGELOG

| | |

Release date: 16 Oct 2023

For the highlights of this release, see the .

The revision number links will take you to the revision's page on GitHub. On you can view more details of the revision and view diffs of the code modified in that revision.

• - [misc] restrict capabilities to server capabilities

• - Merge tag '3.2.2' into develop

| | |

Release date: 30 Jun 2021

For the highlights of this release, see the .

The revision number links will take you to the revision's page on GitHub. On you can view more details of the revision and view diffs of the code modified in that revision.

• [misc] exact number implementation compatibility correction

• [misc] travis mariadb enterprise test

Download | Release Notes | Changelog |

Release date: 17 Mar 2023

For the highlights of this release, see the release notes.

The revision number links will take you to the revision's page on GitHub. On GitHub you can view more details of the revision and view diffs of the code modified in that revision.

• Revision #8dcad1a Merge tag '3.1.1' into develop

• Revision #c00e0f1 Merge branch 'release/3.1.1'

• Bump 3.1.1 version

• [] pool not listening to 'error' event might exit application on error #180

• [] batch not talking in account metaAsArray option when not using bulk

• [] batch failing when using bulk and metaAsArray #235

• [] correction for node.js 12 compatibility

• [] test correction

• [] following up correction, emptying prepare statement cache on pool connection reset

• Merge branch 'master' into develop

• Fix eslint warnings

• Fix test-execute.js

• [misc] xpand 6.1 testing

• Merge tag '3.1.0' into develop

| | |

Release date: 27 Oct 2022

For the highlights of this release, see the .

The revision number links will take you to the revision's page on GitHub. On you can view more details of the revision and view diffs of the code modified in that revision.

• [misc] code coverage correction

• Merge branch 'release/3.0.2'

| | |

Release date: 19 Jun 2023

For the highlights of this release, see the .

The revision number links will take you to the revision's page on GitHub. On you can view more details of the revision and view diffs of the code modified in that revision.

• - [] adding SqlError sqlMessage property alias for text

• - Merge tag '3.2.0' into develop

| | |

Release date: 21 Mar 2024

For the highlights of this release, see the .

The revision number links will take you to the revision's page on GitHub. On you can view more details of the revision and view diffs of the code modified in that revision.

• - [misc] changelog update

• - Merge branch 'master' into develop

| | |

Release date: 19 Dec 2023

For the highlights of this release, see the .

The revision number links will take you to the revision's page on GitHub. On you can view more details of the revision and view diffs of the code modified in that revision.

• Merge branch 'develop'

• [misc] add missing change log

| | |

Release date: 5 Jun 2024

For the highlights of this release, see the .

The revision number links will take you to the revision's page on GitHub. On you can view more details of the revision and view diffs of the code modified in that revision.

• [misc] code style correction

• bump 3.3.1

Download | Release Notes | Changelog |

Release date: 1 Mar 2022

For the highlights of this release, see the release notes.

The revision number links will take you to the revision's page on GitHub. On GitHub you can view more details of the revision and view diffs of the code modified in that revision.

• Revision #42e503f bump 2.5.6

• Revision #f0cd822 misc - test reliability improvement

• misc - test reliability improvement

• Merge branch 'develop' into maintenance/3.x

• misc - test reliability improvement

• misc - 2.5.6 correction merge

• Merge branch 'develop' into maintenance/3.x

• misc - update documentation with for-await-of use #189

• misc - update maxscale test load local infile

• misc - update maxscale test for 6.2.0

• misc - update maxscale test for 6.2.0 add PAM test for maxscale (using dedicated port)

• - consider BIT(1) as boolean option bitOneIsBoolean permit to disable that behavior for compatibility

• misc - pool ensuring multi-request process order

• misc - stored procedure tests async

• misc - documentation improvement indicating that connection.release() is async

• misc - set parser function once per result-set

• misc - correct character_set_client unexpect error parsing OK_Packet #177

• misc - ensure test reliability

• - change default connection timeout value to 1000ms

• misc - ensuring test stream close

• - fix local infile file name validation for windows #183

• misc - ensuring test stream close

• - fix local infile file name validation for windows #183

• Updating documentation and README examples using mostly async/await

• Merge branch 'develop' into maintenance/3.x

• Merge branch 'typescript_fix_missing_event' into develop

• - fix missing event handler #186

• Updating documentation and README examples using mostly async/await

• adding 10.7 test to travis

• Merge branch 'release/2.5.5'

• Merge tag '2.5.5' into develop

• bump 2.5.5 version

• [] Missing leakDetectionTimeout option in Typescript description #169

• [misc] correct changelog

• [misc] test reliability improvement

• [misc] correct travis link

Download | Release Notes | Changelog |

Release date: 14 Sep 2023

For the highlights of this release, see the release notes.

The revision number links will take you to the revision's page on GitHub. On GitHub you can view more details of the revision and view diffs of the code modified in that revision.

• Revision #2b012a6 Merge tag '3.2.1' into develop

• Revision #ab2774b Merge branch 'release/3.2.1'

• bump 3.2.1

• bump dependencies

• Merge branch 'master' into develop

• [misc] code style correction

• [] Option infileStreamFactory addition for compatibility

• [misc] correct travis environment

• [misc] remove useless template literals

• [misc] test stability improvement

• [misc] test stability improvement

• [misc] updating to jammy, permitting to correct docker issues with test suite

• [] permit configuration of console warning message #249

• [misc] maxscale testing improvement

• [misc] update ES test from 23.07 to 23.08

• [misc] update ES test from 23.06 to 23.07

• [misc] adding mariadb server ES23.06 testing

• [misc] adding mariadb server 11.1 testing

• [misc] ensure maxscale test stability

• [misc] temporary disable skysql testing as mandator

• [] ensure respecting server collation when no charset/collation is set

• [misc] ensure ssl test suite for all server version

• [misc] ensure test suite for any max_allowed_packet server

• [misc] benchmark fair comparison between text and binary

• [] Binary result-set parsing performance improvement

• [misc] test correction

• [misc] test addition in order to test namedPlaceholders array parameters

• [] TypeScript missing logParam connection option #247

• [misc] setting copyright header

• [misc] updating supported MariaDB servers in test suite

• [misc] documentation correction for cluster load-balancing parameter

Download | Release Notes | Changelog |

Release date: 26 Jul 2022

For the highlights of this release, see the release notes.

The revision number links will take you to the revision's page on GitHub. On GitHub you can view more details of the revision and view diffs of the code modified in that revision.

• Revision #59da962 - [misc] improving changelog for 3.0.1 release

• Revision #66dc988 - [misc] updating changelog for 3.0.1 release

• - [misc] test suite correction for CS build version

• - [] return type for batch() is wrong on typescript

• - [misc] adding initial SQL command 'SET NAMES UTF8' for xpand until correction

• - [misc] travis test adding suite

• - [misc] adding MariaDB enterprise 10.4/10.5 to travis test suite

• - [misc] correct travis benchmark run

• - [] benchmark result update with recent driver version

• - [misc] readme update

• - [] benchmarks simplification

• - [misc] test improvement

• - [misc] test correction after commit 4232e617b325d23b0cd571434ee9987a398aeb82

• - [] metadata parsing improvement

• - [] initializing smaller buffer streaming sending buffer, in order to maximize use of node buffer pool

• - [] avoiding buffer copy when receiving data when packet is contained in socket data

• - [] multi-rows result-set performance improvement

• - [misc] benchmark improvement - real pipelining test

• - [misc] benchmark improvement

• - [] small performance improvement

• - [misc] connection correction after #a862d8dbf7d9727d34fe4bb4f75f0846102d6ea3

• - [] 3.0 regression on release connection #195

• - [] permitting Batch with trace when BULK is not supported

• - [] trace option complete implementation

• - [misc] correct README image links

• - [misc] test proxy suspending remote correction

• - [misc] test proxy correction

• - [misc] test proxy improvement

• - [misc] adding 10.8 and 10.9 build testing

• - [misc] pool ending, ensuring connection creation are ended correctly

• - [misc] various micro enhancement * pool: connection validation check isValid, correcting cases when a connection wasn't valid returning no response. * cluster: ensure that when option canRetry is enable to not loop eternally if pool doesn't have connection anymore cluster end promise really returns Promise when pools are closed * add test for cluster with one node only / or one node working only

• - [] better pool error identification when leakDetectionTimeout is set

• - [] better pool error identification

• - [misc] ensure pool connection is released only once

• - [misc] code coverage addition

• - [misc] code coverage addition

• - [] possible race condition on connection destroy when no other connection can be created

• - [misc] test addition to ensure SSL when required will throw an error if server does not support SSL

• - [misc] test addition to ensure SSL when required will throw an error if server does not support SSL

• - [misc] remove forcing error on connection creation, server will throw error when expected.

• - [misc] code coverage addition

• - [] query hanging when using batch with option timeout in place of error thrown

• - [] handle password array with server pam_use_cleartext_plugin

• - [] encoding error when using changeUser with connection attributes

• - [misc] adding test coverage

• - [] better support for pre-4.1 error message format

• - [misc] test correction

• - [] typecast geometry parsing error

• - [misc] add test coverage

• - [misc] removing 10.2 EOL from travis

• - [misc] travis testing correction for node.js 18

• - [misc] changing travis test for node.js 18 to focal

• - [] new option addition checkNumberRange to works with insertIdAsNumber/decimalAsNumber/bigIntAsNumber #201

• - [] Improve pool connection error messaging

• - Merge branch 'master' into develop

• - [misc] small performance enhancement to handle active connection counter

• - [] node.js 18 testing

• - misc code style correction

• - reporting leak message change #190

• - Merge branch 'maintenance/2.x' into develop

• - [] add test case to avoid regression #196

• - fix "cannot mix BigInt and other types" error

• - [] Charset change using parameterized query fails with "Uncaught TypeError: opts.emit is not a function"

• - bump 3.0.1 version

• - [] wrong error returned "Cannot read properties of undefined (reading 'charset')" when wrong handshake

• - correct documentation link

• - [] support xpand * handle TIMESTAMP type for xpand * support binary xpand 0000-00-00 00:00:00 values * Timestamp microsecond handling when using binary protocol

• - docs: apply new default connectione timeout

• - [misc] improving test reliability

• - Merge branch 'master' into develop

• - [misc] remove old node.js compatibility

• - Merge tag '3.0.0-main' into develop

• - Merge branch 'release/3.0.0-main'

• - Update pool-base.js

• - Update pool-base.js

Download | Release Notes | Changelog |

Release date: 15 Feb 2023

For the highlights of this release, see the release notes.

The revision number links will take you to the revision's page on GitHub. On GitHub you can view more details of the revision and view diffs of the code modified in that revision.

• Revision #3d3cdc6 Merge branch 'release/3.1.0'

• Revision #982a6a1 [misc] changelog update

• [] ensuring PREPARE state when caching

• [] metaAsArray missing option in typescript description

• [misc] benchmark initialization correction

• [misc] update benchmark result for 3.1.0

• [misc] bench label correction

• [misc] test correction for windows

• Merge tag '3.1.0' into develop

• Merge branch 'release/3.1.0'

• bump 3.1.0 version

• [misc] benchmark update with recent version * benchmark charset option change * label correction

• [misc] test correction

• [misc] ensure pools ending active connections after a maximum of 10s after pool ends

• [] ensure when using callback connection that pre-commands are executed first

• [misc] test improvement

• [] faster execution for known length packet

• [misc] correcting place of prepare parser

• [misc] ensuring disabling nagle algorithm setting option

• [misc] faster Text Date encoder

• [misc] avoid unnecessary array creation for multiple result-set with metaAsArray enabled

• [msic] avoid unnecessary try catch when parsing OK_Packet + fast path for single result

• [msic] avoid connection.addCommand returning unnecessary command object

• [msic] avoid unnecessary binding wrapper

• [] correct encoding lost and avoid buffer copying

• [misc] test stability improvement

• [] test stability improvement, when server doesn't have timezone entries filled

• [] improve metadata parsing

• [misc] remove deprecated use of Buffer.slice

• [] Timezone option improvement

• [misc] code correction: * correct documented method parameters * remove unused requirement * remove unused parameters

• [misc] set testing limit to max_allowed_packet to 50M, to avoid suite running for hours

• [misc] test correction

• [misc] improve contribution guide

• [misc] improve test reliability

• Merge branch 'master' into develop

• [misc] correcting cast documentation

• [] binary TIME wrong decoding

• [] allow to pass TypeScript generic type

• Merge branch 'p-kuen_patch-1' into develop

• Merge branch 'master' into develop

• docs: update new default value of connectTimeout since v2.5.6

• Merge branch 'master' into develop

• Merge branch 'fix/modify-entries-method' into develop

• [misc] small markdown correction

• [misc] test correction for mysql that doesn't support sha256_password anymore

• Allow to pass type to query function

• [misc] test correction for mysql that doesn't support sha256_password anymore

• Merge pull request #223

• [misc] test correction for mysql that doesn't support sha256_password anymore

• docs: reformat documentation of pool options

• docs: reformat documentation of pool options

• [misc] test correction

• [misc] code style correction

• [] killing connection when query are running fails

• [] BULK command when reaching maximum packet size might be wrongly split

• [misc] removing request SHA certificate since failing 5.7.40 / 8.0.31 without any reason

• Modify unneeded Object.entries()

• [misc] binary number read parsing small improvement

• [misc] ensure prepare cache use counter

• [misc] prepare parameter count correction

• [misc] Date parameter identification using instanceof Date that is more performant than Object.prototype.toString.call(val) === '[object Date]'

• [misc] avoid filling intermediary buffer when not required

• [] avoid parsing PREPARE parameters meta. keeping only parameter number

• [misc] avoid unnecessary parameters

• [misc] adding test

• [misc] fast path when TCP-IP packet contains multiple MySQL Packets

• [] performance improvement, Column information name information being saved in a fit Buffer and avoid creating subpacket when not needed

• [misc] BigInt literal

• [misc] performance improvement for bigIntAsNumber option

• [misc] add maxscale error lof when failing

• [misc] benchmark name correction

• [misc] result-set rows improvement, since at least one value

• [] code style correction

• [] performance issue when parsing lots of parameter

• [misc] code style correction

• Merge branch 'master' into develop

• [misc] code coverage correction

• merge 3.0.2 version

• [] add missing metaAsArray documentation and typescript option

• [] Make result set's meta property non-enumerable

| | |

Release date: 2 Apr 2025

For the highlights of this release, see the .

The revision number links will take you to the revision's page on GitHub. On you can view more details of the revision and view diffs of the code modified in that revision.

• bump 3.4.1 version

• [misc] pool throwing first error of connection/reconnection loop, to avoid having minimal timeout of last try

Download | Release Notes | Changelog |

Release date: 20 Oct 2021

For the highlights of this release, see the release notes.

The revision number links will take you to the revision's page on GitHub. On GitHub you can view more details of the revision and view diffs of the code modified in that revision.

• Revision #d78ba3b [CONJS-180] compatibility: support mysql2 stream option #173

• Merge branch 'features/' into maintenance/3.x

• [] Update code to recent node.js version

• [] Update code to recent node.js version

• [] Update code to recent node.js version

• [misc] benchmark output result correction

• [] better pool option resetAfterUse default value

• [] Update code to recent node.js version

• [] Update code to recent node.js version

• [misc] code style length change to 120

• [misc] Error code simplification + pool timeout handler simplification

• [misc] promise documentation improvement

• [] test correction for mysql

• [] document retrieving stored procedure's output parameters #90

• [] Missing leakDetectionTimeout option in Typescript description #169

• [misc] correct changelog

• [misc] test reliability improvement

• [] Pool.query/execute/batch(undefined) never release connection

• [] Change Pool cluster default option removeNodeErrorCount value to Infinity

• [misc] documentation link correction

• [misc] Normalize all the line endings

• [] permit using batch with returning clause

• Merge branch 'develop' into maintenance/3.x

• [misc] travis correction

• [misc] ensuring PR test suite runs correctly

• [misc] ensuring PR test suite runs correctly

• [] permitting providing null as a value without an array

• [] permitting providing null as a value without an array

• bump 3.0.1-rc version

• [misc] benchmark commenting graph command

• [misc] benchmark improvement and update to recent version of mysql compatible drivers

• [misc] collation default setting improvement

• [misc] benchmark addition: query using pool

• [] performance improvement. * using mutable Packet object to avoid creating a new Object for each packet. * set column data on creation, to avoid resolving data type parsing for each data. * BIGINT parsing improvement, avoiding parsing data as text * ensure using execute command option * using undefined in place of 'utf8' to parse String when using node.js, avoiding name resolution

• [misc] ensure testing on PR runs standard test

• [misc] documentation addition for non supported experimental ?? syntax

• [] correct stream backpressure

• [misc] ensure test reliability on windows

• [misc] permit prettier fixing

• [misc] ensure test reliability

• Merge branch 'develop'

• [misc] ensure test reliability

• [misc] ensure test reliability with maxscale/skysql ha

• Merge branch 'master' into develop

• [misc] ensure PR travis test

• [misc] ensure PR travis test

• Merge tag '2.5.4' into develop

• Merge branch 'release/2.5.4'

• [misc] travis test on node.js v16