knex 0.21.15 → 0.21.19

package/CHANGELOG.md

@@ -1,5 +1,29 @@
 # Master (Unreleased)
 
+# 0.21.19 - 02 March, 2021
+
+- SQLite: Made the constraint detection case-insensitive #4332
+
+# 0.21.18 - 22 February, 2021
+
+- CLI: Fix an issue with npm@7 and ESM when type was set to 'module' in package.json #4295
+
+# 0.21.17 - 30 January, 2021
+
+### Bug fixes:
+
+- SQLite: Fix SQLite foreign on delete when altering a table #4261
+
+### New features:
+
+- Add support for optimizer hints (see https://github.com/knex/documentation/pull/306 for documentation) #4243
+
+# 0.21.16 - 17 January, 2021
+
+### Bug fixes:
+
+- MSSQL: Avoid passing unsupported pool param. Fixes node-mssql 7+ support #4236
+
 # 0.21.15 - 26 December, 2020
 
 ### New features:

package/lib/dialects/mssql/index.js

@@ -31,7 +31,6 @@ function Client_MSSQL(config = {}) {
     min: 1,
     max: 1,
     idleTimeoutMillis: Number.MAX_SAFE_INTEGER,
-    evictionRunIntervalMillis: 0,
   };
 
   Client.call(this, config);

package/lib/dialects/mssql/query/compiler.js

@@ -262,6 +262,7 @@ class QueryCompiler_MSSQL extends QueryCompiler {
     let distinctClause = '';
     if (this.onlyUnions()) return '';
     const top = this.top();
+    const hints = this._hintComments()
     const columns = this.grouped.columns || [];
     let i = -1,
       sql = [];
@@ -285,7 +286,7 @@ class QueryCompiler_MSSQL extends QueryCompiler {
     if (sql.length === 0) sql = ['*'];
 
     return (
-      `select ${distinctClause}` +
+      `select ${hints}${distinctClause}` +
       (top ? top + ' ' : '') +
       sql.join(', ') +
       (this.tableName ? ` from ${this.tableName}` : '')

package/lib/dialects/sqlite3/schema/ddl.js

@@ -333,8 +333,8 @@ assign(SQLite3_DDL.prototype, {
           .map((line) => line.trim())
           .filter((defLine) => {
             if (
-              defLine.startsWith('constraint') === false &&
-              defLine.includes('foreign key') === false
+              defLine.toLowerCase().startsWith('constraint') === false &&
+              defLine.toLowerCase().includes('foreign key') === false
             )
               return true;
 
@@ -486,7 +486,7 @@ assign(SQLite3_DDL.prototype, {
         }
 
         if (foreignInfo.onDelete) {
-          newForeignSQL += ` ON DELETE ${foreignInfo.onUpdate}`;
+          newForeignSQL += ` ON DELETE ${foreignInfo.onDelete}`;
         }
 
         newColumnDefinitions.push(newForeignSQL);

package/lib/migrate/Migrator.js

@@ -80,12 +80,16 @@ class Migrator {
 
     const transactionForAll =
       !this.config.disableTransactions &&
-      !migrations.some((migration) => {
-        const migrationContents = this.config.migrationSource.getMigration(
-          migration
-        );
-        return !this._useTransaction(migrationContents);
-      });
+      !(
+        await Promise.all(
+          migrations.map(async (migration) => {
+            const migrationContents = await this.config.migrationSource.getMigration(
+              migration
+            );
+            return !this._useTransaction(migrationContents);
+          })
+        )
+      ).some((isTransactionUsed) => isTransactionUsed);
 
     if (transactionForAll) {
       return this.knex.transaction((trx) => {
@@ -133,6 +137,16 @@ class Migrator {
           migrationToRun = newMigrations[0];
         }
 
+        return {
+          migrationToRun,
+          useTransaction:
+            !migrationToRun ||
+            this._useTransaction(
+              this.config.migrationSource.getMigration(migrationToRun)
+            ),
+        };
+      })
+      .then(({ migrationToRun, useTransaction }) => {
         const migrationsToRun = [];
         if (migrationToRun) {
           migrationsToRun.push(migrationToRun);
@@ -140,10 +154,7 @@ class Migrator {
 
         const transactionForAll =
           !this.config.disableTransactions &&
-          (!migrationToRun ||
-            this._useTransaction(
-              this.config.migrationSource.getMigration(migrationToRun)
-            ));
+          (!migrationToRun || useTransaction);
 
         if (transactionForAll) {
           return this.knex.transaction((trx) => {

package/lib/query/builder.js

@@ -185,6 +185,25 @@ assign(Builder.prototype, {
     return this;
   },
 
+  // Adds a single hint or an array of hits to the list of "hintComments" on the query.
+  hintComment(hints) {
+    hints = Array.isArray(hints) ? hints : [hints]
+    if (hints.some((hint) => !isString(hint))) {
+      throw new Error('Hint comment must be a string');
+    }
+    if (hints.some((hint) => hint.includes('/*') || hint.includes('*/'))) {
+      throw new Error('Hint comment cannot include "/*" or "*/"');
+    }
+    if (hints.some((hint) => hint.includes('?'))) {
+      throw new Error('Hint comment cannot include "?"');
+    }
+    this._statements.push({
+      grouping: 'hintComments',
+      value: hints,
+    })
+    return this;
+  },
+
   // Prepends the `schemaName` on `tableName` defined by `.table` and `.join`.
   withSchema(schemaName) {
     this._single.schema = schemaName;
@@ -1064,7 +1083,7 @@ assign(Builder.prototype, {
 
   // Remove everything from statement clause
   clear(statement) {
-    if (!['with', 'select', 'columns', 'where', 'union', 'join', 'group', 'order', 'having', 'limit', 'offset', 'counter', 'counters'].includes(statement))
+    if (!['with', 'select', 'columns', 'hintComments', 'where', 'union', 'join', 'group', 'order', 'having', 'limit', 'offset', 'counter', 'counters'].includes(statement))
       throw new Error(`Knex Error: unknown statement '${statement}'`);
     if (statement.startsWith('counter')) return this.clearCounters();
     if (statement === 'select') { statement = 'columns'; }

package/lib/query/compiler.js

@@ -182,10 +182,18 @@ class QueryCompiler {
     );
   }
 
+  _hintComments() {
+    let hints = this.grouped.hintComments || [];
+    hints = hints.map((hint) => compact(hint.value).join(' '));
+    hints = compact(hints).join(' ');
+    return hints ? `/*+ ${hints} */ ` : ''
+  }
+
   // Compiles the columns in the query, specifying if an item was distinct.
   columns() {
     let distinctClause = '';
     if (this.onlyUnions()) return '';
+    const hints = this._hintComments()
     const columns = this.grouped.columns || [];
     let i = -1,
       sql = [];
@@ -208,7 +216,7 @@ class QueryCompiler {
     }
     if (sql.length === 0) sql = ['*'];
     return (
-      `select ${distinctClause}` +
+      `select ${hints}${distinctClause}` +
       sql.join(', ') +
       (this.tableName
         ? ` from ${this.single.only ? 'only ' : ''}${this.tableName}`

package/lib/util/import-file.js

@@ -1,5 +1,4 @@
-// When run via npm, we can leverage the injected environment variables to infer the import type
-const isTypeModule = process.env.npm_package_type === 'module'
+const isModuleType = require('./is-module-type');
 
 /**
  * imports 'mjs', else requires.
@@ -7,8 +6,8 @@ const isTypeModule = process.env.npm_package_type === 'module'
  * @param {string} filepath
  * @todo WARN on version 10 and '--experimental-modules' and '--esm'
  */
-module.exports = function importFile(filepath) {
-  return isTypeModule || filepath.endsWith('.mjs')
+module.exports = async function importFile(filepath) {
+  return (await isModuleType(filepath))
     ? import(require('url').pathToFileURL(filepath))
     : require(filepath);
 };

package/lib/util/is-module-type.js

@@ -0,0 +1,14 @@
+const { readFile } = require('./fs');
+
+module.exports = async function isModuleType(filepath) {
+  if (process.env.npm_package_json) {
+    // npm >= 7.0.0
+    const packageJson = JSON.parse(
+      await readFile(process.env.npm_package_json, 'utf-8')
+    );
+    if (packageJson.type === 'module') {
+      return true;
+    }
+  }
+  return process.env.npm_package_type === 'module' || filepath.endsWith('.mjs');
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "knex",
-  "version": "0.21.15",
+  "version": "0.21.19",
   "description": "A batteries-included SQL query & schema builder for Postgres, MySQL and SQLite3 and the Browser",
   "main": "knex.js",
   "types": "types/index.d.ts",

package/types/index.d.ts

@@ -460,13 +460,14 @@ declare namespace Knex {
   //
   // QueryInterface
   //
-  type ClearStatements = "with" | "select" | "columns" | "where" | "union" | "join" | "group" | "order" | "having" | "limit" | "offset" | "counter" | "counters";
+  type ClearStatements = "with" | "select" | "columns" | "hintComments" | "where" | "union" | "join" | "group" | "order" | "having" | "limit" | "offset" | "counter" | "counters";
 
   interface QueryInterface<TRecord extends {} = any, TResult = any> {
     select: Select<TRecord, TResult>;
     as: As<TRecord, TResult>;
     columns: Select<TRecord, TResult>;
     column: Select<TRecord, TResult>;
+    hintComment: HintComment<TRecord, TResult>;
     from: Table<TRecord, TResult>;
     into: Table<TRecord, TResult>;
     table: Table<TRecord, TResult>;
@@ -978,6 +979,11 @@ declare namespace Knex {
     ): QueryBuilder<TRecord, TResult2>;
   }
 
+  interface HintComment<TRecord extends {} = any, TResult extends {} = any> {
+    (hint: string): QueryBuilder<TRecord, TResult>;
+    (hints: readonly string[]): QueryBuilder<TRecord, TResult>;
+  }
+
   interface Table<TRecord extends {} = any, TResult extends {} = any> {
     <
       TTable extends TableNames,