How do I connect to MySQL using Node.js with X DevAPI?

Install the @mysql/xdevapi package via npm with exact versioning, then use the X DevAPI's session.create() method. Refer to the official documentation for code examples on establishing connections and performing operations.

MySQL Connector/Node.js vs mysql2: which one should I use?

Choose MySQL Connector/Node.js if you need MySQL 8's Document Store features, official Oracle support, or hybrid SQL/NoSQL access. Use mysql2 for basic SQL queries, older MySQL versions, or lighter dependency overhead.

Can I use this with MySQL 5.7?

No, it only supports MySQL 8 and later, as it relies on features like the X DevAPI and Document Store that are not available in MySQL 5.7. You'll need a different driver for older versions.

How to perform CRUD operations on JSON documents with this connector?

Use the X DevAPI's collection methods, such as add(), find(), modify(), and remove(), on MySQL collections. The documentation provides specific examples for NoSQL-style document handling.

Is MySQL Connector/Node.js production ready?

Yes, it's designed for production use with comprehensive documentation and Oracle backing, but be cautious with version updates due to non-semantic versioning, and use lockfiles as advised.

What are the licensing terms for MySQL Connector/Node.js?

It uses GPLv2 with a FOSS exception, allowing free use in open-source and commercial projects, but review the LICENSE file for details to ensure compliance with your project's needs.

Open-Awesome

MySQL Connector/Node.js

NOASSERTIONJavaScript

Official MySQL 8 driver for Node.js implementing the X DevAPI for NoSQL document store operations.

GitHub

160 stars34 forks0 contributors

What is MySQL Connector/Node.js?

MySQL Connector/Node.js is the official MySQL 8 driver for Node.js applications, developed and maintained by Oracle. It implements the X DevAPI to provide both SQL and NoSQL access to MySQL databases, specifically enabling interaction with the MySQL Document Store through CRUD-based operations. This allows developers to work with JSON documents in a NoSQL fashion while still leveraging MySQL's relational capabilities.

Target Audience

Node.js developers building applications that need to connect to MySQL 8 databases, particularly those wanting to use the MySQL Document Store for NoSQL document operations alongside traditional SQL queries.

Value Proposition

Developers choose this connector because it's the officially supported MySQL driver for Node.js, ensuring reliability, compatibility, and direct support from Oracle. Its implementation of the X DevAPI provides a modern, unified interface for both document and relational data access within MySQL 8.

Overview

MySQL Connector Node.JS is a MySQL Connector using the X Protocol, which was introduced with MySQL 5.7.12.

Use Cases

Best For

Building Node.js applications that require official MySQL 8 database connectivity
Implementing NoSQL document storage using MySQL's Document Store features
Developing applications that need hybrid SQL and NoSQL data access patterns
Projects requiring Oracle-supported MySQL drivers for production environments
Migrating existing MySQL applications to Node.js with modern API access
Leveraging MySQL 8's JSON capabilities through a fluent, CRUD-based interface

Not Ideal For

Projects using MySQL versions older than 8.0 (e.g., 5.x)
Teams that rely strictly on Semantic Versioning for dependency management
Applications needing only basic SQL access without NoSQL or Document Store features

Pros & Cons

Pros

Official Oracle Support

Maintained directly by Oracle, ensuring reliability, compatibility, and regular updates for MySQL 8, as stated in the GitHub description.

Modern X DevAPI

Implements the X DevAPI for a fluent, CRUD-based interface, enabling NoSQL operations on the MySQL Document Store alongside traditional SQL access.

Cross-Platform Compatibility

Runs on any operating system with Node.js 14.0.0 or higher, making it versatile for different deployment environments.

Hybrid Data Access

Bridges relational and document-oriented models, allowing developers to leverage MySQL 8's JSON capabilities through a unified API.

Cons

Non-Semantic Versioning

Releases do not follow Semantic Versioning rules, complicating dependency management and requiring lockfiles, as warned in the README.

MySQL 8 Exclusive

Only compatible with MySQL 8 databases, limiting use with older versions or other database systems, which restricts migration options.

Complexity Overhead

For SQL-only use cases, the X DevAPI and Document Store features add unnecessary learning curve and bloat compared to simpler drivers like mysql2.

Frequently Asked Questions

Related Projects

MySQL

A pure node.js JavaScript Client implementing the MySQL protocol.

Stars18,623

Forks2,519

Last commit2 years ago

go-sql-driver

Go MySQL Driver is a MySQL driver for Go's (golang) database/sql package

MySQL client library for Python

Stars7,844

Forks1,440

Last commit2 days ago

mysqlclient

MySQL/MariaDB connector for Python

Stars2,531

Forks445

Last commit28 days ago

Community-curated · Updated weekly · 100% open source

Found a gem we're missing?

Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.

Submit a project Star on GitHub