Gathering detailed insights and metrics for mysql2
Gathering detailed insights and metrics for mysql2
âš¡ fast mysqljs/mysql compatible mysql driver for node.js
Installations
npm install mysql2Developer
Developer Guide
BETA
Module System
CommonJS, ESM
Min. Node Version
>= 8.0
Typescript Support
No
Node Version
20.18.0
NPM Version
10.8.2
Statistics
4,091 Stars
3,322 Commits
624 Forks
59 Watching
22 Branches
212 Contributors
Updated on 27 Nov 2024
Languages
JavaScript (93.11%)
TypeScript (6.87%)
Shell (0.02%)
HTML (0.01%)
Total Downloads
Cumulative downloads
Total Downloads
327,811,003
Last day
5%
493,868
Compared to previous day
Last week
5.4%
2,837,666
Compared to previous week
Last month
1%
11,615,859
Compared to previous month
Last year
62.8%
125,156,780
Compared to previous year
Daily Downloads
Weekly Downloads
Monthly Downloads
Yearly Downloads
Dependencies
9
Versions
MySQL2
English | 简体ä¸æ–‡ | Português (BR)
MySQL client for Node.js with focus on performance. Supports prepared statements, non-utf8 encodings, binary log protocol, compression, ssl much more.
Table of Contents
History and Why MySQL2
MySQL2 project is a continuation of MySQL-Native. Protocol parser code was rewritten from scratch and api changed to match popular Node MySQL. MySQL2 team is working together with Node MySQL team to factor out shared code and move it under mysqljs organization.
MySQL2 is mostly API compatible with Node MySQL and supports majority of features. MySQL2 also offers these additional features:
- Faster / Better Performance
- Prepared Statements
- MySQL Binary Log Protocol
- MySQL Server
- Extended support for Encoding and Collation
- Promise Wrapper
- Compression
- SSL and Authentication Switch
- Custom Streams
- Pooling
Installation
MySQL2 is free from native bindings and can be installed on Linux, Mac OS or Windows without any issues.
1npm install --save mysql2
If you are using TypeScript, you will need to install @types/node.
1npm install --save-dev @types/node
For TypeScript documentation and examples, see here.
Documentation
Acknowledgements
- Internal protocol is written by @sidorares MySQL-Native.
- Constants, SQL parameters interpolation, Pooling,
ConnectionConfigclass taken from Node MySQL. - SSL upgrade code based on @TooTallNate code.
- Secure connection / compressed connection api flags compatible to MariaSQL client.
- Contributors.
Contributing
Want to improve something in MySQL2? Please check Contributing.md for detailed instruction on how to get started.
To contribute in MySQL2 Documentation, please visit the Website Contributing Guidelines for detailed instruction on how to get started.
Stable Version
The latest stable version of the package.
Stable Version
3.11.4
CRITICAL
2
CRITICAL
9.8/10
Summary
MySQL2 for Node Arbitrary Code Injection
Affected Versions
< 3.9.7
Patched Versions
3.9.7
CRITICAL
9.8/10
Summary
mysql2 Remote Code Execution (RCE) via the readCodeFor function
Affected Versions
< 3.9.4
Patched Versions
3.9.4
HIGH
1
HIGH
8.2/10
Summary
mysql2 vulnerable to Prototype Pollution
Affected Versions
< 3.9.8
Patched Versions
3.9.8
MODERATE
2
MODERATE
6.5/10
Summary
mysql2 vulnerable to Prototype Poisoning
Affected Versions
< 3.9.4
Patched Versions
3.9.4
MODERATE
6.5/10
Summary
mysql2 cache poisoning vulnerability
Affected Versions
< 3.9.3
Patched Versions
3.9.3
Reason
30 commit(s) and 11 issue activity found in the last 90 days -- score normalized to 10
Reason
security policy file detected
Details
- Info: security policy file detected: SECURITY.md:1
- Info: Found linked content: SECURITY.md:1
- Info: Found disclosure, vulnerability, and/or timelines in security policy: SECURITY.md:1
- Info: Found text in security policy: SECURITY.md:1
Reason
no dangerous workflow patterns detected
Reason
no binaries found in the repo
Reason
license file detected
Details
- Info: project has a license file: License:0
- Info: FSF or OSI recognized license: MIT License: License:0
Reason
packaging workflow detected
Details
- Info: Project packages its releases by way of GitHub Actions.: .github/workflows/canary.yml:15
Reason
SAST tool detected but not run on all commits
Details
- Info: SAST configuration detected: CodeQL
- Warn: 29 commits out of 30 are checked with a SAST tool
Reason
2 existing vulnerabilities detected
Details
- Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
- Warn: Project is vulnerable to: GHSA-3h5v-q93c-6h6q
Reason
Found 2/3 approved changesets -- score normalized to 6
Reason
dependency not pinned by hash detected -- score normalized to 4
Details
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/benchmark.yml:29: update your workflow using https://app.stepsecurity.io/secureworkflow/sidorares/node-mysql2/benchmark.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/benchmark.yml:34: update your workflow using https://app.stepsecurity.io/secureworkflow/sidorares/node-mysql2/benchmark.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/benchmark.yml:39: update your workflow using https://app.stepsecurity.io/secureworkflow/sidorares/node-mysql2/benchmark.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/benchmark.yml:55: update your workflow using https://app.stepsecurity.io/secureworkflow/sidorares/node-mysql2/benchmark.yml/master?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/benchmark.yml:61: update your workflow using https://app.stepsecurity.io/secureworkflow/sidorares/node-mysql2/benchmark.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/canary.yml:21: update your workflow using https://app.stepsecurity.io/secureworkflow/sidorares/node-mysql2/canary.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/canary.yml:51: update your workflow using https://app.stepsecurity.io/secureworkflow/sidorares/node-mysql2/canary.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/canary.yml:58: update your workflow using https://app.stepsecurity.io/secureworkflow/sidorares/node-mysql2/canary.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci-coverage.yml:33: update your workflow using https://app.stepsecurity.io/secureworkflow/sidorares/node-mysql2/ci-coverage.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci-coverage.yml:40: update your workflow using https://app.stepsecurity.io/secureworkflow/sidorares/node-mysql2/ci-coverage.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci-coverage.yml:45: update your workflow using https://app.stepsecurity.io/secureworkflow/sidorares/node-mysql2/ci-coverage.yml/master?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/ci-coverage.yml:62: update your workflow using https://app.stepsecurity.io/secureworkflow/sidorares/node-mysql2/ci-coverage.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci-linux.yml:131: update your workflow using https://app.stepsecurity.io/secureworkflow/sidorares/node-mysql2/ci-linux.yml/master?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/ci-linux.yml:136: update your workflow using https://app.stepsecurity.io/secureworkflow/sidorares/node-mysql2/ci-linux.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci-linux.yml:141: update your workflow using https://app.stepsecurity.io/secureworkflow/sidorares/node-mysql2/ci-linux.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci-linux.yml:145: update your workflow using https://app.stepsecurity.io/secureworkflow/sidorares/node-mysql2/ci-linux.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci-linux.yml:185: update your workflow using https://app.stepsecurity.io/secureworkflow/sidorares/node-mysql2/ci-linux.yml/master?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/ci-linux.yml:190: update your workflow using https://app.stepsecurity.io/secureworkflow/sidorares/node-mysql2/ci-linux.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci-linux.yml:195: update your workflow using https://app.stepsecurity.io/secureworkflow/sidorares/node-mysql2/ci-linux.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci-linux.yml:199: update your workflow using https://app.stepsecurity.io/secureworkflow/sidorares/node-mysql2/ci-linux.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci-linux.yml:33: update your workflow using https://app.stepsecurity.io/secureworkflow/sidorares/node-mysql2/ci-linux.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci-linux.yml:40: update your workflow using https://app.stepsecurity.io/secureworkflow/sidorares/node-mysql2/ci-linux.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci-linux.yml:45: update your workflow using https://app.stepsecurity.io/secureworkflow/sidorares/node-mysql2/ci-linux.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci-linux.yml:75: update your workflow using https://app.stepsecurity.io/secureworkflow/sidorares/node-mysql2/ci-linux.yml/master?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/ci-linux.yml:80: update your workflow using https://app.stepsecurity.io/secureworkflow/sidorares/node-mysql2/ci-linux.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci-linux.yml:85: update your workflow using https://app.stepsecurity.io/secureworkflow/sidorares/node-mysql2/ci-linux.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci-linux.yml:89: update your workflow using https://app.stepsecurity.io/secureworkflow/sidorares/node-mysql2/ci-linux.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci-mysql.yml:45: update your workflow using https://app.stepsecurity.io/secureworkflow/sidorares/node-mysql2/ci-mysql.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci-mysql.yml:52: update your workflow using https://app.stepsecurity.io/secureworkflow/sidorares/node-mysql2/ci-mysql.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci-mysql.yml:57: update your workflow using https://app.stepsecurity.io/secureworkflow/sidorares/node-mysql2/ci-mysql.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci-osx.yml:28: update your workflow using https://app.stepsecurity.io/secureworkflow/sidorares/node-mysql2/ci-osx.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci-osx.yml:39: update your workflow using https://app.stepsecurity.io/secureworkflow/sidorares/node-mysql2/ci-osx.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci-osx.yml:44: update your workflow using https://app.stepsecurity.io/secureworkflow/sidorares/node-mysql2/ci-osx.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci-tsc-build.yml:20: update your workflow using https://app.stepsecurity.io/secureworkflow/sidorares/node-mysql2/ci-tsc-build.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci-tsc-build.yml:23: update your workflow using https://app.stepsecurity.io/secureworkflow/sidorares/node-mysql2/ci-tsc-build.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci-tsc-build.yml:28: update your workflow using https://app.stepsecurity.io/secureworkflow/sidorares/node-mysql2/ci-tsc-build.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci-website.yml:13: update your workflow using https://app.stepsecurity.io/secureworkflow/sidorares/node-mysql2/ci-website.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci-website.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/sidorares/node-mysql2/ci-website.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci-website.yml:21: update your workflow using https://app.stepsecurity.io/secureworkflow/sidorares/node-mysql2/ci-website.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci-windows.yml:29: update your workflow using https://app.stepsecurity.io/secureworkflow/sidorares/node-mysql2/ci-windows.yml/master?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/ci-windows.yml:31: update your workflow using https://app.stepsecurity.io/secureworkflow/sidorares/node-mysql2/ci-windows.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci-windows.yml:36: update your workflow using https://app.stepsecurity.io/secureworkflow/sidorares/node-mysql2/ci-windows.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql-analysis.yml:42: update your workflow using https://app.stepsecurity.io/secureworkflow/sidorares/node-mysql2/codeql-analysis.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql-analysis.yml:46: update your workflow using https://app.stepsecurity.io/secureworkflow/sidorares/node-mysql2/codeql-analysis.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql-analysis.yml:57: update your workflow using https://app.stepsecurity.io/secureworkflow/sidorares/node-mysql2/codeql-analysis.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql-analysis.yml:71: update your workflow using https://app.stepsecurity.io/secureworkflow/sidorares/node-mysql2/codeql-analysis.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/gh-pages.yml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/sidorares/node-mysql2/gh-pages.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/gh-pages.yml:18: update your workflow using https://app.stepsecurity.io/secureworkflow/sidorares/node-mysql2/gh-pages.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/gh-pages.yml:23: update your workflow using https://app.stepsecurity.io/secureworkflow/sidorares/node-mysql2/gh-pages.yml/master?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/gh-pages.yml:42: update your workflow using https://app.stepsecurity.io/secureworkflow/sidorares/node-mysql2/gh-pages.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/lint.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/sidorares/node-mysql2/lint.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/lint.yml:18: update your workflow using https://app.stepsecurity.io/secureworkflow/sidorares/node-mysql2/lint.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/lint.yml:23: update your workflow using https://app.stepsecurity.io/secureworkflow/sidorares/node-mysql2/lint.yml/master?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/release.yml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/sidorares/node-mysql2/release.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:22: update your workflow using https://app.stepsecurity.io/secureworkflow/sidorares/node-mysql2/release.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:25: update your workflow using https://app.stepsecurity.io/secureworkflow/sidorares/node-mysql2/release.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:32: update your workflow using https://app.stepsecurity.io/secureworkflow/sidorares/node-mysql2/release.yml/master?enable=pin
- Warn: npmCommand not pinned by hash: .github/workflows/lint.yml:31
- Info: 0 out of 49 GitHub-owned GitHubAction dependencies pinned
- Info: 0 out of 8 third-party GitHubAction dependencies pinned
- Info: 13 out of 14 npmCommand dependencies pinned
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
detected GitHub workflow tokens with excessive permissions
Details
- Info: jobLevel 'actions' permission set to 'read': .github/workflows/codeql-analysis.yml:28
- Info: jobLevel 'contents' permission set to 'read': .github/workflows/codeql-analysis.yml:29
- Warn: no topLevel permission defined: .github/workflows/benchmark.yml:1
- Warn: topLevel 'contents' permission set to 'write': .github/workflows/canary.yml:10
- Warn: no topLevel permission defined: .github/workflows/ci-coverage.yml:1
- Warn: no topLevel permission defined: .github/workflows/ci-linux.yml:1
- Warn: no topLevel permission defined: .github/workflows/ci-mysql.yml:1
- Warn: no topLevel permission defined: .github/workflows/ci-osx.yml:1
- Warn: no topLevel permission defined: .github/workflows/ci-tsc-build.yml:1
- Warn: no topLevel permission defined: .github/workflows/ci-website.yml:1
- Warn: no topLevel permission defined: .github/workflows/ci-windows.yml:1
- Warn: no topLevel permission defined: .github/workflows/codeql-analysis.yml:1
- Warn: no topLevel permission defined: .github/workflows/gh-pages.yml:1
- Warn: no topLevel permission defined: .github/workflows/lint.yml:1
- Warn: topLevel 'contents' permission set to 'write': .github/workflows/release.yml:8
- Info: no jobLevel write permissions found
Reason
branch protection not enabled on development/release branches
Details
- Warn: branch protection not enabled for branch 'master'
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Score
6.4
/10
Last Scanned on 2024-11-18
The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.
Learn More