@iqx-limited/sqlanywhere

[!NOTE] This is a fork of the original driver sqlanywhere/node-sqlanywhere which has not had any updates for several years and was no longer working with newer versions of NodeJS.

A modern, high-performance Node.js driver for SAP SQL Anywhere.

This driver is built using N-API, ensuring a stable and future-proof interface that is independent of the underlying JavaScript engine. It is fully async/await compatible, providing a clean and modern developer experience.

[!CAUTION] This has only been tested in my environment and 1 set of specific databases - your mileage may vary

If you are running into issues, feel free to open an issue, however on the off chance that this does work for you - please let me know via discussions

Prerequisites

• Node.js: Version 18.0.0 or higher.
• SAP SQL Anywhere: The appropriate SQL Anywhere client libraries must be installed and correctly configured in your environment (e.g., via the $SQLANY environment variable and system path). - These can be downloaded from SAP Support
• If compiling;
  • C++ Toolchain: A C++ compiler and build tools are required for the native addon compilation. This is typically handled by node-gyp. Please see the node-gyp installation guide for platform-specific instructions.

Installation

npm install @iqx-limited/sqlanywhere

The installation process will attempt to use pre-built binaries, if that fails, it will automatically compile the native C++ addon for your platform.

Getting Started

[!TIP] This package provides two entry points:

• @iqx-limited/sqlanywhere: Exposes the original callback-based API.
• @iqx-limited/sqlanywhere/promise: Exposes a fully promisified API, ideal for use with async/await.

All examples below use the /promise entry point for modern, promise-based usage. If you prefer callbacks, use the main package import instead.

const sqlanywhere = require('@iqx-limited/sqlanywhere/promise');

// --- For security, use environment variables for credentials ---
const connParams = {
  ServerName: process.env.DB_SERVER || 'demo',
  UserID: process.env.DB_USER || 'DBA',
  Password: process.env.DB_PASSWORD || 'sql'
};

async function main() {
  const connection = sqlanywhere.createConnection();

  try {
    // 1. Connect to the database
    console.log('Connecting...');
    await connection.connect(connParams);
    console.log('Connection successful!');

    // 2. Execute a query with parameters
    const products = await connection.exec(
      'SELECT Name, Description FROM Products WHERE id = ?',
      [301]
    );
    console.log('Query Result:', products[0]);
    // output --> Query Result: { Name: 'Tee Shirt', Description: 'V-neck' }

  } catch (error) {
    console.error('An error occurred:', error);
  } finally {
    // 3. Disconnect when finished
    console.log('Disconnecting...');
    await connection.disconnect();
    console.log('Disconnected.');
  }
}

main();

Connection

sqlanywhere.createConnection() Creates a new, uninitialized connection object.

connection.connect(params) Establishes a connection to the database. The params object can contain most valid SQL Anywhere connection properties.

connection.disconnect() or connection.close() Closes the database connection.

connection.exec(sql, [params]) Executes a SQL statement directly.

• For SELECT queries, it returns a Promise that resolves to an array of result objects.
• For DML statements (INSERT, UPDATE, DELETE), it returns a Promise that resolves to the number of affected rows.
• Parameters can be bound using ? placeholders.

connection.prepare(sql) Prepares a SQL statement for later execution. Returns a Promise that resolves to a Statement object.

connection.commit() Commits the current transaction.

connection.rollback() Rolls back the current transaction.

Statement (from connection.prepare())

statement.exec([params]) Executes a prepared statement. The return value is the same as connection.exec().

statement.getMoreResults() For procedures or batches that return multiple result sets, this method advances to the next result set. Returns a Promise that resolves to the next array of results. When no more result sets are available, the promise will reject with a "Procedure has completed" message.

statement.drop() Frees the resources associated with the prepared statement on the database server.

Data Type Support

This driver provides comprehensive support for a wide range of SQL Anywhere data types, which are automatically mapped to the most appropriate JavaScript types:

| SQL Anywhere Type(s) | JavaScript Type | | ------------------------------------------------------------------------------------------ | --------------------------------------------- | | INTEGER, BIGINT, SMALLINT, TINYINT, DECIMAL, DOUBLE, FLOAT, BIT, etc. | number | | VARCHAR, CHAR, LONG NVARCHAR, DATE, TIME, TIMESTAMP, UNIQUEIDENTIFIER, XML | string | | BINARY, VARBINARY, LONG BINARY, ST_GEOMETRY | Buffer |

Debug Logging

// Import from the main package:
import { debugLogging } from '@iqx-limited/sqlanywhere';
// or: const { debugLogging } = require('@iqx-limited/sqlanywhere');

// Or import from the /promise entry point:
import { debugLogging } from '@iqx-limited/sqlanywhere/promise';
// or: const { debugLogging } = require('@iqx-limited/sqlanywhere/promise');

// Then set to true
debugLogging(true);

Running the Test Suite

The project includes a comprehensive test suite that validates all driver functionality against a live database.

1. Configure Credentials: Copy the examples/.env.sample file to a new file named examples/.env and fill in your database connection details.

2. Run Tests: Execute the following command from the examples directory:

   npm run test

Resources

• SAP SQL Anywhere Documentation
• SAP SQL Anywhere Developer Q&A Forum