knex 0.21.16 → 0.21.17

package/CHANGELOG.md

@@ -1,5 +1,15 @@
 # Master (Unreleased)
 
+# 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:

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

@@ -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/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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "knex",
-  "version": "0.21.16",
+  "version": "0.21.17",
   "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,

package/scripts/measure.bat

@@ -1,5 +0,0 @@
-set startTime=%time%
-call cd .. 
-call npm run test:sqlite
-echo Start Time: %startTime%
-echo Finish Time: %time%