You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Indospace.io 016aac6a73 node-types bump 1 month ago
.travis [misc] maxscale testing 10 4 bases 3 months ago
benchmarks [misc] correcting SSL test that now can use TLSv1.3 protocol for MariaDB 10.4 1 month ago
documentation [misc] adding changelog for 2.1.1 1 month ago
lib [misc] small performance improvement to avoid testing debug each packet 1 month ago
test [misc] test TLS minimum version change in order to test old mysql server with Node.js 12 1 month ago
tools [misc] changed max line length to 100 3 months ago
types [misc] type script correction for triple slash importation 1 month ago
.eslintrc test linefeed for windows 6 months ago
.gitignore add yarn.lock into gitigngore 9 months ago
.prettierrc [misc] changed max line length to 100 3 months ago
.travis.yml [misc] removing memory leak detection for node.js 12 until mem-watch compatibility 1 month ago
LICENSE [misc] adding LGPL2.1+ license file 10 months ago
README.md [misc] updating benchmarks results for 2.1.0 3 months ago
appveyor.yml [misc] removing memory leak detection for node.js 12 until mem-watch compatibility 1 month ago
azure-pipelines.yml [MENT-29] azure CI install ubuntu from tar 2 months ago
callback.js [CONJS-70] Pool improvement small rewrite for better separation in promise and call back implementation 5 months ago
package.json node-types bump 2 weeks ago
promise.js [CONJS-70] Pool improvement small rewrite for better separation in promise and call back implementation 5 months ago

README.md

MariaDB Node.js connector

Linux Build Windows status License (LGPL version 2.1) codecov

Non-blocking MariaDB and MySQL client for Node.js.

MariaDB and MySQL client, 100% JavaScript, with TypeScript definition, compatible with Node.js 6+, with the Promise API.

Why a New Client?

While there are existing MySQL clients that work with MariaDB, (such as the mysql and mysql2 clients), the MariaDB Node.js Connector offers new functionality, like Insert Streaming, Pipelining, ed25519 plugin authentication while making no compromises on performance.

Insert Streaming

Using a Readable stream in your application, you can stream INSERT statements to MariaDB through the Connector.

    
    https.get('https://someContent', readableStream => {
        //readableStream implement Readable, driver will stream data to database 
        connection.query("INSERT INTO myTable VALUE (?)", [readableStream]);
    });

Pipelining

With Pipelining, the Connector sends commands without waiting for server results, preserving order. For instance, consider the use of executing two INSERT statements.

The Connector doesn’t wait for query results before sending the next INSERT statement. Instead, it sends queries one after the other, avoiding much of the network latency.

For more information, see the Pipelining documentation.

Bulk insert

Some use cases require a large amount of data to be inserted into a database table. By using batch processing, these queries can be sent to the database in one call, thus improving performance.

For more information, see the Batch documentation.

Benchmarks

MariaDB provides benchmarks comparing the Connector with popular Node.js MySQL clients, including:

promise-mysql  : 646 ops/sec ±2.20%
mysql2         : 746 ops/sec ±2.35%
mariadb        : 961 ops/sec ±2.82%

query: SELECT < all mysql fields >, 1 FROM mysql.user LIMIT 1

For more information, see the Benchmarks page.

Quick Start

The MariaDB Connector is available through the Node.js repositories. You can install it using npm :

$ npm install mariadb

Using ECMAScript < 2017:

const mariadb = require('mariadb');
const pool = mariadb.createPool({host: 'mydb.com', user: 'myUser', connectionLimit: 5});
pool.getConnection()
    .then(conn => {
    
      conn.query("SELECT 1 as val")
        .then((rows) => {
          console.log(rows); //[ {val: 1}, meta: ... ]
          return conn.query("INSERT INTO myTable value (?, ?)", [1, "mariadb"]);
        })
        .then((res) => {
          console.log(res); // { affectedRows: 1, insertId: 1, warningStatus: 0 }
          conn.end();
        })
        .catch(err => {
          //handle error
          conn.end();
        })
        
    }).catch(err => {
      //not connected
    });

Using ECMAScript 2017:

const mariadb = require('mariadb');
const pool = mariadb.createPool({host: 'mydb.com', user: 'myUser', connectionLimit: 5});

async function asyncFunction() {
  let conn;
  try {
	conn = await pool.getConnection();
	const rows = await conn.query("SELECT 1 as val");
	console.log(rows); //[ {val: 1}, meta: ... ]
	const res = await conn.query("INSERT INTO myTable value (?, ?)", [1, "mariadb"]);
	console.log(res); // { affectedRows: 1, insertId: 1, warningStatus: 0 }

  } catch (err) {
	throw err;
  } finally {
	if (conn) return conn.end();
  }
}

Documentation

The MariaDB Node.js Connector can use different APIs on the back-end: Promise and Callback.
The default API is Promise API.

Callback API is provided for compatibility with the mysql and mysql2 APIs.

Contributing

If you would like to contribute to the MariaDB Node.js Connector, please follow the instructions given in the Developers Guide.

To file an issue or follow the development, see JIRA.