mssql 8.0.0 → 8.1.0

package/CHANGELOG.txt

@@ -1,3 +1,18 @@
+v8.1.0 (2022-04-06)
+-------------------
+[new] MSSQL CLI tool now accepts some options to allow overriding config file ((#1381](https://github.com/tediousjs/node-mssql/pull/1381))
+[fix] nodemsqlv8 driver tests working against Node 10 ([#1368](https://github.com/tediousjs/node-mssql/pull/1368))
+
+v8.0.2 (2022-02-07)
+-------------------
+Merge up missing fixes from v7.3.0
+[new] Transaction/PreparedStatements expose the config from their parent connection ([#1338](https://github.com/tediousjs/node-mssql/pull/1338))
+[fix] Fix inherited request configs from the pool. Specifically stream and arrayRowMode now inherit accurately from the connection config ([#1338](https://github.com/tediousjs/node-mssql/pull/1338))
+
+v8.0.1 (2022-01-30)
+-------------------
+Re-release of v8.0.0
+
 v8.0.0 (2022-01-30)
 -------------------
 [new] Add table.rows.clear() method to allow for chunking updates ([#1094](https://github.com/tediousjs/node-mssql/pull/1094))
@@ -9,6 +24,16 @@ v8.0.0 (2022-01-30)
 [change] Duplicate column names will now be presented as an array even if the values are empty ((#1240)[https://github.com/tediousjs/node-mssql/pull/1240])
 [change] Update tarn pool dependency ((#1344)[https://github.com/tediousjs/node-mssql/pull/1344])
 [removed] Remove connection string parser helpers ((#1342)[https://github.com/tediousjs/node-mssql/pull/1342])
+[removed] Remove deprecated pool properties ((#1359)[https://github.com/tediousjs/node-mssql/pull/1359])
+
+v7.3.1 (2022-02-24)
+-------------------
+[fix] Bump debug dependency ([#1361](https://github.com/tediousjs/node-mssql/pull/1361))
+
+v7.3.0 (2021-11-18)
+-------------------
+[new] Transaction/PreparedStatements expose the config from their parent connection ([#1338](https://github.com/tediousjs/node-mssql/pull/1338))
+[fix] Fix inherited request configs from the pool. Specifically stream and arrayRowMode now inherit accurately from the connection config ([#1338](https://github.com/tediousjs/node-mssql/pull/1338))
 
 v7.2.1 (2021-08-19)
 -------------------
@@ -56,6 +81,15 @@ v7.0.0 (2021-05-06)
 [fix] Connection config objects are now deep cloned when stored against a connection pool ([#1217](https://github.com/tediousjs/node-mssql/pull/1217))
 [removed] Support for connection uri format has been removed (eg: `mssql://user:password@host/?params=values`)
 
+v6.4.1 (2022-02-24)
+-------------------
+[fix] Bump debug dependency ([#1361](https://github.com/tediousjs/node-mssql/pull/1361))
+
+v6.4.0 (2021-11-18)
+-------------------
+[new] Transaction/PreparedStatements expose the config from their parent connection
+[fix] Fix inherited request configs from the pool. Specifically stream and arrayRowMode now inherit accurately from the connection config ([#1338](https://github.com/tediousjs/node-mssql/pull/1338))
+
 v6.3.2 (2021-05-13)
 -------------------
 [fix] Bump various dependencies for security fixes

package/README.md

@@ -1380,7 +1380,7 @@ __Errors__
 
 ## 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.
+If you want to add the MSSQL CLI tool to your path, you must install it globally with `npm install -g mssql`.
 
 __Setup__
 
@@ -1417,6 +1417,18 @@ Results in:
 
 If you omit config path argument, mssql will try to load it from current working directory.
 
+__Overriding config settings__
+
+You can override some config settings via CLI options (`--user`, `--password`, `--server`, `--database`, `--port`).
+
+```shell
+echo "select * from mytable" | mssql /path/to/config --database anotherdatabase
+```
+Results in:
+```json
+[[{"username":"onotheruser","password":"quiteeasy"}]]
+```
+
 ## Geography and Geometry
 
 node-mssql has built-in deserializer for Geography and Geometry CLR data types.
@@ -2013,6 +2025,11 @@ request.query('select @myval as myval', (err, result) => {
 - 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](https://github.com/tediousjs/node-mssql/issues/36))
 - If you're executing a statement longer than 4000 chars on SQL Server 2000, always use [batch](#batch-batch-callback) instead of [query](#query-command-callback) ([issue](https://github.com/tediousjs/node-mssql/issues/68))
 
+## 7.x to 8.x changes
+
+- Upgraded to tedious version 14
+- Removed internal library for connection string parsing. Connection strings can be resolved using the static method `parseConnectionString` on ConnectionPool
+
 ## 6.x to 7.x changes
 
 - Upgraded tedious version to v11

package/bin/mssql

@@ -1,3 +1,131 @@
 #!/usr/bin/env node
+const { Command } = require('commander')
+const { version } = require('../package.json')
+const { resolve: resolvePath } = require('path')
+const { constants: { R_OK } } = require('fs')
+const { ConnectionPool } = require('../')
+const { lstat, access, readFile } = require('fs').promises
+Buffer.prototype.toJSON = () => {
+  return `0x${this.toString('hex')}`
+}
 
-require(__dirname +'/../lib/cli.js');
+/**
+ * @param {Readable} stream
+ * @returns {Promise<Buffer>}
+ */
+async function streamToBuffer (stream) {
+  const chunks = []
+  return new Promise((resolve, reject) => {
+    stream.on('data', (chunk) => {
+      chunks.push(chunk)
+    })
+    stream.on('end', () => {
+      resolve(Buffer.concat(chunks))
+    })
+    stream.on('error', reject)
+  })
+}
+
+async function resolveConfig (opts, cfgFile) {
+  const cfg = Object.entries({
+    options: {
+      encrypt: opts.encrypt,
+      trustServerCertificate: opts.trustServerCertificate
+    },
+    user: opts.user,
+    password: opts.password,
+    server: opts.server,
+    database: opts.database,
+    port: opts.port
+  }).reduce((config, [key, value]) => {
+    if (value) {
+      Object.assign(config, {
+        [key]: value
+      })
+    }
+    return config
+  }, {})
+  let cfgPath = cfgFile || process.cwd()
+  const stat = await lstat(resolvePath(cfgPath))
+  if (stat.isDirectory()) {
+    cfgPath = resolvePath(cfgPath, opts.config)
+  }
+  const configAccess = await access(cfgPath, R_OK).then(() => true).catch(() => false)
+  if (!configAccess) {
+    return cfg;
+  }
+  const config = await (readFile(cfgPath))
+    .then((content) => JSON.parse(content.toString()))
+
+  return {
+    ...config,
+    ...cfg,
+    options: {
+      ...(config.options || {}),
+      ...cfg.options
+    }
+  }
+}
+
+const program = new Command()
+
+program
+  .name('mssql')
+  .argument('[configPath]')
+  .description('CLI tools for node-mssql')
+  .version(version)
+  .option('--config <file>', 'Configuration file for the connection', './.mssql.json')
+  .option('--user <user>', 'User for the database connection')
+  .option('--password <password>', 'Password for the database connection')
+  .option('--server <server>', 'Server for the database connection')
+  .option('--database <database>', 'Database for the database connection')
+  .option('--port <port>', 'Port for the database connection', parseInt)
+  .option('--encrypt', 'Use the encrypt option for this connection', false)
+  .option('--trust-server-certificate', 'Trust the server certificate for this connection', false)
+  // .option('--format <format>', 'The output format to use, eg: JSON', 'json')
+  .action(async function (configPath, opts) {
+    const [config, statement] = await Promise.all([
+      resolveConfig(opts, configPath),
+      streamToBuffer(process.stdin).then((stmt) => stmt.toString().trim())
+    ])
+    if (!statement.length) {
+      throw new Error('Statement is empty.')
+    }
+    const pool = await (new ConnectionPool(config)).connect()
+    const request = pool.request()
+    request.stream = true
+    let started = false
+    request.on('error', (e) => {
+      pool.close()
+      throw e
+    })
+    request.on('recordset', () => {
+      if (started) {
+        process.stdout.write('],')
+      } else {
+        process.stdout.write('[')
+      }
+      started = false
+    })
+    request.on('row', (row) => {
+      if (!started) {
+        started = true
+        process.stdout.write('[')
+      } else {
+        process.stdout.write(',')
+      }
+      process.stdout.write(JSON.stringify(row))
+    })
+    request.on('done', () => {
+      if (started) {
+        process.stdout.write(']]')
+      }
+      process.stdout.write('\n')
+      pool.close()
+    })
+    request.query(statement)
+  })
+
+program.parseAsync(process.argv).catch((e) => {
+  program.error(e.message, { exitCode: 1 });
+})

package/lib/base/connection-pool.js

@@ -388,41 +388,6 @@ class ConnectionPool extends EventEmitter {
             propagateCreateError: true
           }, this.config.pool)
         )
-        const self = this
-        Object.defineProperties(this.pool, {
-          size: {
-            get: () => {
-              const message = 'the `size` property on pool is deprecated, access it directly on the `ConnectionPool`'
-              self.emit('debug', message)
-              process.emitWarning(message)
-              return self.size
-            }
-          },
-          available: {
-            get: () => {
-              const message = 'the `available` property on pool is deprecated, access it directly on the `ConnectionPool`'
-              self.emit('debug', message)
-              process.emitWarning(message)
-              return self.available
-            }
-          },
-          pending: {
-            get: () => {
-              const message = 'the `pending` property on pool is deprecate, access it directly on the `ConnectionPool`'
-              self.emit('debug', message)
-              process.emitWarning(message)
-              return self.pending
-            }
-          },
-          borrowed: {
-            get: () => {
-              const message = 'the `borrowed` property on pool is deprecated, access it directly on the `ConnectionPool`'
-              self.emit('debug', message)
-              process.emitWarning(message)
-              return self.borrowed
-            }
-          }
-        })
 
         this._connecting = false
         this._connected = true

package/lib/base/prepared-statement.js

@@ -35,6 +35,10 @@ class PreparedStatement extends EventEmitter {
     this.parameters = {}
   }
 
+  get config () {
+    return this.parent.config
+  }
+
   get connected () {
     return this.parent.connected
   }

package/lib/base/request.js

@@ -26,7 +26,7 @@ class Request extends EventEmitter {
   /**
    * Create new Request.
    *
-   * @param {Connection|ConnectionPool|Transaction|PreparedStatement} parent If ommited, global connection is used instead.
+   * @param {Connection|ConnectionPool|Transaction|PreparedStatement} parent If omitted, global connection is used instead.
    */
 
   constructor (parent) {
@@ -39,6 +39,8 @@ class Request extends EventEmitter {
     this._paused = false
     this.parent = parent || globalConnection.pool
     this.parameters = {}
+    this.stream = null
+    this.arrayRowMode = null
   }
 
   get paused () {
@@ -224,8 +226,8 @@ class Request extends EventEmitter {
    */
 
   batch (batch, callback) {
-    if (this.stream == null && this.connection) this.stream = this.connection.config.stream
-    if (this.arrayRowMode == null && this.connection) this.arrayRowMode = this.connection.config.arrayRowMode
+    if (this.stream === null && this.parent) this.stream = this.parent.config.stream
+    if (this.arrayRowMode === null && this.parent) this.arrayRowMode = this.parent.config.arrayRowMode
     this.rowsAffected = 0
 
     if (typeof callback === 'function') {
@@ -288,11 +290,11 @@ class Request extends EventEmitter {
    */
 
   _batch (batch, callback) {
-    if (!this.connection) {
+    if (!this.parent) {
       return setImmediate(callback, new RequestError('No connection is specified for that request.', 'ENOCONN'))
     }
 
-    if (!this.connection.connected) {
+    if (!this.parent.connected) {
       return setImmediate(callback, new ConnectionError('Connection is closed.', 'ECONNCLOSED'))
     }
 
@@ -317,8 +319,8 @@ class Request extends EventEmitter {
       options = {}
     }
 
-    if (this.stream == null && this.connection) this.stream = this.connection.config.stream
-    if (this.arrayRowMode == null && this.connection) this.arrayRowMode = this.connection.config.arrayRowMode
+    if (this.stream === null && this.parent) this.stream = this.parent.config.stream
+    if (this.arrayRowMode === null && this.parent) this.arrayRowMode = this.parent.config.arrayRowMode
 
     if (this.stream || typeof callback === 'function') {
       this._bulk(table, options, (err, rowsAffected) => {
@@ -419,8 +421,8 @@ class Request extends EventEmitter {
    */
 
   query (command, callback) {
-    if (this.stream == null && this.connection) this.stream = this.connection.config.stream
-    if (this.arrayRowMode == null && this.connection) this.arrayRowMode = this.connection.config.arrayRowMode
+    if (this.stream === null && this.parent) this.stream = this.parent.config.stream
+    if (this.arrayRowMode === null && this.parent) this.arrayRowMode = this.parent.config.arrayRowMode
     this.rowsAffected = 0
 
     if (typeof callback === 'function') {
@@ -508,8 +510,8 @@ class Request extends EventEmitter {
    */
 
   execute (command, callback) {
-    if (this.stream == null && this.connection) this.stream = this.connection.config.stream
-    if (this.arrayRowMode == null && this.connection) this.arrayRowMode = this.connection.config.arrayRowMode
+    if (this.stream === null && this.parent) this.stream = this.parent.config.stream
+    if (this.arrayRowMode === null && this.parent) this.arrayRowMode = this.parent.config.arrayRowMode
     this.rowsAffected = 0
 
     if (typeof callback === 'function') {

package/lib/base/transaction.js

@@ -37,6 +37,10 @@ class Transaction extends EventEmitter {
     this.name = ''
   }
 
+  get config () {
+    return this.parent.config
+  }
+
   get connected () {
     return this.parent.connected
   }

package/package.json

@@ -21,12 +21,13 @@
     "azure",
     "node-mssql"
   ],
-  "version": "8.0.0",
+  "version": "8.1.0",
   "main": "index.js",
   "repository": "github:tediousjs/node-mssql",
   "license": "MIT",
   "dependencies": {
     "@tediousjs/connection-string": "^0.3.0",
+    "commander": "^9.1.0",
     "debug": "^4.3.3",
     "rfdc": "^1.3.0",
     "tarn": "^3.0.2",
@@ -42,16 +43,16 @@
   "files": [
     "lib/",
     "bin/",
-    "*.js",
-    "*.md"
+    "tedious.js",
+    "msnodesqlv8.js"
   ],
   "scripts": {
     "test": "npm run lint && npm run test-unit",
     "lint": "standard",
-    "test-unit": "node_modules/.bin/mocha --exit -t 15000 test/common/unit.js",
-    "test-tedious": "node_modules/.bin/mocha --exit -t 15000 test/tedious",
-    "test-msnodesqlv8": "node_modules/.bin/mocha --exit -t 15000 test/msnodesqlv8",
-    "test-cli": "node_modules/.bin/mocha --exit -t 15000 test/common/cli.js"
+    "test-unit": "mocha --exit -t 15000 test/common/unit.js",
+    "test-tedious": "mocha --exit -t 15000 test/tedious",
+    "test-msnodesqlv8": "mocha --exit -t 15000 test/msnodesqlv8",
+    "test-cli": "mocha --exit -t 15000 test/common/cli.js"
   },
   "bin": {
     "mssql": "./bin/mssql"

package/lib/cli.js

@@ -1,113 +0,0 @@
-'use strict'
-
-const fs = require('fs')
-const path = require('path')
-const sql = require('./tedious')
-
-const exit = process.exit
-const write = text => process.stdout.write(text)
-Buffer.prototype.toJSON = () => {
-  return `0x${this.toString('hex')}`
-}
-
-// Resolve config path
-
-let cfgPath = path.resolve(process.argv[2] || process.cwd())
-if (fs.lstatSync(cfgPath).isDirectory()) {
-  cfgPath = path.resolve(cfgPath, './.mssql.json')
-}
-if (!fs.existsSync(cfgPath)) {
-  console.error('Config file not found.')
-  exit(1)
-}
-
-// Config checks & parse
-
-let config
-try {
-  config = fs.readFileSync(cfgPath)
-} catch (err) {
-  console.error(`Failed to load config file. ${err.message}`)
-  exit(1)
-}
-
-try {
-  config = JSON.parse(config)
-} catch (err) {
-  console.error(`Failed to parse config file. ${err.message}`)
-  exit(1)
-}
-
-// Read stdin
-
-const buffer = []
-
-process.stdin.setEncoding('utf8')
-process.stdin.on('readable', () => buffer.push(process.stdin.read()))
-
-process.stdin.on('end', () => {
-  const statement = buffer.join('')
-  let rst = 0
-  let index = 0
-
-  if (!statement.length) {
-    console.error('Statement is empty.')
-    exit(1)
-  }
-
-  sql.connect(config, err => {
-    if (err) {
-      console.error(err.message)
-      exit(1)
-    }
-
-    write('[')
-
-    const request = new sql.Request()
-    request.stream = true
-    request.on('recordset', () => {
-      index = 0
-      if (rst++ > 0) {
-        write('],')
-      }
-
-      return write('[')
-    })
-
-    request.on('error', err => {
-      console.error(err.message)
-      sql.close()
-      return exit(1)
-    })
-
-    request.on('row', row => {
-      if (index++ > 0) {
-        write(',')
-      }
-
-      return write(JSON.stringify(row))
-    })
-
-    request.on('done', () => {
-      if (rst > 0) {
-        write(']')
-      }
-
-      write(']\n')
-      sql.close()
-      return exit(0)
-    })
-
-    request.query(statement)
-  })
-})
-
-process.on('uncaughtException', err => {
-  if (err.code === 'EPIPE') {
-    console.error('Failed to pipe output stream.')
-  } else {
-    console.error(err.message)
-  }
-
-  exit(1)
-})

package/test.js

@@ -1,40 +0,0 @@
-'use strict'
-const mssql = require('./')
-
-const [, , max] = process.argv
-
-const sqlConfig = {
-  password: 'P@ssw0rd',
-  database: 'test',
-  stream: false,
-  // driver: 'msnodesqlv8',
-  options: {
-    trustServerCertificate: true,
-    enableArithAbort: true,
-    encrypt: true,
-    abortTransactionOnError: false
-  },
-  pool: {
-    max: max ? parseInt(max) : 10,
-    min: 0
-  },
-  port: 1433,
-  user: 'sa',
-  server: 'localhost',
-  arrayRowMode: true
-}
-
-mssql.connect(sqlConfig).then((pool) => {
-  console.log('Connected to SQL server')
-  const request = pool.request()
-  request.stream = true
-  request.on('error', (err) => {
-    console.error('good', err)
-  })
-  return request.query('SELECT * FROM nontable')
-}).catch((err) => {
-  console.error('bad', err)
-}).then(() => {
-  console.log('Disconnecting from SQL server')
-  return mssql.close()
-}).then(() => console.log('Disconnected'))