Upgrade from MariaDB Connector/Node.js 2.5 to 3.3

Time Zone Conversions

• Starting with MariaDB Connector/Node.js 3.1, instead of performing time zone conversions locally, MariaDB Connector/Node.js can set the session value of the time_zone system variable. This allows the remote server to handle time zone conversions. In previous releases, time zone conversions are performed locally.

$ mariadb-tzinfo-to-sql /usr/share/zoneinfo | mariadb -u root mysql

TypeScript

• Starting with MariaDB Connector/Node.js 3.1, with TypeScript, the batch(), execute(), and query() methods have been internally defined to have type assertions, so that applications can assign the return values without defining type assertion at the application level.

  • In previous releases, assigning the return values of the batch(), execute(), and query() methods required type assertions, which means the METHOD_CALL() AS TYPE_NAME or <TYPE_NAME> METHOD_CALL() syntax was required.

  • Starting with MariaDB Connector/Node.js 3.1, the type assertions are defined internally using generic types.

Exact Decoding for BIGINT and DECIMAL

The default behavior for MariaDB Connector/Node.js 2.5 (and for other existing drivers like mysql2) for decoding the data types BIGINTBIGINT and DECIMALDECIMAL is to return a JavaScript Number object. JavaScript uses double-precision floating-point format numbers as specified in IEEE 754, which is returning approximate results for big values.

Integers can only be safely represented between -(2^53 - 1) and 2^53 - 1.

MariaDB Connector/Node.js, to return precise values, by default returns the objects:

• DECIMAL => JavaScript String object

• BIGINT => JavaScript BIGINTBIGINT

For compatibility reasons three options have been added to return BIGINT / DECIMAL as a number object:

Previous options supportBigNumbers and bigNumberStrings still exist for compatibility, but are now deprecated.

Custom Logging API

External logging can now be easily enabled using the logging API, provided with MariaDB Connector/Node.js via the three caller functions:

• network(string): called for each network exchange.

• query(string): called for each command.

• error(Error): called for each error.

Simple example to log network exchanges, queries, and errors:

const pool = mariadb.createPool({
  host: 'example.com',
  user:'myUser',
  password: 'myPwd',
  logger: (msg) => console.log(msg)
});

Example of a more detailed use:

const mariadb = require('mariadb');
const winston = require('winston');

const logger = winston.createLogger({
  level: 'info',
  transports: [
    // - Write all logs with level `error` and below to `error.log`
    // - Write all logs with level `info` and below to `combined.log`
    new winston.transports.Console({ filename: 'error.log', level: 'error' }),
    new winston.transports.Console({ filename: 'combined.log' })
  ]
});

const pool = mariadb.createPool({
  host: 'example.com',
  user: 'myUser',
  password: 'myPwd',
  logger: {
    query: (msg) => logger.info(msg),
    error: (err) => logger.error(err),
  }
});

Options