# mysql2 > fast mysql driver. Implements core protocol, prepared statements, ssl and compression in native JS Latest version **3.24.4** (published 2026-09-08) · MIT license · 0 weekly downloads ## Install ```sh npm install mysql2 pnpm add mysql2 yarn add mysql2 bun add mysql2 ``` ## Health **Score 75/100 (B)** — status: active. Positive: has types; esm support; no vulnerabilities; has provenance; recently updated; high maintenance score; high quality score. Warnings: low downloads. ## Facts | | | |---|---| | Version | 3.24.4 | | Published | 2026-09-08 | | First published | 2013-04-17 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | bundled | | Module format | ESM + CommonJS | | Node | >= 8.0 | | Dependencies | 7 | | Unpacked size | 615.2 KB | | Known vulnerabilities | 0 | | Install scripts | no | | Provenance | attested (GitHub Actions) | | GitHub stars | 4385 | | Author | Andrey Sidorov | | Maintainers | sidorares | | Keywords | mysql, client, server | ## Links - npm: https://www.npmjs.com/package/mysql2 - Repository: https://github.com/sidorares/node-mysql2 - Homepage: https://sidorares.github.io/node-mysql2/docs - Issues: https://github.com/sidorares/node-mysql2/issues - npm.io page: https://npm.io/package/mysql2 ## Dependencies (7) - [long](https://npm.io/package/long.md) ^5.3.2 - [lru.min](https://npm.io/package/lru.min.md) ^1.1.4 - [iconv-lite](https://npm.io/package/iconv-lite.md) ^0.7.3 - [sql-escaper](https://npm.io/package/sql-escaper.md) ^1.5.1 - [aws-ssl-profiles](https://npm.io/package/aws-ssl-profiles.md) ^1.1.2 - [generate-function](https://npm.io/package/generate-function.md) ^2.3.1 - [named-placeholders](https://npm.io/package/named-placeholders.md) ^1.1.6 ## Alternatives - [launchdarkly-js-client-sdk](https://npm.io/package/launchdarkly-js-client-sdk.md) — 2.5M weekly downloads - [@elastic/elasticsearch](https://npm.io/package/@elastic/elasticsearch.md) — 2.1M weekly downloads - [@c8y/client](https://npm.io/package/@c8y/client.md) — 15.3K weekly downloads - [@signaldb/maverickjs](https://npm.io/package/@signaldb/maverickjs.md) — 1.7K weekly downloads - [@bbc/http-transport-cache](https://npm.io/package/@bbc/http-transport-cache.md) — 1.2K weekly downloads ## Recent versions - 3.24.4 (latest) — 2026-09-08 - 3.24.4-canary.e5833be (canary) — 2026-09-07 - 3.0.0-rc.1 (next) — 2022-11-06 - 2.0.0-alpha1 (beta) — 2019-10-13 - 3.24.4-canary.2387daf — 2026-09-06 - 3.24.4-canary.9178c82 — 2026-09-06 - 3.24.3 — 2026-09-02 - 3.24.3-canary.1281e1e — 2026-08-30 - 3.24.2 — 2026-08-24 - 3.24.2-canary.87579e1 — 2026-08-24 - 3.24.2-canary.1dcd8ef — 2026-08-24 - 3.24.2-canary.de56272 — 2026-08-24 - 3.24.1 — 2026-08-24 - 3.24.1-canary.183e947 — 2026-08-24 - 3.24.0 — 2026-08-23 - … 310 more at https://npm.io/package/mysql2/versions ## README [npm-image]: https://img.shields.io/npm/v/mysql2.svg [npm-url]: https://npmjs.com/package/mysql2 [node-version-image]: https://img.shields.io/node/v/mysql2.svg [node-version-url]: https://nodejs.org/en/download [downloads-image]: https://img.shields.io/npm/dm/mysql2.svg [downloads-url]: https://npmjs.com/package/mysql2 [license-url]: https://github.com/sidorares/node-mysql2/blob/master/License [license-image]: https://img.shields.io/npm/l/mysql2.svg?maxAge=2592000 [node-mysql]: https://github.com/mysqljs/mysql [mysqljs]: https://github.com/mysqljs [mysql-native]: https://github.com/sidorares/nodejs-mysql-native [sidorares]: https://github.com/sidorares [TooTallNate]: https://gist.github.com/TooTallNate [starttls.js]: https://gist.github.com/TooTallNate/848444 [node-mariasql]: https://github.com/mscdex/node-mariasql [contributors]: https://github.com/sidorares/node-mysql2/graphs/contributors [contributing]: https://github.com/sidorares/node-mysql2/blob/master/Contributing.md [docs-base]: https://sidorares.github.io/node-mysql2/docs [docs-base-zh-CN]: https://sidorares.github.io/node-mysql2/zh-CN/docs [docs-base-pt-BR]: https://sidorares.github.io/node-mysql2/pt-BR/docs [docs-prepared-statements]: https://sidorares.github.io/node-mysql2/docs/documentation/prepared-statements [docs-mysql-server]: https://sidorares.github.io/node-mysql2/docs/documentation/mysql-server [docs-promise-wrapper]: https://sidorares.github.io/node-mysql2/docs/documentation/promise-wrapper [docs-authentication-switch]: https://sidorares.github.io/node-mysql2/docs/documentation/authentication-switch [docs-streams]: https://sidorares.github.io/node-mysql2/docs/documentation/extras [docs-typescript-docs]: https://sidorares.github.io/node-mysql2/docs/documentation/typescript-examples [docs-qs-pooling]: https://sidorares.github.io/node-mysql2/docs#using-connection-pools [docs-qs-first-query]: https://sidorares.github.io/node-mysql2/docs#first-query [docs-qs-using-prepared-statements]: https://sidorares.github.io/node-mysql2/docs#using-prepared-statements [docs-examples]: https://sidorares.github.io/node-mysql2/docs/examples [docs-faq]: https://sidorares.github.io/node-mysql2/docs/faq [docs-documentation]: https://sidorares.github.io/node-mysql2/docs/documentation [docs-contributing]: https://sidorares.github.io/node-mysql2/docs/contributing/website [coverage]: https://img.shields.io/codecov/c/github/sidorares/node-mysql2 [coverage-url]: https://app.codecov.io/github/sidorares/node-mysql2 [ci-url]: https://github.com/sidorares/node-mysql2/actions/workflows/ci-coverage.yml?query=branch%3Amaster [ci-image]: https://img.shields.io/github/actions/workflow/status/sidorares/node-mysql2/ci-coverage.yml?event=push&style=flat&label=CI&branch=master # MySQL2 [![NPM Version][npm-image]][npm-url] [![NPM Downloads][downloads-image]][downloads-url] [![Node.js Version][node-version-image]][node-version-url] [![GitHub Workflow Status (with event)][ci-image]][ci-url] [![Codecov][coverage]][coverage-url] [![License][license-image]][license-url] [English][docs-base] | [简体中文][docs-base-zh-CN] | [Português (BR)][docs-base-pt-BR] > MySQL client for Node.js with focus on performance. Supports prepared statements, non-utf8 encodings, binary log protocol, compression, ssl [much more][docs-documentation]. **Table of Contents** - [History and Why MySQL2](#history-and-why-mysql2) - [Installation](#installation) - [Documentation](#documentation) - [Acknowledgements](#acknowledgements) - [Contributing](#contributing) ## History and Why MySQL2 MySQL2 project is a continuation of [MySQL-Native][mysql-native]. Protocol parser code was rewritten from scratch and api changed to match popular [Node MySQL][node-mysql]. MySQL2 team is working together with [Node MySQL][node-mysql] team to factor out shared code and move it under [mysqljs][mysqljs] organization. MySQL2 is mostly API compatible with [Node MySQL][node-mysql] and supports majority of features. MySQL2 also offers these additional features: - Faster / Better Performance - [Prepared Statements][docs-prepared-statements] - MySQL Binary Log Protocol - [MySQL Server][docs-mysql-server] - Extended support for Encoding and Collation - [Promise Wrapper][docs-promise-wrapper] - Compression - SSL and [Authentication Switch][docs-authentication-switch] - [Custom Streams][docs-streams] - [Pooling][docs-qs-pooling] ## Installation MySQL2 is free from native bindings and can be installed on Linux, Mac OS or Windows without any issues. ```bash npm install --save mysql2 ``` If you are using TypeScript, you will need to install `@types/node`. ```bash npm install --save-dev @types/node ``` > For TypeScript documentation and examples, see [here][docs-typescript-docs]. ## Documentation - [Quickstart][docs-base] - [First Query][docs-qs-first-query], [Using Prepared Statements][docs-qs-using-prepared-statements], [Using Connection Pools][docs-qs-pooling] and more. - [Documentation][docs-documentation] - [Examples][docs-examples] - [FAQ][docs-faq] ## Acknowledgements - Internal protocol is written by [@sidorares][sidorares] [MySQL-Native][mysql-native]. - Constants, SQL parameters interpolation, Pooling, `ConnectionConfig` class taken from [Node MySQL][node-mysql]. - SSL upgrade code based on [@TooTallNate][TooTallNate] [code][starttls.js]. - Secure connection / compressed connection api flags compatible to [MariaSQL][node-mariasql] client. - [Contributors][contributors]. ## Contributing Want to improve something in **MySQL2**? Please check [Contributing.md][contributing] for detailed instruction on how to get started. To contribute in **MySQL2 Documentation**, please visit the [Website Contributing Guidelines][docs-contributing] for detailed instruction on how to get started. --- _Source: https://npm.io/package/mysql2 · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._