Skip to content
MySQL Connector Node.JS is a MySQL Connector using the X Protocol, which was introduced with MySQL 5.7.12.
Branch: master
Clone or download
Latest commit 4cf4bb2 Jan 25, 2019
Type Name Latest commit message Commit time
Failed to load latest commit information.
bin WL#12296: script to generate source and package metadata Oct 9, 2018
lib BUG#28745240: fix issues with Collection.existsInDatabase() Dec 4, 2018
test tests: simplify docker test suite environment Jan 25, 2019
.gitignore WL#12296: script to generate source and package metadata Oct 9, 2018
LICENSE 8.0.14 Dec 10, 2018 8.0.14 Dec 10, 2018
index.js WL#11831: add support for connection pooling Sep 19, 2018

MySQL Connector/Node.js with X DevAPI

The Node.js Connector is an asynchronous promise-based client library for the X DevAPI (using the X Protocol) that was introduced in MySQL 5.7.12.

MySQL is an open-source relational database that is secure, high performing, and easy to use. The X DevAPI, besides a traditional SQL interface, also supports a CRUD API for working with relational tables and JSON documents making it possible to use both tables and document-store collections at the same time.

For general information about the X DevAPI, please refer to documentation on


This library requires Node.js 4.2.0 or higher and MySQL 8.0.11 or higher. You are able to use recent MySQL 5.7.x versions (with some limitations), however, MySQL 5.7 does not take advantage of the entire set of features provided by the connector.


This library is organized in a way that it can be installed into your project using Node.js's npm tool. Choose one of the following methods to get and install MySQL Connector/node.js:

$ npm install /path/to/mysql-connector-nodejs-<version>.tar.gz
$ npm install @mysql/xdevapi

Please refer to for more information on npm.

Getting Started

Using the MySQL document-store is as easy as follows:

'use strict';

const mysqlx = require('@mysql/xdevapi');

const options = {
  host: 'localhost',
  port: 33060,
  password: '<passwd>',
  user: 'root',
  schema: 'mySchema' // an error is thrown if it does not exist

  .then(session => {
    return session
  .then(collection => {
    return collection
      .add({ foo: 'bar' }, { baz: { qux: 'quux' } })
      .then(() => {
        return collection
          .find('foo = :value')
          .bind('value', 'bar')
      .then(() => {
        return collection
          .remove('baz.qux = :value')
          .bind('value', 'quux')
      .then(() => {
        return collection
      .then(() => {
        return collection
      .then(() => {
        return collection
  .catch(err => {

Check out the official documentation for more details.


Copyright (c) 2015, 2019, Oracle and/or its affiliates. All rights reserved.

This is a release of MySQL Connector/Node.js, Oracle's Node.js driver for MySQL.

License information can be found in the LICENSE file.

This distribution may include materials developed by third parties. For license and attribution notices for these materials, please refer to the LICENSE file.

For more information on MySQL Connector/Node.js, visit

For additional downloads and the source of MySQL Connector/Node.js, visit

MySQL Connector/Node.js is brought to you by the MySQL team at Oracle.

You can’t perform that action at this time.