Release v5.4.0

What's Changed

• feat(ci): add workflow to promote an npm dist-tag by @TimelordUK in #435
• chore(deps): bump node-abi from 4.33.0 to 4.34.0 in the production-dependencies group by @dependabot[bot] in #437
• chore(deps-dev): bump eslint from 10.8.1 to 10.9.1 in the dev-dependencies group by @dependabot[bot] in #436
• chore(deps-dev): bump node-gyp from 12.2.0 to 13.0.2 by @dependabot[bot] in #438
• chore(deps-dev): bump @types/node from 25.5.0 to 26.4.0 by @dependabot[bot] in #439
• chore(deps-dev): bump electron from 43.4.1 to 44.0.0 by @dependabot[bot] in #440
• chore(deps-dev): bump @humanfs/node from 0.16.7 to 0.16.8 in the security-updates group across 1 directory by @dependabot[bot] in #441
• chore(deps): bump node-abi from 4.34.0 to 4.35.0 in the production-dependencies group by @dependabot[bot] in #443
• chore(deps-dev): bump the dev-dependencies group with 2 updates by @dependabot[bot] in #442
• chore(deps-dev): bump mocha from 11.8.0 to 12.0.0 by @dependabot[bot] in #444
• chore(deps-dev): bump eslint-config-love from 155.0.0 to 156.0.0 by @dependabot[bot] in #445
• Fix/446 diagnostic text utf8 by @TimelordUK in #447
• fix: strip only the driver prefix from an info message by @TimelordUK in #448
• chore(deps): bump the security-updates group across 1 directory with 1 update by @dependabot[bot] in #449

huge shoutout to @FilipB97 for #446 fix

Full Changelog: v5.3.0...v5.4.0

This release (4.x to 5.x) is a huge change and must be tested carefully before production release.

1. we have moved from nan to napi node api to buld the cpp
2. added extensive logging that can be switched on to see exactly what driver is doing
3. now building and testing with git actions.
4. we only support ubuntu glib 2204 or later, if you run on earlier linux you have to build the driver yourself
5. as much as possible drop in replacement to previous version < 5 of the driver.
6. we no longer support anything less than node 20, electron 30
7. we no longer support win32
8. we build for windows, linux and mac os latest versions
9. alpine linux will be a best effort but this is no longer considered in scope for supported builds.

can use different pool grown strategy - exponential, gradual

 it('gradual growth strategy - creates fixed increment of connections', function handler (done) {
      const size = 10
      const increment = 3
      const options = {
        connectionString: env.connectionString,
        ceiling: size,
        scalingStrategy: 'gradual',
        scalingIncrement: increment,
        scalingDelay: 0
      }
      const pool = new env.sql.Pool(options)

      const checkins = []
      const checkouts = []
      let queryCount = 0

      pool.on('error', e => {
        assert.ifError(e)
      })

      pool.on('status', s => {
        switch (s.op) {
          case 'checkout':
            checkouts.push(s)
            break
          case 'checkin':
            checkins.push(s)
            break
        }
      })

      pool.open(() => {
        // Submit enough queries to trigger growth
        const queries = 7 // More than initial pool but less than ceiling

        for (let i = 0; i < queries; i++) {
          const q = pool.query('select @@SPID as spid')
          q.on('done', () => {
            queryCount++
            if (queryCount === queries) {
              // Check that we didn't immediately grow to ceiling
              expect(checkouts.length).to.be.lessThan(size)
              // Should have grown by increment amount multiple times
              expect(checkouts.length).to.be.greaterThan(1)
              // The growth should be in increments
              const totalConnections = Math.max(...checkouts.map(c => c.busy + c.idle))
              expect(totalConnections).to.be.lessThan(size) // Not aggressive growth
              pool.close(done)
            }
          })
        }
      })
    })

detailed logging output

'use strict'

// Handle SIGPIPE gracefully when output is piped
process.on('SIGPIPE', () => {
  process.exit(0)
})

const sql = require('../../lib/sql')

// Example 1: Enable trace logging for debugging
// This will show all JavaScript and C++ debug messages
sql.logger.setLogLevel(sql.LogLevel.TRACE)
sql.logger.setConsoleLogging(true)

// Example 2: Enable logging to a file
// sql.logger.setLogFile('/var/log/myapp/sql-trace.log')

// Example 3: Use pre-configured settings
// sql.logger.configureForDevelopment()  // TRACE level, console enabled
// sql.logger.configureForProduction('/var/log/myapp')  // ERROR level, file only
// sql.logger.configureForTesting()  // SILENT level

// Example 4: Disable all logging (default for production)
// sql.logger.setLogLevel(sql.LogLevel.SILENT)

// Now all SQL operations will use the configured logging

const { TestEnv } = require('../../test/env/test-env')
const env = new TestEnv()
const connectionString = env.connectionString

sql.open(connectionString, (err, conn) => {
  if (err) {
    console.error('Connection failed:', err)
    return
  }

  conn.query('SELECT 1 as test', (err, results) => {
    if (err) {
      console.error('Query failed:', err)
    } else {
      console.log('Query succeeded:', results)
    }
    conn.close()
  })
})                                                                                             

This adds some much needed support for doing transactions from a pool with a few helper utilities.
Notable new API methods:

pool.beginTransaction(function (err, description) { /* description.connection.query() */ })

Pulls a connection information out of the pool and gives it to the caller. This connection becomes busy for the duration until either of next two functions are called:

pool.commitTransaction(description, function(err) { /* err logging */ })

Calls IF (@@TRANCOUNT > 0) COMMIT TRANSACTION on the connection in the description and releases it back into the pool allowing it to be used by others.

pool.rollbackTransaction(description, function(err) { /* err logging */ })

Calls IF (@@TRANCOUNT > 0) ROLLBACK TRANSACTION on the connection in the description and releases it back into the pool allowing it to be used by others.

Both functions are also available in the promised pool:

let description = await pool.promises.beginTransaction()
try {
  await description.connection.promises.query(`
    SELECT * from my_table WITH (updlock, holdlock)
  `)
  // do some other stuff
  await pool.promises.commitTransaction(description)
} catch (err) {
  await pool.promises.rollbackTransaction(description)
  // log err
}

Lastly, a nice little promise-specific utlity has been added:

pool.promises.transaction(async function (description) {
  /* I'm inside a transaction */
  await description.connection.promises.query(`Do transaction query here`)
})

This calls the callback and wraps it inside of a transaction with auto commit on success and auto rollback on any thrown errors.

description	link
next js example, note cant run driver on UI thread.	todo-with-nextjs_msnodesqlv8
next js example using app router, note cant run driver on UI thread.	todo-with-nextjs-app-router_msnodesqlv8
using vite + express	msnodesqlv8-vite
using in typescript	msnodesqlv8_ts_sample
js example typings in IDE	msnodesqlv8_yarn_sample
using sequelize	msnodesqlv8-sequelize
using mssql	msnodesqlv8_mssql_sample
using electron	msnodesqlv8-electron
using react	msnodesqlv8-react

import sql from 'msnodesqlv8'
import Connection = MsNodeSqlV8.Connection
import ConnectionPromises = MsNodeSqlV8.ConnectionPromises
async function t() {
    const connectionString  = "Driver={ODBC Driver 17 for SQL Server};Server=(localdb)\\node;Database=scratch;Trusted_Connection=yes;"
    const con:Connection = await sql.promises.open(connectString)
    const promises:ConnectionPromises  = con.promises
    const res = await promises.query('select @@servername as server')
    console.log(JSON.stringify(res, null, 4))
    await con.promises.close()
}

t().then(() => {
    console.log('closed')
})

const connectionString  = "Driver={ODBC Driver 17 for SQL Server};Server=(localdb)\\node;Database=scratch;Trusted_Connection=yes;"

const sql = require('msnodesqlv8')

const query = 'SELECT top 2 * FROM syscolumns'

async function runner() {
    console.log(`using connection '${connectionString}' run query '${query}'`)
    const res = await sql.promises.query(connectionString, query)
    console.log(JSON.stringify(res, null, 4))
}

runner().then(() => {
    console.log('done.')
}).catch(e => {
    console.error(e)
})