knex 2.1.0 → 2.2.0

package/CHANGELOG.md

@@ -1,5 +1,22 @@
 # Master (Unreleased)
 
+# 2.2.0 - 19 July, 2022
+
+### New features:
+
+- Inline primary key creation for postgres flavours #5233
+- SQLite: Add warning for undefined connection file #5223
+- MSSQL: Add JSON parameter support for connection #5200
+
+### Bug fixes:
+
+- PostgreSQL: add primaryKey option for uuid #5212
+
+### Typings:
+
+- Add promisable and better types #5222
+- Update raw query bind parameter type #5208
+
 # 2.1.0 - 26 May, 2022
 
 ### New features:

package/lib/dialects/cockroachdb/crdb-columncompiler.js

@@ -0,0 +1,14 @@
+const ColumnCompiler_PG = require('../postgres/schema/pg-columncompiler.js');
+
+class ColumnCompiler_CRDB extends ColumnCompiler_PG {
+  uuid(options = { primaryKey: false }) {
+    return (
+      'uuid' +
+      (this.tableCompiler._canBeAddPrimaryKey(options)
+        ? ' primary key default gen_random_uuid()'
+        : '')
+    );
+  }
+}
+
+module.exports = ColumnCompiler_CRDB;

package/lib/dialects/cockroachdb/index.js

@@ -3,6 +3,7 @@
 const Client_PostgreSQL = require('../postgres');
 const Transaction = require('../postgres/execution/pg-transaction');
 const QueryCompiler = require('./crdb-querycompiler');
+const ColumnCompiler = require('./crdb-columncompiler');
 const TableCompiler = require('./crdb-tablecompiler');
 const ViewCompiler = require('./crdb-viewcompiler');
 const QueryBuilder = require('./crdb-querybuilder');
@@ -19,6 +20,10 @@ class Client_CockroachDB extends Client_PostgreSQL {
     return new QueryCompiler(this, builder, formatter);
   }
 
+  columnCompiler() {
+    return new ColumnCompiler(this, ...arguments);
+  }
+
   tableCompiler() {
     return new TableCompiler(this, ...arguments);
   }

package/lib/dialects/postgres/schema/pg-columncompiler.js

@@ -124,6 +124,13 @@ class ColumnCompiler_PG extends ColumnCompiler {
       (this.tableCompiler._canBeAddPrimaryKey(options) ? ' primary key' : '')
     );
   }
+
+  uuid(options = { primaryKey: false }) {
+    return (
+      'uuid' +
+      (this.tableCompiler._canBeAddPrimaryKey(options) ? ' primary key' : '')
+    );
+  }
 }
 
 ColumnCompiler_PG.prototype.bigint = 'bigint';
@@ -133,7 +140,6 @@ ColumnCompiler_PG.prototype.double = 'double precision';
 ColumnCompiler_PG.prototype.floating = 'real';
 ColumnCompiler_PG.prototype.smallint = 'smallint';
 ColumnCompiler_PG.prototype.tinyint = 'smallint';
-ColumnCompiler_PG.prototype.uuid = 'uuid';
 
 function jsonColumn(client, jsonb) {
   if (

package/lib/dialects/postgres/schema/pg-tablecompiler.js

@@ -44,7 +44,10 @@ class TableCompiler_PG extends TableCompiler {
     const createStatement = ifNot
       ? 'create table if not exists '
       : 'create table ';
-    const columnsSql = ' (' + columns.sql.join(', ') + this._addChecks() + ')';
+    const columnsSql = ` (${columns.sql.join(', ')}${
+      this.primaryKeys() || ''
+    }${this._addChecks()})`;
+
     let sql =
       createStatement +
       this.tableName() +
@@ -65,6 +68,28 @@ class TableCompiler_PG extends TableCompiler {
     if (hasComment) this.comment(this.single.comment);
   }
 
+  primaryKeys() {
+    const pks = (this.grouped.alterTable || []).filter(
+      (k) => k.method === 'primary'
+    );
+    if (pks.length > 0 && pks[0].args.length > 0) {
+      const columns = pks[0].args[0];
+      let constraintName = pks[0].args[1] || '';
+      let deferrable;
+      if (isObject(constraintName)) {
+        ({ constraintName, deferrable } = constraintName);
+      }
+      deferrable = deferrable ? ` deferrable initially ${deferrable}` : '';
+      constraintName = constraintName
+        ? this.formatter.wrap(constraintName)
+        : this.formatter.wrap(`${this.tableNameRaw}_pkey`);
+
+      return `, constraint ${constraintName} primary key (${this.formatter.columnize(
+        columns
+      )})${deferrable}`;
+    }
+  }
+
   addColumns(columns, prefix, colCompilers) {
     if (prefix === this.alterColumnsPrefix) {
       // alter columns
@@ -153,11 +178,13 @@ class TableCompiler_PG extends TableCompiler {
     constraintName = constraintName
       ? this.formatter.wrap(constraintName)
       : this.formatter.wrap(`${this.tableNameRaw}_pkey`);
-    this.pushQuery(
-      `alter table ${this.tableName()} add constraint ${constraintName} primary key (${this.formatter.columnize(
-        columns
-      )})${deferrable}`
-    );
+    if (this.method !== 'create' && this.method !== 'createIfNot') {
+      this.pushQuery(
+        `alter table ${this.tableName()} add constraint ${constraintName} primary key (${this.formatter.columnize(
+          columns
+        )})${deferrable}`
+      );
+    }
   }
 
   unique(columns, indexName) {

package/lib/dialects/sqlite3/index.js

@@ -20,11 +20,20 @@ const QueryBuilder = require('./query/sqlite-querybuilder');
 class Client_SQLite3 extends Client {
   constructor(config) {
     super(config);
+
+    if (config.connection && config.connection.filename === undefined) {
+      this.logger.warn(
+        'Could not find `connection.filename` in config. Please specify ' +
+          'the database path and name to avoid errors. ' +
+          '(see docs https://knexjs.org/guide/#configuration-options)'
+      );
+    }
+
     if (config.useNullAsDefault === undefined) {
       this.logger.warn(
         'sqlite does not support inserting default values. Set the ' +
           '`useNullAsDefault` flag to hide this warning. ' +
-          '(see docs http://knexjs.org/#Builder-insert).'
+          '(see docs https://knexjs.org/guide/query-builder.html#insert).'
       );
     }
   }

package/lib/dialects/sqlite3/query/sqlite-querycompiler.js

@@ -76,7 +76,7 @@ class QueryCompiler_SQLite3 extends QueryCompiler {
             throw new TypeError(
               '`sqlite` does not support inserting default values. Specify ' +
                 'values explicitly or use the `useNullAsDefault` config flag. ' +
-                '(see docs http://knexjs.org/#Builder-insert).'
+                '(see docs https://knexjs.org/guide/query-builder.html#insert).'
             );
         });
       });

package/lib/execution/runner.js

@@ -61,22 +61,15 @@ class Runner {
     Transform = Transform || require('stream').Transform;
 
     const queryContext = this.builder.queryContext();
-    let queryStream;
 
     const stream = new Transform({
       objectMode: true,
       transform: (chunk, _, callback) => {
         callback(null, this.client.postProcessResponse(chunk, queryContext));
       },
-      destroy() {
-        // For some reason destroy is not available for mssql on Node 14. Might be a problem with tedious: https://github.com/tediousjs/tedious/issues/1139
-        if (queryStream && queryStream.destroy) {
-          queryStream.destroy(new Error('stream destroyed'));
-        }
-      },
     });
-    stream.on('pipe', (qs) => {
-      queryStream = qs;
+    stream.on('close', () => {
+      this.client.releaseConnection(this.connection);
     });
 
     const connectionAcquirePromise = this.ensureConnection(

package/lib/knex-builder/internal/parse-connection.js

@@ -69,8 +69,10 @@ function connectionObject(parsed) {
   }
   if (parsed.searchParams) {
     for (const [key, value] of parsed.searchParams.entries()) {
-      const isMySQLLike = ['mysql:', 'mariadb:'].includes(parsed.protocol);
-      if (isMySQLLike) {
+      const isNestedConfigSupported = ['mysql:', 'mariadb:', 'mssql:'].includes(
+        parsed.protocol
+      );
+      if (isNestedConfigSupported) {
         try {
           connection[key] = JSON.parse(value);
         } catch (err) {

package/lib/schema/columncompiler.js

@@ -277,8 +277,10 @@ ColumnCompiler.prototype.geography = 'geography';
 ColumnCompiler.prototype.point = 'point';
 ColumnCompiler.prototype.enu = 'varchar';
 ColumnCompiler.prototype.bit = ColumnCompiler.prototype.json = 'text';
-ColumnCompiler.prototype.uuid = ({ useBinaryUuid = false } = {}) =>
-  useBinaryUuid ? 'binary(16)' : 'char(36)';
+ColumnCompiler.prototype.uuid = ({
+  useBinaryUuid = false,
+  primaryKey = false,
+} = {}) => (useBinaryUuid ? 'binary(16)' : 'char(36)');
 ColumnCompiler.prototype.integer =
   ColumnCompiler.prototype.smallint =
   ColumnCompiler.prototype.mediumint =

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "knex",
-  "version": "2.1.0",
+  "version": "2.2.0",
   "description": "A batteries-included SQL query & schema builder for PostgresSQL, MySQL, CockroachDB, MSSQL and SQLite3",
   "main": "knex",
   "types": "types/index.d.ts",
@@ -60,7 +60,7 @@
     "prepublishOnly": "npm run clean && npm run build"
   },
   "dependencies": {
-    "colorette": "2.0.16",
+    "colorette": "2.0.19",
     "commander": "^9.1.0",
     "debug": "4.3.4",
     "escalade": "^3.1.1",
@@ -105,7 +105,7 @@
   },
   "devDependencies": {
     "@tsconfig/recommended": "^1.0.1",
-    "@types/node": "^17.0.25",
+    "@types/node": "^18.0.4",
     "better-sqlite3": "^7.5.1",
     "chai": "^4.3.6",
     "chai-as-promised": "^7.1.1",
@@ -121,7 +121,7 @@
     "husky": "^8.0.1",
     "jake": "^10.8.5",
     "JSONStream": "^1.3.5",
-    "lint-staged": "^12.3.7",
+    "lint-staged": "^13.0.0",
     "mocha": "^10.0.0",
     "mock-fs": "^5.1.2",
     "mysql": "^2.18.1",
@@ -141,8 +141,8 @@
     "tedious": "^14.4.0",
     "toxiproxy-node-client": "^2.0.6",
     "ts-node": "^10.7.0",
-    "tsd": "^0.20.0",
-    "typescript": "4.7.2"
+    "tsd": "^0.22.0",
+    "typescript": "4.7.4"
   },
   "buildDependencies": [
     "rimraf"