SQL Server Driver for Database-js

Common errors

Warnings

Install

Imports

• Connection
  wrong

  import { Connection } from 'database-js-mssql';

  correct

  import { Connection } from 'database-js';

  The `Connection` class is part of the `database-js` abstraction layer, which this package extends. Users typically interact with `database-js` directly, not `database-js-mssql` for the core connection object.

• database-js-mssql
  wrong

  import 'database-js-mssql';

  correct

  require('database-js-mssql');

  This package is primarily a CommonJS module. Requiring it ensures the driver is registered with `database-js`. It's a side-effect import for driver discovery, as it doesn't typically export user-facing symbols directly in simple use cases.

• MssqlDriver
  wrong

  const MssqlDriver = require('database-js-mssql').MssqlDriver;

  correct

  import { MssqlDriver } from 'database-js-mssql';

  While not explicitly shown in the README, driver packages for `database-js` typically export their specific driver class (e.g., `MssqlDriver`) for advanced usage, such as manual registration or type hinting in TypeScript projects. This package primarily uses CommonJS `require` syntax.

Quickstart

Demonstrates how to establish a connection to a SQL Server database, prepare and execute a parameterized query, and properly close the connection using the `database-js` API powered by this driver.

import { Connection } from 'database-js';

(async () => {
    // Ensure the driver is loaded, even if not directly referenced
    require('database-js-mssql'); 

    let conn, statement, results;
    try {
        // Use environment variables for sensitive connection details
        const user = process.env.DB_USER ?? 'username';
        const password = process.env.DB_PASSWORD ?? 'password';
        const server = process.env.DB_SERVER ?? 'localhost';
        const database = process.env.DB_DATABASE ?? 'master';

        // Connection string format: mssql:///user:password@server/database
        conn = new Connection(`mssql:///${user}:${password}@${server}/${database}`);
        console.log('Successfully connected to SQL Server.');

        // Prepare a statement with a placeholder
        statement = conn.prepareStatement("SELECT * FROM states WHERE state = ?");

        // Execute the query with a parameter
        results = await statement.query("South Dakota");
        console.log('Query results:', results);

    } catch (reason) {
        console.error('An error occurred:', reason);
    } finally {
        if (conn) {
            await conn.close();
            console.log('Connection closed.');
        }
    }
})();