mariadb

What is mariadb?

The mariadb npm package is a Node.js connector for MariaDB, a popular open-source relational database. It allows you to interact with MariaDB databases using JavaScript, providing functionalities for connecting to the database, executing queries, managing transactions, and handling connection pools.

What are mariadb's main functionalities?

Connecting to the Database

This code demonstrates how to create a connection pool and connect to a MariaDB database using the mariadb package. It establishes a connection and logs a message upon successful connection.

const mariadb = require('mariadb');
const pool = mariadb.createPool({
  host: 'localhost', 
  user: 'yourUsername', 
  password: 'yourPassword', 
  database: 'yourDatabase'
});

async function connect() {
  let conn;
  try {
    conn = await pool.getConnection();
    console.log('Connected to the database');
  } catch (err) {
    throw err;
  } finally {
    if (conn) conn.end();
  }
}

connect();

Executing Queries

This code sample shows how to execute a simple SELECT query using the mariadb package. It retrieves all rows from a specified table and logs them to the console.

const mariadb = require('mariadb');
const pool = mariadb.createPool({
  host: 'localhost', 
  user: 'yourUsername', 
  password: 'yourPassword', 
  database: 'yourDatabase'
});

async function executeQuery() {
  let conn;
  try {
    conn = await pool.getConnection();
    const rows = await conn.query('SELECT * FROM yourTable');
    console.log(rows);
  } catch (err) {
    throw err;
  } finally {
    if (conn) conn.end();
  }
}

executeQuery();

Managing Transactions

This code demonstrates how to manage transactions using the mariadb package. It begins a transaction, executes an INSERT query, and commits the transaction. If an error occurs, the transaction is rolled back.

const mariadb = require('mariadb');
const pool = mariadb.createPool({
  host: 'localhost', 
  user: 'yourUsername', 
  password: 'yourPassword', 
  database: 'yourDatabase'
});

async function manageTransaction() {
  let conn;
  try {
    conn = await pool.getConnection();
    await conn.beginTransaction();
    await conn.query('INSERT INTO yourTable (column1, column2) VALUES (?, ?)', [value1, value2]);
    await conn.commit();
    console.log('Transaction committed');
  } catch (err) {
    if (conn) await conn.rollback();
    console.error('Transaction rolled back', err);
  } finally {
    if (conn) conn.end();
  }
}

manageTransaction();

Handling Connection Pools

This code sample shows how to handle connection pools with the mariadb package. It sets a connection limit and demonstrates how to use the pool to execute a query.

const mariadb = require('mariadb');
const pool = mariadb.createPool({
  host: 'localhost', 
  user: 'yourUsername', 
  password: 'yourPassword', 
  database: 'yourDatabase',
  connectionLimit: 5
});

async function usePool() {
  let conn;
  try {
    conn = await pool.getConnection();
    const rows = await conn.query('SELECT * FROM yourTable');
    console.log(rows);
  } catch (err) {
    throw err;
  } finally {
    if (conn) conn.end();
  }
}

usePool();

Other packages similar to mariadb

mysql

The mysql package is a popular Node.js connector for MySQL databases. It offers similar functionalities to mariadb, such as connecting to the database, executing queries, and managing transactions. However, it is specifically designed for MySQL databases, whereas mariadb is tailored for MariaDB.

mysql2

The mysql2 package is another Node.js connector for MySQL databases. It is a more modern and faster alternative to the mysql package, with support for Promises and async/await. Like mariadb, it provides functionalities for connecting to the database, executing queries, and managing transactions.

pg

The pg package is a Node.js connector for PostgreSQL databases. While it serves a different database system, it offers similar functionalities to mariadb, such as connecting to the database, executing queries, and managing transactions. It is a good alternative if you are using PostgreSQL instead of MariaDB.

README

MariaDB Node.js connector

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

MariaDB and MySQL client, 100% JavaScript, with TypeScript definition, with the Promise API, distributed under the LGPL license version 2.1 or later (LGPL-2.1-or-later)

Documentation

See promise documentation for detailed API.

Callback documentation describe the callback wrapper for compatibility with existing drivers.

See dedicated part for migration from mysql/mysql2 or from 2.x version.

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.

Connector is production grade quality, with multiple features:

• superfast batching
• fast pool
• easy debugging, trace pointing to code line on error
• allows data streaming without high memory consumption
• pipelining
• metadata skipping (for MariaDB server only)
• sql file import
• ...

see some of those features:

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 other Node.js MariaDB/MySQL clients, including:

• promise-mysql version 5.2.0 + mysql version 2.18.1
• mysql2 version 3.1.0

See the Benchmarks page for multiple results.

query

select 100 int
            mysql :  2,738.7 ops/s ± 1.3% 
           mysql2 :  2,404.9 ops/s ± 1.3%  (  -12.2% )
          mariadb :  5,650.8 ops/s ± 1.4%  ( +106.3% )

execute

select 100 int - BINARY

select 100 int - BINARY
           mysql2 :  2,473.4 ops/s ± 1.3% 
          mariadb :   10,533 ops/s ± 1.7%  ( +325.9% )

Quick Start

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

$ npm install mariadb

example:

const mariadb = require('mariadb');
const pool = mariadb.createPool({host: process.env.DB_HOST, user: process.env.DB_USER, connectionLimit: 5});

async function asyncFunction() {
  let conn;
  try {

	conn = await pool.getConnection();
	const rows = await conn.query("SELECT 1 as val");
	// rows: [ {val: 1}, meta: ... ]

	const res = await conn.query("INSERT INTO myTable value (?, ?)", [1, "mariadb"]);
	// res: { affectedRows: 1, insertId: 1, warningStatus: 0 }

  } finally {
	if (conn) conn.release(); //release to pool
  }
}

Contributors

A big thanks to all contributors

Contributing

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

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

Changelog

3.4.0 (Oct 2024)

Full Changelog

Notable changes

• CONJS-299 Parsec authentication implementation
• CONJS-295 add new option jsonStrings to ensure to return JSON field as string

Issues Fixed

• CONJS-296 Add option enableKeepAlive / keepAliveInitialDelay alias for keepAliveDelay for mysql2 compatibility
• CONJS-303 DMLs are not returning an output while streaming