Nighttime Pachinko Marathon

    @quorum/mssql

    3.0.1 • Public • Published

    node-mssql

    An easy-to-use MSSQL database connector for Node.js.

    NPM Version NPM Downloads Travis CI Appveyor CI Join the chat at https://gitter.im/patriksimek/node-mssql

    node-mssql

    • Has unified interface for multiple TDS drivers.
    • Has built-in connection pooling.
    • Supports built-in JSON serialization introduced in SQL Server 2016.
    • Supports Stored Procedures, Transactions, Prepared Statements, Bulk Load and TVP.
    • Supports serialization of Geography and Geometry CLR types.
    • Has smart JS data type to SQL data type mapper.
    • Supports Promises, Streams and standard callbacks.
    • Is stable and tested in production environment.
    • Is well documented.

    There is also co wrapper available - co-mssql. If you're looking for session store for connect/express, visit connect-mssql.

    Supported TDS drivers:

    node-mssql uses Tedious as the default driver.

    Installation

    npm install mssql
    

    Quick Example

    var sql = require('mssql');
    
    sql.connect("mssql://username:password@localhost/database").then(function() {
        // Query
        
    	new sql.Request().query('select * from mytable').then(function(recordset) {
    		console.dir(recordset);
    	}).catch(function(err) {
    		// ... query error checks
    	});
    
        // Stored Procedure
    	
    	new sql.Request()
    	.input('input_parameter', sql.Int, value)
        .output('output_parameter', sql.VarChar(50))
    	.execute('procedure_name').then(function(recordset) {
    		console.dir(recordset);
    	}).catch(function(err) {
    		// ... execute error checks
    	});
    }).catch(function(err) {
    	// ... connect error checks
    });

    If you're on Windows Azure, add ?encrypt=true to you connection string. See docs to learn more.

    Documentation

    Examples

    Configuration

    Drivers

    Connections

    Requests

    Transactions

    Prepared Statements

    Other

    Examples

    ### Promises
    var sql = require('mssql');
    
    var config = {
        user: '...',
        password: '...',
        server: 'localhost', // You can use 'localhost\\instance' to connect to named instance
        database: '...',
    
        options: {
            encrypt: true // Use this if you're on Windows Azure
        }
    }
    
    sql.connect(config).then(function() {
    	// Query
    	
    	var request = new sql.Request();
    	request.query('select * from mytable').then(function(recordset) {
    		console.dir(recordset);
    	}).catch(function(err) {
    		// ... error checks
    	});
    
        // Stored Procedure
    	
    	var request = new sql.Request();
    	request.input('input_parameter', sql.Int, value);
        request.output('output_parameter', sql.VarChar(50));
    	request.execute('procedure_name').then(function(recordset) {
    		console.dir(recordset);
    	}).catch(function(err) {
    		// ... error checks
    	});
    }).catch(function(err) {
    	// ... error checks
    });

    Native Promise is used by default. You can easily change this with sql.Promise = require('myownpromisepackage').

    ### Nested callbacks
    var sql = require('mssql');
    
    var config = {
        user: '...',
        password: '...',
        server: 'localhost', // You can use 'localhost\\instance' to connect to named instance
        database: '...',
    
        options: {
            encrypt: true // Use this if you're on Windows Azure
        }
    }
    
    sql.connect(config, function(err) {
        // ... error checks
    
        // Query
    
        var request = new sql.Request();
        request.query('select 1 as number', function(err, recordset) {
            // ... error checks
    
            console.dir(recordset);
        });
    
        // Stored Procedure
    
        var request = new sql.Request();
        request.input('input_parameter', sql.Int, value);
        request.output('output_parameter', sql.VarChar(50));
        request.execute('procedure_name', function(err, recordsets, returnValue) {
            // ... error checks
    
            console.dir(recordsets);
        });
    });
    
    sql.on('error', function(err) {
    	// ... error handler
    });
    ### Streaming

    If you plan to work with large amount of rows, you should always use streaming. Once you enable this, you must listen for events to receive data.

    var sql = require('mssql');
    
    var config = {
        user: '...',
        password: '...',
        server: 'localhost', // You can use 'localhost\\instance' to connect to named instance
        database: '...',
        stream: true, // You can enable streaming globally
    
        options: {
            encrypt: true // Use this if you're on Windows Azure
        }
    }
    
    sql.connect(config, function(err) {
        // ... error checks
    
        var request = new sql.Request();
        request.stream = true; // You can set streaming differently for each request
        request.query('select * from verylargetable'); // or request.execute(procedure);
    
        request.on('recordset', function(columns) {
        	// Emitted once for each recordset in a query
        });
    
        request.on('row', function(row) {
        	// Emitted for each row in a recordset
        });
    
        request.on('error', function(err) {
        	// May be emitted multiple times
        });
    
        request.on('done', function(returnValue) {
        	// Always emitted as the last one
        });
    });
    
    sql.on('error', function(err) {
    	// ... error handler
    });
    ## Multiple Connections
    var sql = require('mssql');
    
    var config = {
        user: '...',
        password: '...',
        server: 'localhost', // You can use 'localhost\\instance' to connect to named instance
        database: '...',
    
        options: {
            encrypt: true // Use this if you're on Windows Azure
        }
    }
    
    var connection1 = new sql.Connection(config, function(err) {
        // ... error checks
    
        // Query
    
        var request = new sql.Request(connection1); // or: var request = connection1.request();
        request.query('select 1 as number', function(err, recordset) {
            // ... error checks
    
            console.dir(recordset);
        });
    
    });
    
    connection1.on('error', function(err) {
    	// ... error handler
    });
    
    var connection2 = new sql.Connection(config, function(err) {
        // ... error checks
    
        // Stored Procedure
    
        var request = new sql.Request(connection2); // or: var request = connection2.request();
        request.input('input_parameter', sql.Int, 10);
        request.output('output_parameter', sql.VarChar(50));
        request.execute('procedure_name', function(err, recordsets, returnValue) {
            // ... error checks
    
            console.dir(recordsets);
        });
    });
    
    connection2.on('error', function(err) {
    	// ... error handler
    });
    ## Configuration
    var config = {
        user: '...',
        password: '...',
        server: 'localhost',
        database: '...',
        pool: {
            max: 10,
            min: 0,
            idleTimeoutMillis: 30000
        }
    }
    ### General (same for all drivers)
    • driver - Driver to use (default: tedious). Possible values: tedious, msnodesqlv8 or msnodesql or tds.
    • user - User name to use for authentication.
    • password - Password to use for authentication.
    • server - Server to connect to. You can use 'localhost\instance' to connect to named instance.
    • port - Port to connect to (default: 1433). Don't set when connecting to named instance.
    • domain - Once you set domain, driver will connect to SQL Server using domain login.
    • database - Database to connect to (default: dependent on server configuration).
    • connectionTimeout - Connection timeout in ms (default: 15000).
    • requestTimeout - Request timeout in ms (default: 15000).
    • stream - Stream recordsets/rows instead of returning them all at once as an argument of callback (default: false). You can also enable streaming for each request independently (request.stream = true). Always set to true if you plan to work with large amount of rows.
    • parseJSON - Parse JSON recordsets to JS objects (default: false). For more information please see section JSON support.
    • pool.max - The maximum number of connections there can be in the pool (default: 10).
    • pool.min - The minimum of connections there can be in the pool (default: 0).
    • pool.idleTimeoutMillis - The Number of milliseconds before closing an unused connection (default: 30000).
    ### Formats

    In addition to configuration object there is an option to pass config as a connection string. Two formats of connection string are supported.

    Classic Connection String
    Server=localhost,1433;Database=database;User Id=username;Password=password;Encrypt=true
    Driver=msnodesqlv8;Server=(local)\INSTANCE;Database=database;UID=DOMAIN\username;PWD=password;Encrypt=true
    
    Connection String URI
    mssql://username:password@localhost:1433/database?encrypt=true
    mssql://username:password@localhost/INSTANCE/database?encrypt=true&domain=DOMAIN&driver=msnodesqlv8
    

    Version

    2.5

    Drivers

    ### Tedious

    Default driver, actively maintained and production ready. Platform independent, runs everywhere Node.js runs.

    Extra options:

    • options.instanceName - The instance name to connect to. The SQL Server Browser service must be running on the database server, and UDP port 1444 on the database server must be reachable.
    • options.useUTC - A boolean determining whether or not use UTC time for values without time zone offset (default: true).
    • options.encrypt - A boolean determining whether or not the connection will be encrypted (default: false).
    • options.tdsVersion - The version of TDS to use (default: 7_4, available: 7_1, 7_2, 7_3_A, 7_3_B, 7_4).
    • options.appName - Application name used for SQL server logging.
    • options.abortTransactionOnError - A boolean determining whether to rollback a transaction automatically if any error is encountered during the given transaction's execution. This sets the value for XACT_ABORT during the initial SQL phase of a connection.

    More information about Tedious specific options: http://pekim.github.io/tedious/api-connection.html

    ### Microsoft / Contributors Node V8 Driver for Node.js for SQL Server

    Requires Node.js 0.12.x/4.2.0. Windows only. This driver is not part of the default package and must be installed separately by npm install msnodesqlv8.

    Extra options:

    • connectionString - Connection string (default: see below).
    • options.instanceName - The instance name to connect to. The SQL Server Browser service must be running on the database server, and UDP port 1444 on the database server must be reachable.
    • options.trustedConnection - Use Windows Authentication (default: false).
    • options.useUTC - A boolean determining whether or not to use UTC time for values without time zone offset (default: true).

    Default connection string when connecting to port:

    Driver={SQL Server Native Client 11.0};Server={#{server},#{port}};Database={#{database}};Uid={#{user}};Pwd={#{password}};Trusted_Connection={#{trusted}};
    

    Default connection string when connecting to named instance:

    Driver={SQL Server Native Client 11.0};Server={#{server}\\#{instance}};Database={#{database}};Uid={#{user}};Pwd={#{password}};Trusted_Connection={#{trusted}};
    
    ### Microsoft Driver for Node.js for SQL Server

    Requires Node.js 0.6.x/0.8.x/0.10.x. Windows only. This driver is not part of the default package and must be installed separately by npm install msnodesql. If you are looking for compiled binaries, see node-sqlserver-binary.

    Extra options:

    • connectionString - Connection string (default: see below).
    • options.instanceName - The instance name to connect to. The SQL Server Browser service must be running on the database server, and UDP port 1444 on the database server must be reachable.
    • options.trustedConnection - Use Windows Authentication (default: false).
    • options.useUTC - A boolean determining whether or not to use UTC time for values without time zone offset (default: true).

    Default connection string when connecting to port:

    Driver={SQL Server Native Client 11.0};Server={#{server},#{port}};Database={#{database}};Uid={#{user}};Pwd={#{password}};Trusted_Connection={#{trusted}};
    

    Default connection string when connecting to named instance:

    Driver={SQL Server Native Client 11.0};Server={#{server}\\#{instance}};Database={#{database}};Uid={#{user}};Pwd={#{password}};Trusted_Connection={#{trusted}};
    
    ### node-tds

    Legacy support, don't use this driver for new projects. This driver is not part of the default package and must be installed separately by npm install tds.

    node-mssql updates this driver with extra features and bug fixes by overriding some of its internal functions. If you want to disable this, require module with var sql = require('mssql/nofix').

    ## Connections

    Internally, each Connection instance is a separate pool of TDS connections. Once you create a new Request/Transaction/Prepared Statement, a new TDS connection is acquired from the pool and reserved for desired action. Once the action is complete, connection is released back to the pool. Connection health check is built-in so once the dead connection is discovered, it is immediately replaced with a new one.

    IMPORTANT: Always attach an error listener to created connection. Whenever something goes wrong with the connection it will emit an error and if there is no listener (and no domain listener as a backup) it will crash the application as an uncaught error.

    var connection = new sql.Connection({ /* config */ });

    Errors

    • EDRIVER (ConnectionError) - Unknown driver.

    Events

    • connect - Dispatched after connection has established.
    • close - Dispatched after connection has closed a pool (by calling close).
    • error(err) - Dispatched on connection error.

    ### connect([callback])

    Create a new connection pool with one active connection. This one initial connection serves as a probe to find out whether the configuration is valid.

    Arguments

    • callback(err) - A callback which is called after connection has established, or an error has occurred. Optional. If omitted, returns Promise.

    Example

    var connection = new sql.Connection({
        user: '...',
        password: '...',
        server: 'localhost',
        database: '...'
    });
    
    connection.connect(function(err) {
        // ...
    });

    Errors

    • ELOGIN (ConnectionError) - Login failed.
    • ETIMEOUT (ConnectionError) - Connection timeout.
    • EALREADYCONNECTED (ConnectionError) - Database is already connected!
    • EALREADYCONNECTING (ConnectionError) - Already connecting to database!
    • EINSTLOOKUP (ConnectionError) - Instance lookup failed.
    • ESOCKET (ConnectionError) - Socket error.

    ### close()

    Close all active connections in the pool.

    Example

    connection.close();
    ## Requests
    var request = new sql.Request(/* [connection] */);

    If you omit connection argument, global connection is used instead.

    Events

    • recordset(columns) - Dispatched when metadata for new recordset are parsed.
    • row(row) - Dispatched when new row is parsed.
    • done(returnValue) - Dispatched when request is complete.
    • error(err) - Dispatched on error.

    ### execute(procedure, [callback])

    Call a stored procedure.

    Arguments

    • procedure - Name of the stored procedure to be executed.
    • callback(err, recordsets, returnValue) - A callback which is called after execution has completed, or an error has occurred. returnValue is also accessible as property of recordsets. Optional. If omitted, returns Promise.

    Example

    var request = new sql.Request();
    request.input('input_parameter', sql.Int, value);
    request.output('output_parameter', sql.Int);
    request.execute('procedure_name', function(err, recordsets, returnValue) {
        // ... error checks
    
        console.log(recordsets.length); // count of recordsets returned by the procedure
        console.log(recordsets[0].length); // count of rows contained in first recordset
        console.log(returnValue); // procedure return value
        console.log(recordsets.returnValue); // same as previous line
    
        console.log(request.parameters.output_parameter.value); // output value
    
        // ...
    });

    Errors

    • EREQUEST (RequestError) - Message from SQL Server
    • ECANCEL (RequestError) - Cancelled.
    • ETIMEOUT (RequestError) - Request timeout.
    • ENOCONN (RequestError) - No connection is specified for that request.
    • ENOTOPEN (ConnectionError) - Connection not yet open.
    • ECONNCLOSED (ConnectionError) - Connection is closed.
    • ENOTBEGUN (TransactionError) - Transaction has not begun.
    • EABORT (TransactionError) - Transaction was aborted (by user or because of an error).

    ### input(name, [type], value)

    Add an input parameter to the request.

    Arguments

    • name - Name of the input parameter without @ char.
    • type - SQL data type of input parameter. If you omit type, module automatically decide which SQL data type should be used based on JS data type.
    • value - Input parameter value. undefined ans NaN values are automatically converted to null values.

    Example

    request.input('input_parameter', value);
    request.input('input_parameter', sql.Int, value);

    JS Data Type To SQL Data Type Map

    • String -> sql.NVarChar
    • Number -> sql.Int
    • Boolean -> sql.Bit
    • Date -> sql.DateTime
    • Buffer -> sql.VarBinary
    • sql.Table -> sql.TVP

    Default data type for unknown object is sql.NVarChar.

    You can define your own type map.

    sql.map.register(MyClass, sql.Text);

    You can also overwrite the default type map.

    sql.map.register(Number, sql.BigInt);

    Errors (synchronous)

    • EARGS (RequestError) - Invalid number of arguments.
    • EINJECT (RequestError) - SQL injection warning.

    ### output(name, type, [value])

    Add an output parameter to the request.

    Arguments

    • name - Name of the output parameter without @ char.
    • type - SQL data type of output parameter.
    • value - Output parameter value initial value. undefined and NaN values are automatically converted to null values. Optional.

    Example

    request.output('output_parameter', sql.Int);
    request.output('output_parameter', sql.VarChar(50), 'abc');

    Errors (synchronous)

    • EARGS (RequestError) - Invalid number of arguments.
    • EINJECT (RequestError) - SQL injection warning.

    ### pipe(stream)

    Sets request to stream mode and pulls all rows from all recordsets to a given stream.

    Arguments

    • stream - Writable stream in object mode.

    Example

    var request = new sql.Request();
    request.pipe(stream);
    request.query('select * from mytable');
    stream.on('error', function(err) {
        // ...
    });
    stream.on('finish', function() {
        // ...
    });

    Version

    2.0


    ### query(command, [callback])

    Execute the SQL command. To execute commands like create procedure or if you plan to work with local temporary tables, use batch instead.

    Arguments

    • command - T-SQL command to be executed.
    • callback(err, recordset) - A callback which is called after execution has completed, or an error has occurred. Optional. If omitted, returns Promise.

    Example

    var request = new sql.Request();
    request.query('select 1 as number', function(err, recordset) {
        // ... error checks
    
        console.log(recordset[0].number); // return 1
    
        // ...
    });

    Errors

    • ETIMEOUT (RequestError) - Request timeout.
    • EREQUEST (RequestError) - Message from SQL Server
    • ECANCEL (RequestError) - Cancelled.
    • ENOCONN (RequestError) - No connection is specified for that request.
    • ENOTOPEN (ConnectionError) - Connection not yet open.
    • ECONNCLOSED (ConnectionError) - Connection is closed.
    • ENOTBEGUN (TransactionError) - Transaction has not begun.
    • EABORT (TransactionError) - Transaction was aborted (by user or because of an error).

    You can enable multiple recordsets in queries with the request.multiple = true command.

    var request = new sql.Request();
    request.multiple = true;
    
    request.query('select 1 as number; select 2 as number', function(err, recordsets) {
        // ... error checks
    
        console.log(recordsets[0][0].number); // return 1
        console.log(recordsets[1][0].number); // return 2
    });

    NOTE: To get number of rows affected by the statement(s), see section Affected Rows.


    ### batch(batch, [callback])

    Execute the SQL command. Unlike query, it doesn't use sp_executesql, so is not likely that SQL Server will reuse the execution plan it generates for the SQL. Use this only in special cases, for example when you need to execute commands like create procedure which can't be executed with query or if you're executing statements longer than 4000 chars on SQL Server 2000. Also you should use this if you're plan to work with local temporary tables (more information here).

    NOTE: Table-Valued Parameter (TVP) is not supported in batch.

    Arguments

    • batch - T-SQL command to be executed.
    • callback(err, recordset) - A callback which is called after execution has completed, or an error has occurred. Optional. If omitted, returns Promise.

    Example

    var request = new sql.Request();
    request.batch('create procedure #temporary as select * from table', function(err, recordset) {
        // ... error checks
    });

    Errors

    • ETIMEOUT (RequestError) - Request timeout.
    • EREQUEST (RequestError) - Message from SQL Server
    • ECANCEL (RequestError) - Cancelled.
    • ENOCONN (RequestError) - No connection is specified for that request.
    • ENOTOPEN (ConnectionError) - Connection not yet open.
    • ECONNCLOSED (ConnectionError) - Connection is closed.
    • ENOTBEGUN (TransactionError) - Transaction has not begun.
    • EABORT (TransactionError) - Transaction was aborted (by user or because of an error).

    You can enable multiple recordsets in queries with the request.multiple = true command.


    ### bulk(table, [callback])

    Perform a bulk insert.

    Arguments

    • table - sql.Table instance.
    • callback(err, rowCount) - A callback which is called after bulk insert has completed, or an error has occurred. Optional. If omitted, returns Promise.

    Example

    var table = new sql.Table('table_name'); // or temporary table, e.g. #temptable
    table.create = true;
    table.columns.add('a', sql.Int, {nullable: true});
    table.columns.add('b', sql.VarChar(50), {nullable: false});
    table.rows.add(777, 'test');
    
    var request = new sql.Request();
    request.bulk(table, function(err, rowCount) {
        // ... error checks
    });

    IMPORTANT: Always indicate whether the column is nullable or not!

    TIP: If you set table.create to true, module will check if the table exists before it start sending data. If it doesn't, it will automatically create it.

    TIP: You can also create Table variable from any recordset with recordset.toTable().

    Errors

    • ENAME (RequestError) - Table name must be specified for bulk insert.
    • ETIMEOUT (RequestError) - Request timeout.
    • EREQUEST (RequestError) - Message from SQL Server
    • ECANCEL (RequestError) - Cancelled.
    • ENOCONN (RequestError) - No connection is specified for that request.
    • ENOTOPEN (ConnectionError) - Connection not yet open.
    • ECONNCLOSED (ConnectionError) - Connection is closed.
    • ENOTBEGUN (TransactionError) - Transaction has not begun.
    • EABORT (TransactionError) - Transaction was aborted (by user or because of an error).

    ### cancel()

    Cancel currently executing request. Return true if cancellation packet was send successfully.

    Example

    var request = new sql.Request();
    request.query('waitfor delay \'00:00:05\'; select 1 as number', function(err, recordset) {
        console.log(err instanceof sql.RequestError);  // true
        console.log(err.message);                      // Cancelled.
        console.log(err.code);                         // ECANCEL
    
        // ...
    });
    
    request.cancel();
    ## Transactions

    IMPORTANT: always use Transaction class to create transactions - it ensures that all your requests are executed on one connection. Once you call begin, a single connection is acquired from the connection pool and all subsequent requests (initialized with the Transaction object) are executed exclusively on this connection. Transaction also contains a queue to make sure your requests are executed in series. After you call commit or rollback, connection is then released back to the connection pool.

    var transaction = new sql.Transaction(/* [connection] */);

    If you omit connection argument, global connection is used instead.

    Example

    var transaction = new sql.Transaction(/* [connection] */);
    transaction.begin(function(err) {
        // ... error checks
    
        var request = new sql.Request(transaction);
        request.query('insert into mytable (mycolumn) values (12345)', function(err, recordset) {
            // ... error checks
    
            transaction.commit(function(err, recordset) {
                // ... error checks
    
                console.log("Transaction committed.");
            });
        });
    });

    Transaction can also be created by var transaction = connection.transaction();. Requests can also be created by var request = transaction.request();.

    Aborted transactions

    This example shows how you should correctly handle transaction errors when abortTransactionOnError (XACT_ABORT) is enabled. Added in 2.0.

    var transaction = new sql.Transaction(/* [connection] */);
    transaction.begin(function(err) {
        // ... error checks
    
        var rolledBack = false;
    
        transaction.on('rollback', function(aborted) {
    	    // emited with aborted === true
    
    	    rolledBack = true;
        });
    
        var request = new sql.Request(transaction);
        request.query('insert into mytable (bitcolumn) values (2)', function(err, recordset) {
            // insert should fail because of invalid value
    
    		if (err) {
    			if (!rolledBack) {
    		        transaction.rollback(function(err) {
    		            // ... error checks
    		        });
    		    }
    		} else {
    			transaction.commit(function(err) {
    	            // ... error checks
    	        });
    		}
        });
    });

    Events

    • begin - Dispatched when transaction begin.
    • commit - Dispatched on successful commit.
    • rollback(aborted) - Dispatched on successful rollback with an argument determining if the transaction was aborted (by user or because of an error).

    ### begin([isolationLevel], [callback])

    Begin a transaction.

    Arguments

    • isolationLevel - Controls the locking and row versioning behavior of TSQL statements issued by a connection. Optional. READ_COMMITTED by default. For possible values see sql.ISOLATION_LEVEL.
    • callback(err) - A callback which is called after transaction has began, or an error has occurred. Optional. If omitted, returns Promise.

    Example

    var transaction = new sql.Transaction();
    transaction.begin(function(err) {
        // ... error checks
    });

    Errors

    • ENOTOPEN (ConnectionError) - Connection not yet open.
    • EALREADYBEGUN (TransactionError) - Transaction has already begun.

    ### commit([callback])

    Commit a transaction.

    Arguments

    • callback(err) - A callback which is called after transaction has committed, or an error has occurred. Optional. If omitted, returns Promise.

    Example

    var transaction = new sql.Transaction();
    transaction.begin(function(err) {
        // ... error checks
    
        transaction.commit(function(err) {
            // ... error checks
        })
    });

    Errors

    • ENOTBEGUN (TransactionError) - Transaction has not begun.
    • EREQINPROG (TransactionError) - Can't commit transaction. There is a request in progress.

    ### rollback([callback])

    Rollback a transaction. If the queue isn't empty, all queued requests will be Cancelled and the transaction will be marked as aborted.

    Arguments

    • callback(err) - A callback which is called after transaction has rolled back, or an error has occurred. Optional. If omitted, returns Promise.

    Example

    var transaction = new sql.Transaction();
    transaction.begin(function(err) {
        // ... error checks
    
        transaction.rollback(function(err) {
            // ... error checks
        })
    });

    Errors

    • ENOTBEGUN (TransactionError) - Transaction has not begun.
    • EREQINPROG (TransactionError) - Can't rollback transaction. There is a request in progress.
    ## PreparedStatement

    IMPORTANT: always use PreparedStatement class to create prepared statements - it ensures that all your executions of prepared statement are executed on one connection. Once you call prepare, a single connection is acquired from the connection pool and all subsequent executions are executed exclusively on this connection. Prepared Statement also contains a queue to make sure your executions are executed in series. After you call unprepare, the connection is then released back to the connection pool.

    var ps = new sql.PreparedStatement(/* [connection] */);

    If you omit the connection argument, the global connection is used instead.

    Example

    var ps = new sql.PreparedStatement(/* [connection] */);
    ps.input('param', sql.Int);
    ps.prepare('select @param as value', function(err) {
        // ... error checks
    
        ps.execute({param: 12345}, function(err, recordset) {
            // ... error checks
    
            ps.unprepare(function(err) {
                // ... error checks
    
            });
        });
    });

    IMPORTANT: Remember that each prepared statement means one reserved connection from the pool. Don't forget to unprepare a prepared statement!

    TIP: You can also create prepared statements in transactions (new sql.PreparedStatement(transaction)), but keep in mind you can't execute other requests in the transaction until you call unprepare.


    ### input(name, type)

    Add an input parameter to the prepared statement.

    Arguments

    • name - Name of the input parameter without @ char.
    • type - SQL data type of input parameter.

    Example

    ps.input('input_parameter', sql.Int);
    ps.input('input_parameter', sql.VarChar(50));

    Errors (synchronous)

    • EARGS (PreparedStatementError) - Invalid number of arguments.
    • EINJECT (PreparedStatementError) - SQL injection warning.

    ### output(name, type)

    Add an output parameter to the prepared statement.

    Arguments

    • name - Name of the output parameter without @ char.
    • type - SQL data type of output parameter.

    Example

    ps.output('output_parameter', sql.Int);
    ps.output('output_parameter', sql.VarChar(50));

    Errors (synchronous)

    • EARGS (PreparedStatementError) - Invalid number of arguments.
    • EINJECT (PreparedStatementError) - SQL injection warning.

    ### prepare(statement, [callback])

    Prepare a statement.

    Arguments

    • statement - T-SQL statement to prepare.
    • callback(err) - A callback which is called after preparation has completed, or an error has occurred. Optional. If omitted, returns Promise.

    Example

    var ps = new sql.PreparedStatement();
    ps.prepare('select @param as value', function(err) {
        // ... error checks
    });

    Errors

    • ENOTOPEN (ConnectionError) - Connection not yet open.
    • EALREADYPREPARED (PreparedStatementError) - Statement is already prepared.
    • ENOTBEGUN (TransactionError) - Transaction has not begun.

    ### execute(values, [callback])

    Execute a prepared statement.

    Arguments

    • values - An object whose names correspond to the names of parameters that were added to the prepared statement before it was prepared.
    • callback(err) - A callback which is called after execution has completed, or an error has occurred. Optional. If omitted, returns Promise.

    Example

    var ps = new sql.PreparedStatement();
    ps.input('param', sql.Int);
    ps.prepare('select @param as value', function(err) {
        // ... error checks
    
        ps.execute({param: 12345}, function(err, recordset, affected) {
            // ... error checks
    
            console.log(recordset[0].value); // return 12345
            console.log(affected); // Returns number of affected rows in case of INSERT, UPDATE or DELETE statement.
        });
    });

    You can enable multiple recordsets by ps.multiple = true command.

    var ps = new sql.PreparedStatement();
    ps.input('param', sql.Int);
    ps.prepare('select @param as value', function(err) {
        // ... error checks
    
        ps.multiple = true;
        ps.execute({param: 12345}, function(err, recordsets, affected) {
            // ... error checks
    
            console.log(recordsets[0][0].value); // return 12345
            console.log(affected); // Returns number of affected rows in case of INSERT, UPDATE or DELETE statement.
        });
    });

    You can also stream executed request.

    var ps = new sql.PreparedStatement();
    ps.input('param', sql.Int);
    ps.prepare('select @param as value', function(err) {
        // ... error checks
    
        ps.stream = true;
        request = ps.execute({param: 12345});
    
        request.on('recordset', function(columns) {
        	// Emitted once for each recordset in a query
        });
    
        request.on('row', function(row) {
        	// Emitted for each row in a recordset
        });
    
        request.on('error', function(err) {
        	// May be emitted multiple times
        });
    
        request.on('done', function(returnValue, affected) {
        	// Always emitted as the last one
        	
            console.log(affected); // Returns number of affected rows in case of INSERT, UPDATE or DELETE statement.
        });
    });

    TIP: To learn more about how number of affected rows works, see section Affected Rows.

    Errors

    • ENOTPREPARED (PreparedStatementError) - Statement is not prepared.
    • ETIMEOUT (RequestError) - Request timeout.
    • EREQUEST (RequestError) - Message from SQL Server
    • ECANCEL (RequestError) - Cancelled.

    ### unprepare([callback])

    Unprepare a prepared statement.

    Arguments

    • callback(err) - A callback which is called after unpreparation has completed, or an error has occurred. Optional. If omitted, returns Promise.

    Example

    var ps = new sql.PreparedStatement();
    ps.input('param', sql.Int);
    ps.prepare('select @param as value', function(err, recordsets) {
        // ... error checks
    
        ps.unprepare(function(err) {
            // ... error checks
    
        });
    });

    Errors

    • ENOTPREPARED (PreparedStatementError) - Statement is not prepared.
    ## CLI

    Before you can start using CLI, you must install mssql globally with npm install mssql -g. Once you do that you will be able to execute mssql command.

    Setup

    Create a .mssql.json configuration file (anywhere). Structure of the file is the same as the standard configuration object.

    {
        "user": "...",
        "password": "...",
        "server": "localhost",
        "database": "..."
    }

    Example

    echo "select * from mytable" | mssql /path/to/config

    Results in:

    [[{"username":"patriksimek","password":"tooeasy"}]]

    You can also query for multiple recordsets.

    echo "select * from mytable; select * from myothertable" | mssql

    Results in:

    [[{"username":"patriksimek","password":"tooeasy"}],[{"id":15,"name":"Product name"}]]

    If you omit config path argument, mssql will try to load it from current working directory.

    Version

    2.0

    ## Geography and Geometry

    node-mssql has built-in serializer for Geography and Geometry CLR data types.

    select geography::STGeomFromText('LINESTRING(-122.360 47.656, -122.343 47.656 )', 4326)
    select geometry::STGeomFromText('LINESTRING (100 100 10.3 12, 20 180, 180 180)', 0)

    Results in:

    { srid: 4326,
      version: 1,
      points: [ { x: 47.656, y: -122.36 }, { x: 47.656, y: -122.343 } ],
      figures: [ { attribute: 1, pointOffset: 0 } ],
      shapes: [ { parentOffset: -1, figureOffset: 0, type: 2 } ],
      segments: [] }
    
    { srid: 0,
      version: 1,
      points:
       [ { x: 100, y: 100, z: 10.3, m: 12 },
         { x: 20, y: 180, z: NaN, m: NaN },
         { x: 180, y: 180, z: NaN, m: NaN } ],
      figures: [ { attribute: 1, pointOffset: 0 } ],
      shapes: [ { parentOffset: -1, figureOffset: 0, type: 2 } ],
      segments: [] }
    ## Table-Valued Parameter (TVP)

    Supported on SQL Server 2008 and later. You can pass a data table as a parameter to stored procedure. First, we have to create custom type in our database.

    CREATE TYPE TestType AS TABLE ( a VARCHAR(50), b INT );

    Next we will need a stored procedure.

    CREATE PROCEDURE MyCustomStoredProcedure (@tvp TestType readonly) AS SELECT * FROM @tvp

    Now let's go back to our Node.js app.

    var tvp = new sql.Table()
    
    // Columns must correspond with type we have created in database.
    tvp.columns.add('a', sql.VarChar(50));
    tvp.columns.add('b', sql.Int);
    
    // Add rows
    tvp.rows.add('hello tvp', 777); // Values are in same order as columns.

    You can send table as a parameter to stored procedure.

    var request = new sql.Request();
    request.input('tvp', tvp);
    request.execute('MyCustomStoredProcedure', function(err, recordsets, returnValue) {
        // ... error checks
    
        console.dir(recordsets[0][0]); // {a: 'hello tvp', b: 777}
    });

    TIP: You can also create Table variable from any recordset with recordset.toTable().

    ## Affected Rows

    If you're performing INSERT, UPDATE or DELETE in a query, you can read number of affected rows.

    Example using Promises

    var request = new sql.Request();
    request.query('update myAwesomeTable set awesomness = 100').then(function(recordset) {
        console.log(request.rowsAffected);
    });

    Example using callbacks

    var request = new sql.Request();
    request.query('update myAwesomeTable set awesomness = 100', function(err, recordset, affected) {
        console.log(affected);
    });

    Example using streaming

    var request = new sql.Request();
    request.stream = true;
    request.query('update myAwesomeTable set awesomness = 100');
    request.on('done', function(affected) {
        console.log(affected);
    });

    NOTE: If your query contains multiple INSERT, UPDATE or DELETE statements, the number of affected rows is a sum of all of them.

    ## JSON support (experimental, works only with Tedious driver)

    SQL Server 2016 introduced built-in JSON serialization. By default, JSON is returned as a plain text in a special column named JSON_F52E2B61-18A1-11d1-B105-00805F49916B.

    Example

    SELECT
        1 AS 'a.b.c',
        2 AS 'a.b.d',
        3 AS 'a.x',
        4 AS 'a.y'
    FOR JSON PATH

    Results in:

    recordset = [ { 'JSON_F52E2B61-18A1-11d1-B105-00805F49916B': '{"a":{"b":{"c":1,"d":2},"x":3,"y":4}}' } ]

    You can enable built-in JSON parser with config.parseJSON = true. Once you enable this, recordset will contain rows of parsed JS objects. Given the same example, result will look like this:

    recordset = [ { a: { b: { c: 1, d: 2 }, x: 3, y: 4 } } ]

    IMPORTANT: In order for this to work, there must be exactly one column named JSON_F52E2B61-18A1-11d1-B105-00805F49916B in the recordset.

    More information about JSON support can be found in official documentation.

    Version

    2.3

    ## Errors

    There are 4 types of errors you can handle:

    • ConnectionError - Errors related to connections and connection pool.
    • TransactionError - Errors related to creating, committing and rolling back transactions.
    • RequestError - Errors related to queries and stored procedures execution.
    • PreparedStatementError - Errors related to prepared statements.

    Those errors are initialized in node-mssql module and its original stack may be cropped. You can always access original error with err.originalError.

    SQL Server may generate more than one error for one request so you can access preceding errors with err.precedingErrors.

    Error Codes

    Each known error has name, code and message properties.

    Name Code Message
    ConnectionError ELOGIN Login failed.
    ConnectionError ETIMEOUT Connection timeout.
    ConnectionError EDRIVER Unknown driver.
    ConnectionError EALREADYCONNECTED Database is already connected!
    ConnectionError EALREADYCONNECTING Already connecting to database!
    ConnectionError ENOTOPEN Connection not yet open.
    ConnectionError EINSTLOOKUP Instance lookup failed.
    ConnectionError ESOCKET Socket error.
    ConnectionError ECONNCLOSED Connection is closed.
    TransactionError ENOTBEGUN Transaction has not begun.
    TransactionError EALREADYBEGUN Transaction has already begun.
    TransactionError EREQINPROG Can't commit/rollback transaction. There is a request in progress.
    TransactionError EABORT Transaction has been aborted.
    RequestError EREQUEST Message from SQL Server. Error object contains additional details.
    RequestError ECANCEL Cancelled.
    RequestError ETIMEOUT Request timeout.
    RequestError EARGS Invalid number of arguments.
    RequestError EINJECT SQL injection warning.
    RequestError ENOCONN No connection is specified for that request.
    PreparedStatementError EARGS Invalid number of arguments.
    PreparedStatementError EINJECT SQL injection warning.
    PreparedStatementError EALREADYPREPARED Statement is already prepared.
    PreparedStatementError ENOTPREPARED Statement is not prepared.

    Detailed SQL Errors

    SQL errors (RequestError with err.code equal to EREQUEST) contains additional details.

    • err.number - The error number.
    • err.state - The error state, used as a modifier to the error number.
    • err.class - The class (severity) of the error. A class of less than 10 indicates an informational message. Detailed explanation can be found here.
    • err.lineNumber - The line number in the SQL batch or stored procedure that caused the error. Line numbers begin at 1; therefore, if the line number is not applicable to the message, the value of LineNumber will be 0.
    • err.serverName - The server name.
    • err.procName - The stored procedure name.
    ## Metadata

    Recordset metadata are accessible through the recordset.columns property.

    var request = new sql.Request();
    request.query('select convert(decimal(18, 4), 1) as first, \'asdf\' as second', function(err, recordset) {
        console.dir(recordset.columns);
    
        console.log(recordset.columns.first.type === sql.Decimal); // true
        console.log(recordset.columns.second.type === sql.VarChar); // true
    });

    Columns structure for example above:

    {
    	first: {
    		index: 0,
    		name: 'first',
    		length: 17,
    		type: [sql.Decimal],
    		scale: 4,
    		precision: 18,
    		nullable: true,
    		caseSensitive: false
    		identity: false
    		readOnly: true
    	},
    	second: {
    		index: 1,
    		name: 'second',
    		length: 4,
    		type: [sql.VarChar],
    		nullable: false,
    		caseSensitive: false
    		identity: false
    		readOnly: true
    	}
    }
    ## Data Types

    You can define data types with length/precision/scale:

    request.input("name", sql.VarChar, "abc");               // varchar(3)
    request.input("name", sql.VarChar(50), "abc");           // varchar(50)
    request.input("name", sql.VarChar(sql.MAX), "abc");      // varchar(MAX)
    request.output("name", sql.VarChar);                     // varchar(8000)
    request.output("name", sql.VarChar, "abc");              // varchar(3)
    
    request.input("name", sql.Decimal, 155.33);              // decimal(18, 0)
    request.input("name", sql.Decimal(10), 155.33);          // decimal(10, 0)
    request.input("name", sql.Decimal(10, 2), 155.33);       // decimal(10, 2)
    
    request.input("name", sql.DateTime2, new Date());        // datetime2(7)
    request.input("name", sql.DateTime2(5), new Date());     // datetime2(5)

    List of supported data types:

    sql.Bit
    sql.BigInt
    sql.Decimal ([precision], [scale])
    sql.Float
    sql.Int
    sql.Money
    sql.Numeric ([precision], [scale])
    sql.SmallInt
    sql.SmallMoney
    sql.Real
    sql.TinyInt
    
    sql.Char ([length])
    sql.NChar ([length])
    sql.Text
    sql.NText
    sql.VarChar ([length])
    sql.NVarChar ([length])
    sql.Xml
    
    sql.Time ([scale])
    sql.Date
    sql.DateTime
    sql.DateTime2 ([scale])
    sql.DateTimeOffset ([scale])
    sql.SmallDateTime
    
    sql.UniqueIdentifier
    
    sql.Variant
    
    sql.Binary
    sql.VarBinary ([length])
    sql.Image
    
    sql.UDT
    sql.Geography
    sql.Geometry
    

    To setup MAX length for VarChar, NVarChar and VarBinary use sql.MAX length. Types sql.XML and sql.Variant are not supported as input parameters.

    ## SQL injection

    This module has built-in SQL injection protection. Always use parameters to pass sanitized values to your queries.

    var request = new sql.Request();
    request.input('myval', sql.VarChar, '-- commented');
    request.query('select @myval as myval', function(err, recordset) {
        console.dir(recordset);
    });
    ## Verbose Mode

    You can enable verbose mode by request.verbose = true command.

    var request = new sql.Request();
    request.verbose = true;
    request.input('username', 'patriksimek');
    request.input('password', 'dontuseplaintextpassword');
    request.input('attempts', 2);
    request.execute('my_stored_procedure');

    Output for the example above could look similar to this.

    ---------- sql execute --------
         proc: my_stored_procedure
        input: @username, varchar, patriksimek
        input: @password, varchar, dontuseplaintextpassword
        input: @attempts, bigint, 2
    ---------- response -----------
    { id: 1,
      username: 'patriksimek',
      password: 'dontuseplaintextpassword',
      email: null,
      language: 'en',
      attempts: 2 }
    ---------- --------------------
       return: 0
     duration: 5ms
    ---------- completed ----------
    
    ## Known issues

    Tedious

    • If you're facing problems with connecting SQL Server 2000, try setting the default TDS version to 7.1 with config.options.tdsVersion = '7_1' (issue)
    • If you're executing a statement longer than 4000 chars on SQL Server 2000, always use batch instead of query (issue)

    msnodesqlv8

    • msnodesqlv8 has problem with errors during transactions - reported.
    • msnodesqlv8 doesn't timeout the connection reliably - reported.
    • msnodesqlv8 doesn't support TVP data type.
    • msnodesqlv8 doesn't support Variant data type.
    • msnodesqlv8 doesn't support request timeout.
    • msnodesqlv8 doesn't support request cancellation.
    • msnodesqlv8 doesn't support detailed SQL errors.

    msnodesql

    • msnodesql has problem with errors during transactions - reported.
    • msnodesql contains bug in DateTimeOffset (reported)
    • msnodesql doesn't support Bulk load.
    • msnodesql doesn't support TVP data type.
    • msnodesql doesn't support Variant data type.
    • msnodesql doesn't support connection timeout.
    • msnodesql doesn't support request timeout.
    • msnodesql doesn't support request cancellation.
    • msnodesql doesn't support detailed SQL errors.
    • msnodesql reports invalid number of affected rows in some cases.

    node-tds

    • If you're facing problems with date, try changing your tsql language set language 'English';.
    • node-tds doesn't support connecting to named instances.
    • node-tds contains bug and return same value for columns with same name.
    • node-tds doesn't support codepage of input parameters.
    • node-tds contains bug in selects that doesn't return any values (select @param = 'value').
    • node-tds doesn't support Binary, VarBinary and Image as parameters.
    • node-tds always return date/time values in local time.
    • node-tds has serious problems with MAX types.
    • node-tds doesn't support Bulk load.
    • node-tds doesn't support TVP data type.
    • node-tds doesn't support Variant data type.
    • node-tds doesn't support request timeout.
    • node-tds doesn't support built-in JSON serialization introduced in SQL Server 2016.
    • node-tds doesn't support detailed SQL errors.
    • node-tds doesn't support Affected Rows
    ## License

    Copyright (c) 2013-2015 Patrik Simek

    The MIT License

    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.

    Install

    npm i @quorum/mssql

    DownloadsWeekly Downloads

    1

    Version

    3.0.1

    License

    MIT

    Unpacked Size

    407 kB

    Total Files

    34

    Last publish

    Collaborators

    • botovance
    • matt-at-autovance
    • murraynator