mssql-simple

Simple MSSQL library with pooling

npm install mssql-simple
9 downloads in the last week
34 downloads in the last month

Simple MS-SQL client for Node.js

Goal of this library is to provide as simple as possible interface for connectiong to MSSQL servers

Usage

var mssql = require( "mssql-simple" );

// Simply connect to server with only base information
var pool = mssql( serverHost, {            // Server hostname or IP
    username : userLogin,                // User login
    password : userPassword,            // User password
});

// Connect to server on specific server port with additional informations
var pool2 = mssql( serverHost, serverPort {    
    username : userLogin,
    password : userPassword,
    appname : 'APP 1.0',        // Application name for debug pruposes
    db : 'APPDB',                // Database name
    initSql : "set ansi_nulls on",    // SQL Initilization string
    poolLimit : 100,            // Maximal # of connections , default 400
    poolMin : 10,                // Minimal # of connections , default 30
    poolStep : 5,                // # of free connections opened, default 5

});

// Call remote procedure [my_proc] @parameter = 1 , write all rows with recordset number to console
pool.rpc( 'my_proc', { '@parameter' : 1 }, function( connection ) {

    connection.on( 'row', function( row, rsNumber ) {
        console.log( "Recordset", rsNumber, "-", row );
    });
});

// Send query batch and write all rows to console
pool.query( 'SELECT * FROM my_table WHERE foo = 1;', function( connection ) {
    connection.on( 'row', function( row ) {
        console.log( row );
    });
});

Types

pool (extends EventEmitter)

function rpc( rpcName, parameters, callback )

Calls remote stored procedure with parameters, callback is called right after data are transmitted to server and recieves argument with connection to work with

function query( query, callback )

Sends query batch, callback is called right after data are transmitted to server and recieves argument with connection to work with

event error( message )

Error happened on any connection

event connectionFree( connection )

There is availible new free connection (After connect or after query or on demand)

connection (extends EventEmitter)

event error( message, errorNumber, errorState )

Error happened on current connection

event info( message, infoNumber, infoState )

There is informational message from server

event recordset( number, columns )

There is next recordset #number with columns

event row( row, recordsetNumber )

There is row in recorset #number

event comanddone

Request is done

event rpcresult( status )

RPC is done with return status

Plans

  1. Support for output parameters in RPC
  2. Support all data types (Input and output)
  3. Query with escaped parameters
  4. Support other TDS versions

License

The MIT License (MIT)

Copyright (c) 2013 Sergej Brjuchanov

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

npm loves you