knex 1.0.1 → 1.0.4

package/CHANGELOG.md

@@ -1,5 +1,75 @@
 # Master (Unreleased)
 
+# 1.0.4 - 13 March, 2022
+
+### New features:
+
+- Add whereLike functions #5044
+
+### Bug fixes:
+
+- Fix orWhereJsonPath clause #5022
+- Subquery in on clause missing parenthesis #5049
+- Rework Union Wrapping #5030
+- Oracle: Fix batch inserts with DEFAULT values with OracleDB #2592 #5037
+
+### Typings:
+
+- Fix types for "returning" methods #5031
+- createTableLike callback should be optional #5055
+
+### Documentation:
+
+- Website URL changed to https://knex.github.io/documentation/
+
+# 1.0.3 - 11 February, 2022
+
+### Bug fixes:
+
+- Fix error message for missing migration files #4937
+- Add withMaterialized and withNotMaterialized to method-constants #5009
+- PostgreSQL: Fix whereJsonPath queries #5011
+- PostgreSQL: Fix delete joins #5016
+- CockroachDB: Fix whereJsonPath queries #5011
+- MySQL: Create primary keys in same statement #5017
+
+### Typings:
+
+- Fix type definition for getMigration in MigrationSource #4998
+- Fix argument type of alter method #4996
+
+### Improvements:
+
+- Use async / await syntax in seeds as default #5005
+
+### Documentation:
+
+- Add Firebird dialect to ECOSYSTEM.md #5003
+
+# 1.0.2 - 02 February, 2022
+
+### New features:
+
+- Support of MATERIALIZED and NOT MATERIALIZED with WITH/CTE #4940
+- Add raw support in onConflict clause #4960
+- Alter nullable constraint when alterNullable is set to true #4730
+- Add alterType parameter for alter function #4967
+- Support string json in json values #4988
+- MySQL: add with clause #4508
+
+### Bug fixes:
+
+- Fix error message for missing migration files #4937
+- Move deferrable to after on update/on delete #4976
+- Do not use sys.tables to find if a table exists #2328
+- PostgreSQL: Fix Order nulls #4989
+- MySQL: Fix collation when renaming column #2666
+- SQLite: Same boolean handling in better-sqlite3 as in sqlite3 #4982
+
+### Typings:
+
+- WhereILike - fix typo #4941
+
 # 1.0.1 - 16 January, 2022
 
 ### Bug fixes:

package/README.md

@@ -1,4 +1,4 @@
-# [knex.js](http://knexjs.org)
+# [knex.js](https://knex.github.io/documentation/)
 
 [![npm version](http://img.shields.io/npm/v/knex.svg)](https://npmjs.org/package/knex)
 [![npm downloads](https://img.shields.io/npm/dm/knex.svg)](https://npmjs.org/package/knex)
@@ -13,15 +13,15 @@
 A batteries-included, multi-dialect (PostgreSQL, MySQL, CockroachDB, MSSQL, SQLite3, Oracle (including Oracle Wallet Authentication)) query builder for
 Node.js, featuring:
 
-- [transactions](https://knexjs.org/#Transactions)
-- [connection pooling](https://knexjs.org/#Installation-pooling)
-- [streaming queries](https://knexjs.org/#Interfaces-Streams)
-- both a [promise](https://knexjs.org/#Interfaces-Promises) and [callback](https://knexjs.org/#Interfaces-Callbacks) API
+- [transactions](https://knex.github.io/documentation/#Transactions)
+- [connection pooling](https://knex.github.io/documentation/#Installation-pooling)
+- [streaming queries](https://knex.github.io/documentation/#Interfaces-Streams)
+- both a [promise](https://knex.github.io/documentation/#Interfaces-Promises) and [callback](https://knex.github.io/documentation/#Interfaces-Callbacks) API
 - a [thorough test suite](https://github.com/knex/knex/actions)
 
 Node.js versions 12+ are supported.
 
-* Take a look at the [full documentation](https://knexjs.org) to get started!
+* Take a look at the [full documentation](https://knex.github.io/documentation) to get started!
 * Browse the [list of plugins and tools](https://github.com/knex/knex/blob/master/ECOSYSTEM.md) built for knex
 * Check out our [recipes wiki](https://github.com/knex/knex/wiki/Recipes) to search for solutions to some specific problems  
 * In case of upgrading from an older version, see [migration guide](https://github.com/knex/knex/blob/master/UPGRADING.md)

package/UPGRADING.md

@@ -3,7 +3,7 @@
 ### Upgrading to version 1.0.0+
 
 * Node.js older than 12 is no longer supported, make sure to update your environment;
-* If you are using `sqlite3` driver, please replace it with `@vscode/sqlite3`;
+* If you are using `sqlite3` driver dependency, please replace it with `@vscode/sqlite3` in your `package.json`;
 * `RETURNING` operations now always return an object with column names;
 * Migrator now returns list of migrations as objects.
 

package/lib/dialects/better-sqlite3/index.js

@@ -56,7 +56,7 @@ class Client_BetterSQLite3 extends Client_SQLite3 {
       }
 
       if (typeof binding === 'boolean') {
-        return String(binding);
+        return Number(binding);
       }
 
       return binding;

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

@@ -28,11 +28,16 @@ class QueryCompiler_CRDB extends QueryCompiler_PG {
     return body === '' ? '' : sql + body;
   }
 
+  _groupOrder(item, type) {
+    // CockroachDB don't support PostgreSQL order nulls first/last syntax, we take the generic one.
+    return this._basicGroupOrder(item, type);
+  }
+
   whereJsonPath(statement) {
     let castValue = '';
-    if (parseInt(statement.value)) {
+    if (!isNaN(statement.value) && parseInt(statement.value)) {
       castValue = '::int';
-    } else if (parseFloat(statement.value)) {
+    } else if (!isNaN(statement.value) && parseFloat(statement.value)) {
       castValue = '::float';
     } else {
       castValue = " #>> '{}'";

package/lib/dialects/mssql/schema/mssql-compiler.js

@@ -45,14 +45,13 @@ class SchemaCompiler_MSSQL extends SchemaCompiler {
   // Check whether a table exists on the query.
   hasTable(tableName) {
     const formattedTable = this.client.parameter(
-      this.formatter.wrap(prefixedTableName(this.schema, tableName)),
+      prefixedTableName(this.schema, tableName),
       this.builder,
       this.bindingsHolder
     );
-
     const sql =
-      `select object_id from sys.tables ` +
-      `where object_id = object_id(${formattedTable})`;
+      `SELECT TABLE_NAME FROM INFORMATION_SCHEMA.TABLES ` +
+      `WHERE TABLE_NAME = ${formattedTable}`;
     this.pushQuery({ sql, output: (resp) => resp.length > 0 });
   }
 

package/lib/dialects/mysql/query/mysql-querycompiler.js

@@ -80,12 +80,14 @@ class QueryCompiler_MySQL extends QueryCompiler {
 
   // Update method, including joins, wheres, order & limits.
   update() {
+    const withSQL = this.with();
     const join = this.join();
     const updates = this._prepUpdate(this.single.update);
     const where = this.where();
     const order = this.order();
     const limit = this.limit();
     return (
+      withSQL +
       `update ${this.tableName}` +
       (join ? ` ${join}` : '') +
       ' set ' +

package/lib/dialects/mysql/schema/mysql-tablecompiler.js

@@ -19,7 +19,12 @@ class TableCompiler_MySQL extends TableCompiler {
       : 'create table ';
     const { client } = this;
     let conn = {};
-    const columnsSql = ' (' + columns.sql.join(', ') + this._addChecks() + ')';
+    let columnsSql = ' (' + columns.sql.join(', ');
+
+    columnsSql += this.primaryKeys() || '';
+    columnsSql += this._addChecks();
+    columnsSql += ')';
+
     let sql =
       createStatement +
       this.tableName() +
@@ -73,7 +78,7 @@ class TableCompiler_MySQL extends TableCompiler {
 
     this.pushQuery({
       sql:
-        `show fields from ${table} where field = ` +
+        `show full fields from ${table} where field = ` +
         this.client.parameter(from, this.tableBuilder, this.bindingsHolder),
       output(resp) {
         const column = resp[0];
@@ -101,7 +106,10 @@ class TableCompiler_MySQL extends TableCompiler {
               if (column.Default !== void 0 && column.Default !== null) {
                 sql += ` DEFAULT '${column.Default}'`;
               }
-              // Add back the auto increment if the column had it, fix issue #2767
+              if (column.Collation !== void 0 && column.Collation !== null) {
+                sql += ` COLLATE '${column.Collation}'`;
+              }
+              // Add back the auto increment if the column  it, fix issue #2767
               if (column.Extra == 'auto_increment') {
                 sql += ` AUTO_INCREMENT`;
               }
@@ -132,6 +140,34 @@ class TableCompiler_MySQL extends TableCompiler {
     });
   }
 
+  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] || '';
+      if (constraintName) {
+        constraintName = ' constraint ' + this.formatter.wrap(constraintName);
+      }
+
+      if (this.grouped.columns) {
+        const incrementsCols = this._getIncrementsColumnNames();
+        if (incrementsCols.length) {
+          incrementsCols.forEach((c) => {
+            if (!columns.includes(c)) {
+              columns.unshift(c);
+            }
+          });
+        }
+      }
+
+      return `,${constraintName} primary key (${this.formatter.columnize(
+        columns
+      )})`;
+    }
+  }
+
   getFKRefs(runner) {
     const bindingsHolder = {
       bindings: [],
@@ -266,11 +302,13 @@ class TableCompiler_MySQL extends TableCompiler {
         });
       }
     }
-    this.pushQuery(
-      `alter table ${this.tableName()} add primary key ${constraintName}(${this.formatter.columnize(
-        primaryCols
-      )})`
-    );
+    if (this.method !== 'create' && this.method !== 'createIfNot') {
+      this.pushQuery(
+        `alter table ${this.tableName()} add primary key ${constraintName}(${this.formatter.columnize(
+          primaryCols
+        )})`
+      );
+    }
     if (incrementsCols.length) {
       this.pushQuery(
         `alter table ${this.tableName()} modify column ${this.formatter.columnize(

package/lib/dialects/oracledb/query/oracledb-querycompiler.js

@@ -8,9 +8,7 @@ const BlobHelper = require('../utils').BlobHelper;
 const { isString } = require('../../../util/is');
 const {
   columnize: columnize_,
-  direction: direction_,
 } = require('../../../formatter/wrappingFormatter');
-const Raw = require('../../../raw');
 
 class Oracledb_Compiler extends Oracle_Compiler {
   // Compiles an "insert" query, allowing for multiple
@@ -158,8 +156,8 @@ class Oracledb_Compiler extends Oracle_Compiler {
           // later position binding will only convert the ? params
           subSql = self.formatter.client.positionBindings(subSql);
           const parameterizedValuesWithoutDefaultAndBlob = parameterizedValues
-            .replace('DEFAULT, ', '')
-            .replace(', DEFAULT', '')
+            .replace(/DEFAULT, /g, '')
+            .replace(/, DEFAULT/g, '')
             .replace('EMPTY_BLOB(), ', '')
             .replace(', EMPTY_BLOB()', '');
           return (
@@ -318,20 +316,7 @@ class Oracledb_Compiler extends Oracle_Compiler {
   }
 
   _groupOrder(item, type) {
-    const column = super._formatGroupsItemValue(item.value);
-    const direction =
-      type === 'order' && item.type !== 'orderByRaw'
-        ? ` ${direction_(
-            item.direction,
-            this.builder,
-            this.client,
-            this.bindingsHolder
-          )}`
-        : '';
-    if (item.nulls && !(item.value instanceof Raw)) {
-      return `${column}${direction ? direction : ''} nulls ${item.nulls}`;
-    }
-    return column + direction;
+    return super._groupOrderNulls(item, type);
   }
 
   update() {

package/lib/dialects/postgres/query/pg-querybuilder.js

@@ -5,4 +5,34 @@ module.exports = class QueryBuilder_PostgreSQL extends QueryBuilder {
     this._single.using = tables;
     return this;
   }
+
+  withMaterialized(alias, statementOrColumnList, nothingOrStatement) {
+    this._validateWithArgs(
+      alias,
+      statementOrColumnList,
+      nothingOrStatement,
+      'with'
+    );
+    return this.withWrapped(
+      alias,
+      statementOrColumnList,
+      nothingOrStatement,
+      true
+    );
+  }
+
+  withNotMaterialized(alias, statementOrColumnList, nothingOrStatement) {
+    this._validateWithArgs(
+      alias,
+      statementOrColumnList,
+      nothingOrStatement,
+      'with'
+    );
+    return this.withWrapped(
+      alias,
+      statementOrColumnList,
+      nothingOrStatement,
+      false
+    );
+  }
 };

package/lib/dialects/postgres/query/pg-querycompiler.js

@@ -112,7 +112,7 @@ class QueryCompiler_PG extends QueryCompiler {
           );
         }
         if (joinWheres.length > 0) {
-          wheres += (wheres ? ' and ' : '') + joinWheres.join(' ');
+          wheres += (wheres ? ' and ' : 'where ') + joinWheres.join(' and ');
         }
       }
       if (tableJoins.length > 0) {
@@ -145,13 +145,11 @@ class QueryCompiler_PG extends QueryCompiler {
     if (columns === true) {
       return ' on conflict do nothing';
     }
-    return ` on conflict (${this.formatter.columnize(columns)}) do nothing`;
+    return ` on conflict ${this._onConflictClause(columns)} do nothing`;
   }
 
   _merge(updates, columns, insert) {
-    let sql = ` on conflict (${this.formatter.columnize(
-      columns
-    )}) do update set `;
+    let sql = ` on conflict ${this._onConflictClause(columns)} do update set `;
     if (updates && Array.isArray(updates)) {
       sql += updates
         .map((column) =>
@@ -219,6 +217,10 @@ class QueryCompiler_PG extends QueryCompiler {
     return lockMode + (tables.length ? ' of ' + this._tableNames(tables) : '');
   }
 
+  _groupOrder(item, type) {
+    return super._groupOrderNulls(item, type);
+  }
+
   forUpdate() {
     return this._lockingClause('for update');
   }
@@ -339,9 +341,9 @@ class QueryCompiler_PG extends QueryCompiler {
 
   whereJsonPath(statement) {
     let castValue = '';
-    if (parseInt(statement.value)) {
+    if (!isNaN(statement.value) && parseInt(statement.value)) {
       castValue = '::int';
-    } else if (parseFloat(statement.value)) {
+    } else if (!isNaN(statement.value) && parseFloat(statement.value)) {
       castValue = '::float';
     } else {
       castValue = " #>> '{}'";

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

@@ -91,21 +91,28 @@ class TableCompiler_PG extends TableCompiler {
 
     // To alter enum columns they must be cast to text first
     const isEnum = col.type === 'enu';
-
     this.pushQuery({
       sql: `alter table ${quotedTableName} alter column ${colName} drop default`,
       bindings: [],
     });
-    this.pushQuery({
-      sql: `alter table ${quotedTableName} alter column ${colName} drop not null`,
-      bindings: [],
-    });
-    this.pushQuery({
-      sql: `alter table ${quotedTableName} alter column ${colName} type ${type} using (${colName}${
-        isEnum ? '::text::' : '::'
-      }${type})`,
-      bindings: [],
-    });
+
+    const alterNullable = col.columnBuilder.alterNullable;
+    if (alterNullable) {
+      this.pushQuery({
+        sql: `alter table ${quotedTableName} alter column ${colName} drop not null`,
+        bindings: [],
+      });
+    }
+
+    const alterType = col.columnBuilder.alterType;
+    if (alterType) {
+      this.pushQuery({
+        sql: `alter table ${quotedTableName} alter column ${colName} type ${type} using (${colName}${
+          isEnum ? '::text::' : '::'
+        }${type})`,
+        bindings: [],
+      });
+    }
 
     const defaultTo = col.modified['defaultTo'];
     if (defaultTo) {
@@ -116,12 +123,14 @@ class TableCompiler_PG extends TableCompiler {
       });
     }
 
-    const nullable = col.modified['nullable'];
-    if (nullable && nullable[0] === false) {
-      this.pushQuery({
-        sql: `alter table ${quotedTableName} alter column ${colName} set not null`,
-        bindings: [],
-      });
+    if (alterNullable) {
+      const nullable = col.modified['nullable'];
+      if (nullable && nullable[0] === false) {
+        this.pushQuery({
+          sql: `alter table ${quotedTableName} alter column ${colName} set not null`,
+          bindings: [],
+        });
+      }
     }
   }
 

package/lib/dialects/sqlite3/index.js

@@ -15,6 +15,7 @@ const TableCompiler = require('./schema/sqlite-tablecompiler');
 const ViewCompiler = require('./schema/sqlite-viewcompiler');
 const SQLite3_DDL = require('./schema/ddl');
 const Formatter = require('../../formatter');
+const QueryBuilder = require('./query/sqlite-querybuilder');
 
 class Client_SQLite3 extends Client {
   constructor(config) {
@@ -44,6 +45,10 @@ class Client_SQLite3 extends Client {
     return new SqliteQueryCompiler(this, builder, formatter);
   }
 
+  queryBuilder() {
+    return new QueryBuilder(this);
+  }
+
   viewCompiler(builder, formatter) {
     return new ViewCompiler(this, builder, formatter);
   }

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

@@ -0,0 +1,33 @@
+const QueryBuilder = require('../../../query/querybuilder.js');
+
+module.exports = class QueryBuilder_SQLite3 extends QueryBuilder {
+  withMaterialized(alias, statementOrColumnList, nothingOrStatement) {
+    this._validateWithArgs(
+      alias,
+      statementOrColumnList,
+      nothingOrStatement,
+      'with'
+    );
+    return this.withWrapped(
+      alias,
+      statementOrColumnList,
+      nothingOrStatement,
+      true
+    );
+  }
+
+  withNotMaterialized(alias, statementOrColumnList, nothingOrStatement) {
+    this._validateWithArgs(
+      alias,
+      statementOrColumnList,
+      nothingOrStatement,
+      'with'
+    );
+    return this.withWrapped(
+      alias,
+      statementOrColumnList,
+      nothingOrStatement,
+      false
+    );
+  }
+};

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

@@ -153,13 +153,11 @@ class QueryCompiler_SQLite3 extends QueryCompiler {
     if (columns === true) {
       return ' on conflict do nothing';
     }
-    return ` on conflict (${this.formatter.columnize(columns)}) do nothing`;
+    return ` on conflict ${this._onConflictClause(columns)} do nothing`;
   }
 
   _merge(updates, columns, insert) {
-    let sql = ` on conflict (${this.formatter.columnize(
-      columns
-    )}) do update set `;
+    let sql = ` on conflict ${this._onConflictClause(columns)} do update set `;
     if (updates && Array.isArray(updates)) {
       sql += updates
         .map((column) =>

package/lib/knex-builder/FunctionHelper.js

@@ -14,25 +14,40 @@ class FunctionHelper {
     return this.client.raw('CURRENT_TIMESTAMP');
   }
 
-  uuidToBin(uuid) {
+  uuidToBin(uuid, ordered = true) {
     const buf = Buffer.from(uuid.replace(/-/g, ''), 'hex');
-    return Buffer.concat([
-      buf.slice(6, 8),
-      buf.slice(4, 6),
-      buf.slice(0, 4),
-      buf.slice(8, 16),
-    ]);
+    return ordered
+      ? Buffer.concat([
+          buf.slice(6, 8),
+          buf.slice(4, 6),
+          buf.slice(0, 4),
+          buf.slice(8, 16),
+        ])
+      : Buffer.concat([
+          buf.slice(0, 4),
+          buf.slice(4, 6),
+          buf.slice(6, 8),
+          buf.slice(8, 16),
+        ]);
   }
 
-  binToUuid(bin) {
-    const buf = new Buffer(bin, 'hex');
-    return [
-      buf.toString('hex', 4, 8),
-      buf.toString('hex', 2, 4),
-      buf.toString('hex', 0, 2),
-      buf.toString('hex', 8, 10),
-      buf.toString('hex', 10, 16),
-    ].join('-');
+  binToUuid(bin, ordered = true) {
+    const buf = Buffer.from(bin, 'hex');
+    return ordered
+      ? [
+          buf.toString('hex', 4, 8),
+          buf.toString('hex', 2, 4),
+          buf.toString('hex', 0, 2),
+          buf.toString('hex', 8, 10),
+          buf.toString('hex', 10, 16),
+        ].join('-')
+      : [
+          buf.toString('hex', 0, 4),
+          buf.toString('hex', 4, 6),
+          buf.toString('hex', 6, 8),
+          buf.toString('hex', 8, 10),
+          buf.toString('hex', 10, 16),
+        ].join('-');
   }
 }
 

package/lib/migrations/migrate/Migrator.js

@@ -562,8 +562,9 @@ function validateMigrationList(migrationSource, migrations) {
   const [all, completed] = migrations;
   const diff = getMissingMigrations(migrationSource, completed, all);
   if (!isEmpty(diff)) {
+    const names = diff.map((d) => d.name);
     throw new Error(
-      `The migration directory is corrupt, the following files are missing: ${diff.join(
+      `The migration directory is corrupt, the following files are missing: ${names.join(
         ', '
       )}`
     );

package/lib/migrations/seed/stub/js.stub

@@ -2,15 +2,12 @@
  * @param { import("knex").Knex } knex
  * @returns { Promise<void> } 
  */
-exports.seed = function(knex) {
+exports.seed = async function(knex) {
   // Deletes ALL existing entries
-  return knex('table_name').del()
-    .then(function () {
-      // Inserts seed entries
-      return knex('table_name').insert([
-        {id: 1, colName: 'rowValue1'},
-        {id: 2, colName: 'rowValue2'},
-        {id: 3, colName: 'rowValue3'}
-      ]);
-    });
+  await knex('table_name').del()
+  await knex('table_name').insert([
+    {id: 1, colName: 'rowValue1'},
+    {id: 2, colName: 'rowValue2'},
+    {id: 3, colName: 'rowValue3'}
+  ]);
 };

package/lib/query/method-constants.js

@@ -3,6 +3,8 @@
 module.exports = [
   'with',
   'withRecursive',
+  'withMaterialized',
+  'withNotMaterialized',
   'select',
   'as',
   'columns',
@@ -25,12 +27,16 @@ module.exports = [
   'fullOuterJoin',
   'crossJoin',
   'where',
-  'whereLike',
-  'whereILike',
   'andWhere',
   'orWhere',
   'whereNot',
   'orWhereNot',
+  'whereLike',
+  'andWhereLike',
+  'orWhereLike',
+  'whereILike',
+  'andWhereILike',
+  'orWhereILike',
   'whereRaw',
   'whereWrapped',
   'havingWrapped',