@jeffbski-rga/mssql

Microsoft SQL Server client for Node.js with Node.js compatible pipe supporting back pressure

This fork improves the Node.js stream compatibility of it's pipe capability supporting back pressure. Once the changes are accepted back into the original repo this repo will be deprecated.

https://github.com/jeffbski-rga/node-mssql

Supported TDS drivers:

• Tedious (pure JavaScript - Windows/macOS/Linux, default)
• Microsoft / Contributors Node V8 Driver for Node.js for SQL Server (native - Windows only)

Installation

npm install @jeffbski-rga/mssql

Quick Example

const sql = require('mssql')
 
async () => {
    try {
        // make sure that any items are correctly URL encoded in the connection string
        await sql.connect('mssql://username:password@localhost/database')
        const result = await sql.query`select * from mytable where id = ${value}`
        console.dir(result)
    } catch (err) {
        // ... error checks
    }
}

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

Parts of the connection URI should be correctly URL encoded so that the URI can be parsed correctly.

Documentation

Examples

• Async/Await
• Promises
• ES6 Tagged template literals
• Callbacks
• Streaming
• Connection Pools

Configuration

• General
• Formats

Drivers

• Tedious
• Microsoft / Contributors Node V8 Driver for Node.js for SQL Server

Connections

• Pool Management
• ConnectionPool
• connect
• close

Requests

• Request
• execute
• input
• output
• toReadableStream
• pipe
• query
• batch
• bulk
• cancel

Transactions

• Transaction
• begin
• commit
• rollback

Prepared Statements

• PreparedStatement
• input
• output
• prepare
• execute
• unprepare

Other

• CLI
• Geography and Geometry
• Table-Valued Parameter
• Affected Rows
• JSON support
• Errors
• Informational messages
• Metadata
• Data Types
• SQL injection
• Known Issues
• Contributing
• 5.x to 6.x changes
• 4.x to 5.x changes
• 3.x to 4.x changes
• 3.x Documentation

Examples

Config

const config = {
    user: '...',
    password: '...',
    server: 'localhost', // You can use 'localhost\\instance' to connect to named instance
    database: '...',
}

Async/Await

const sql = require('mssql')
 
(async function () {
    try {
        let pool = await sql.connect(config)
        let result1 = await pool.request()
            .input('input_parameter', sql.Int, value)
            .query('select * from mytable where id = @input_parameter')
            
        console.dir(result1)
    
        // Stored procedure
        
        let result2 = await pool.request()
            .input('input_parameter', sql.Int, value)
            .output('output_parameter', sql.VarChar(50))
            .execute('procedure_name')
        
        console.dir(result2)
    } catch (err) {
        // ... error checks
    }
})()
 
sql.on('error', err => {
    // ... error handler
})

Promises

Queries

const sql = require('mssql')
 
sql.on('error', err => {
    // ... error handler
})
 
sql.connect(config).then(pool => {
    // Query
    
    return pool.request()
        .input('input_parameter', sql.Int, value)
        .query('select * from mytable where id = @input_parameter')
}).then(result => {
    console.dir(result)
}).catch(err => {
  // ... error checks
});

Stored procedures

const sql = require('mssql')
 
sql.on('error', err => {
    // ... error handler
})
 
sql.connect(config).then(pool => {
    
    // Stored procedure
    
    return pool.request()
        .input('input_parameter', sql.Int, value)
        .output('output_parameter', sql.VarChar(50))
        .execute('procedure_name')
}).then(result => {
    console.dir(result)
}).catch(err => {
    // ... error checks
})

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

ES6 Tagged template literals

const sql = require('mssql')
 
sql.connect(config).then(() => {
    return sql.query`select * from mytable where id = ${value}`
}).then(result => {
    console.dir(result)
}).catch(err => {
    // ... error checks
})
 
sql.on('error', err => {
    // ... error handler
})

All values are automatically sanitized against sql injection. This is because it is rendered as prepared statement, and thus all limitations imposed in MS SQL on parameters apply. e.g. Column names cannot be passed/set in statements using variables.

Callbacks

const sql = require('mssql')
 
sql.connect(config, err => {
    // ... error checks
 
    // Query
 
    new sql.Request().query('select 1 as number', (err, result) => {
        // ... error checks
 
        console.dir(result)
    })
 
    // Stored Procedure
 
    new sql.Request()
    .input('input_parameter', sql.Int, value)
    .output('output_parameter', sql.VarChar(50))
    .execute('procedure_name', (err, result) => {
        // ... error checks
 
        console.dir(result)
    })
 
    // Using template literal
 
    const request = new sql.Request()
    request.query(request.template`select * from mytable where id = ${value}`, (err, result) => {
        // ... error checks
        console.dir(result)
    })
})
 
sql.on('error', 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.

const sql = require('mssql')
 
sql.connect(config, err => {
    // ... error checks
 
    const 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', columns => {
        // Emitted once for each recordset in a query
    })
 
    request.on('row', row => {
        // Emitted for each row in a recordset
    })
 
    request.on('error', err => {
        // May be emitted multiple times
    })
 
    request.on('done', result => {
        // Always emitted as the last one
    })
})
 
sql.on('error', err => {
    // ... error handler
})

When streaming large sets of data you want to back-off or chunk the amount of data you're processing to prevent memory exhaustion issues; you can use the Request.pause() function to do this. Here is an example of managing rows in batches of 15:

let rowsToProcess = [];
request.on('row', row => {
  rowsToProcess.push(row);
  if (rowsToProcess.length >= 15) {
    request.pause();
    processRows();
  }
});
request.on('done', () => {
    processRows();
});
 
function processRows() {
  // process rows
  rowsToProcess = [];
  request.resume();
}

Pool Management

An important concept to understand when using this library is Connection Pooling as this library uses connection pooling extensively.

As one Node JS process is able to handle multiple requests at once, we can take advantage of this long running process to create a pool of database connections for reuse; this saves overhead of connecting to the database for each request (as would be the case in something like PHP, where one process handles one request).

With the advantages of pooling comes some added complexities, but these are mostly just conceptual and once you understand how the pooling is working, it is simple to make use of it efficiently and effectively.

The Global Connection (Pool)

To assist with pool management in your application there is the global connect() function that is available for use. As of v6 of this library a developer can make repeated calls to this function to obtain the global connection pool. This means you do not need to keep track of the pool in your application (as used to be the case). If the global pool is already connected, it will resolve to the connected pool. For example:

const sql = require('mssql')
 
// run a query against the global connection pool
function runQuery(query) {
  // sql.connect() will return the existing global pool if it exists or create a new one if it doesn't
  return sql.connect().then((pool) => {
    return pool.query(query)
  })
}
 

Here we obtain the global connection pool by running sql.connect() and we then run the query against the pool. We also do not close the pool after the query is executed and that is because other queries may need to be run against this pool and closing it will add an overhead to running the query. We should only ever close the pool when our application is finished. For example, if we are running some kind of CLI tool or a CRON job:

const sql = require('mssql')
 
(() => {
  sql.connect().then(pool => {
    return pool.query('SELECT 1')
  }).then(result => {
    // do something with result
  }).then(() => {
    return sql.close()
  })
})()

Here the connection will be closed and the node process will exit once the queries and other application logic has completed. You should aim to only close the pool once in your application, when it is exiting or you know your application will never make another SQL query.

Advanced Pool Management

In some instances you will not want to use the connection pool, you may have multiple databases to connect to or you may have one pool for read-only operations and another pool for read-write. In this instance you will need to implement your own pool management.

That could look something like this:

const { ConnectionPool } = require('mssql')
const POOLS = {}
 
function createPool(config, name) {
  if (getPool(name)) {
    throw new Error('Pool with this name already exists')
  }
  return POOLS[name] = (new ConnectionPool(config)).connect()
}
 
function closePool(name) {
  if (Object.prototype.hasOwnProperty.apply(POOLS, name)) {
    const pool = POOLS[name];
    delete POOLS[name];
    return pool.close()
  }
}
 
function getPool(name) {
  if (Object.prototype.hasOwnProperty.apply(POOLS, name)) {
    return POOLS[name]
  }
}
 
module.exports = {
  closePool,
  createPool,
  getPool
}

This helper file can then be used in your application to create, fetch and close your pools. As with the global pools, you should aim to only close a pool when you know it will never be needed by the application again; typically this will be when your application is shutting down.

Connection Pools

Using a single connection pool for your application/service is recommended. Instantiating a pool with a callback, or immediately calling .connect, is asynchronous to ensure a connection can be established before returning. From that point, you're able to acquire connections as normal:

const sql = require('mssql')
 
// async/await style:
const pool1 = new sql.ConnectionPool(config);
const pool1Connect = pool1.connect();
 
pool1.on('error', err => {
    // ... error handler
})
 
async function messageHandler() {
    await pool1Connect; // ensures that the pool has been created
    try {
        const request = pool1.request(); // or: new sql.Request(pool1)
        const result = await request.query('select 1 as number')
        console.dir(result)
        return result;
    } catch (err) {
        console.error('SQL error', err);
    }
}
 
// promise style:
const pool2 = new sql.ConnectionPool(config)
const pool2Connect = pool2.connect()
 
pool2.on('error', err => {
    // ... error handler
})
 
function runStoredProcedure() {
    return pool2Connect.then((pool) => {
        pool.request() // or: new sql.Request(pool2)
        .input('input_parameter', sql.Int, 10)
        .output('output_parameter', sql.VarChar(50))
        .execute('procedure_name', (err, result) => {
            // ... error checks
            console.dir(result)
        })
    }).catch(err => {
        // ... error handler
    })
}

Awaiting or .thening the pool creation is a safe way to ensure that the pool is always ready, without knowing where it is needed first. In practice, once the pool is created then there will be no delay for the next operation.

As of v6.1.0 you can make repeat calls to ConnectionPool.connect() and ConnectonPool.close() without an error being thrown, allowing for the safe use of mssql.connect().then(...) throughout your code as well as making multiple calls to close when your application is shutting down.

The ability to call connect() repeatedly is intended to make pool management easier, however it is still recommended to follow the example above where connect() is called once and using the original resolved connection promise. Repeatedly calling connect() when running queries risks running into problems when close() is called on the pool.

ES6 Tagged template literals

new sql.ConnectionPool(config).connect().then(pool => {
    return pool.query`select * from mytable where id = ${value}`
}).then(result => {
    console.dir(result)
}).catch(err => {
    // ... error checks
})

All values are automatically sanitized against sql injection.

Managing connection pools

Most applications will only need a single ConnectionPool that can be shared throughout the code. To aid the sharing of a single pool this library exposes a set of functions to access a single global connection. eg:

// as part of your application's boot process
 
const sql = require('mssql')
const poolPromise = sql.connect()
 
// during your applications runtime
 
poolPromise.then(() => {
  return sql.query('SELECT 1')
}).then(result => {
  console.dir(result)
})
 
// when your application exits
poolPromise.then(() => {
  return sql.close()
})

If you require multiple pools per application (perhaps you have many DBs you need to connect to or you want a read-only pool), then you will need to manage your pools yourself. The best way to do this is to create a shared library file that can hold references to the pools for you. For example:

const sql = require('mssql')
 
const pools = {}
 
// manage a set of pools by name (config will be required to create the pool)
// a pool will be removed when it is closed
async function getPool(name, config) {
  if (!Object.prototype.hasOwnProperty.call(pools, name)) {
    const pool = new sql.ConnectionPool(config)
    const close = pool.close.bind(pool)
    pool.close = (...args) => {
      delete pools[name]
      return close(...args)
    }
    await pool.connect()
    pools[name] = pool
  }
  return pools[name]
}
 
// close all pools
function closeAll() {
  return Promise.all(Object.values(pools).map((pool) => {
    return pool.close()
  }))
}
 
module.exports = {
  closeAll,
  getPool
}

You can then use this library file in your code to get a connected pool when you need it:

const { getPool } = require('./path/to/file')
 
// run a query
async function runQuery(query, config) {
  // pool will always be connected when the promise has resolved - may reject if the connection config is invalid
  const pool = await getPool('default', config)
  const result = await pool.request().query(query)
  return result
}

Configuration

const config = {
    user: '...',
    password: '...',
    server: 'localhost',
    database: '...',
    pool: {
        max: 10,
        min: 0,
        idleTimeoutMillis: 30000
    }
}

General (same for all drivers)

• 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). NOTE: msnodesqlv8 driver doesn't support timeouts < 1 second. When passed via connection string, the key must be request timeout
• 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).

Complete list of pool options can be found here.

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

Drivers

Tedious

Default driver, actively maintained and production ready. Platform independent, runs everywhere Node.js runs. Officially supported by Microsoft.

Extra options:

• beforeConnect(conn) - Function, which is invoked before opening the connection. The parameter conn is the configured tedious Connection. It can be used for attaching event handlers like in this example:

require('mssql').connect(...config, beforeConnect: conn => {
  conn.once('connect', err => { err ? console.error(err) : console.log('mssql connected')})
  conn.once('end', err => { err ? console.error(err) : console.log('mssql disconnected')})
}})

• options.instanceName - The instance name to connect to. The SQL Server Browser service must be running on the database server, and UDP port 1434 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: true).
• 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://tediousjs.github.io/tedious/api-connection.html

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

Requires Node.js 0.12.x or newer. Windows only. This driver is not part of the default package and must be installed separately by npm install msnodesqlv8. To use this driver, use this require syntax: const sql = require('mssql/msnodesqlv8').

Extra options:

• beforeConnect(conn) - Function, which is invoked before opening the connection. The parameter conn is the connection configuration, that can be modified to pass extra parameters to the driver's open() method.
• 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}};

Connections

Internally, each ConnectionPool 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 it will crash your application with an uncaught error.

const pool = new sql.ConnectionPool({ /* config */ })

Events

• error(err) - Dispatched on connection error.

connect ([callback])

Create a new connection pool. The initial probe connection is created to find out whether the configuration is valid.

Arguments

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

Example

const pool = new sql.ConnectionPool({
    user: '...',
    password: '...',
    server: 'localhost',
    database: '...'
})
 
pool.connect(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

pool.close()

Request

const request = new sql.Request(/* [pool or transaction] */)

If you omit pool/transaction argument, global pool 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.
• info(message) - Dispatched on informational message.

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

const request = new sql.Request()
request.input('input_parameter', sql.Int, value)
request.output('output_parameter', sql.Int)
request.execute('procedure_name', (err, result) => {
    // ... error checks
 
    console.log(result.recordsets.length) // count of recordsets returned by the procedure
    console.log(result.recordsets[0].length) // count of rows contained in first recordset
    console.log(result.recordset) // first recordset from result.recordsets
    console.log(result.returnValue) // procedure return value
    console.log(result.output) // key/value collection of output values
    console.log(result.rowsAffected) // array of numbers, each number represents the number of rows affected by executed statemens
 
    // ...
})

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.

NB: Do not use parameters @p{n} as these are used by the internal drivers and cause a conflict.

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.

toReadableStream

Convert request to a Node.js ReadableStream

Example

const { pipeline } = require('stream')
const request = new sql.Request()
const readableStream = request.toReadableStream()
pipeline(readableStream, transformStream, writableStream)
request.query('select * from mytable')

OR if you wanted to increase the highWaterMark of the read stream to buffer more rows in memory

const { pipeline } = require('stream')
const request = new sql.Request()
const readableStream = request.toReadableStream({ highWaterMark: 100 })
pipeline(readableStream, transformStream, writableStream)
request.query('select * from mytable')

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

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

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

const request = new sql.Request()
request.query('select 1 as number', (err, result) => {
    // ... error checks
 
    console.log(result.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).

const request = new sql.Request()
request.query('select 1 as number; select 2 as number', (err, result) => {
    // ... error checks
 
    console.log(result.recordset[0].number) // return 1
    console.log(result.recordsets[0][0].number) // return 1
    console.log(result.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

const request = new sql.Request()
request.batch('create procedure #temporary as select * from table', (err, result) => {
    // ... 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, [options,] [callback])

Perform a bulk insert.

Arguments

• table - sql.Table instance.
• options - Options object to be passed through to driver (currently tedious only). Optional. If argument is a function it will be treated as the callback.
• callback(err, rowCount) - A callback which is called after bulk insert has completed, or an error has occurred. Optional. If omitted, returns Promise.

Example

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