knex 1.0.2 → 1.0.5

package/CHANGELOG.md

@@ -1,5 +1,70 @@
 # Master (Unreleased)
 
+# 1.0.5 - 05 March, 2022
+
+### New features:
+
+- Override knexfile options with CLI options #4047
+
+### Bug fixes:
+
+- Stringify json value in update #5063
+- Fix isModuleType() for yarn #4447
+- Wrapped Unions Fixes #5072
+- SQLite: Fix @vscode-sqlite3 error message #5081
+- CLI: Fix completed migration listing #5060
+
+### Typings:
+
+- Make default generic parameters of `Knex` match the generic parameter types of `knex` #5021
+- Update knex types for TS 4.7 #5095
+
+# 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:

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/bin/cli.js

@@ -1,5 +1,6 @@
 #!/usr/bin/env node
 const rechoir = require('rechoir');
+const merge = require('lodash/merge');
 const interpret = require('interpret');
 const resolveFrom = require('resolve-from');
 const path = require('path');
@@ -9,6 +10,7 @@ const color = require('colorette');
 const argv = require('getopts')(process.argv.slice(2));
 const cliPkg = require('../package');
 const {
+  parseConfigObj,
   mkConfigObj,
   resolveEnvironmentConfig,
   exit,
@@ -59,8 +61,17 @@ async function initKnex(env, opts) {
     env.configuration,
     env.configPath
   );
+
+  const optionsConfig = parseConfigObj(opts);
+  const config = merge(resolvedConfig, optionsConfig);
+
+  // Migrations directory gets defaulted if it is undefined.
+  if (!env.configPath && !config.migrations.directory) {
+    config.migrations.directory = null;
+  }
+
   const knex = require(env.modulePath);
-  return knex(resolvedConfig);
+  return knex(config);
 }
 
 function invoke() {
@@ -138,16 +149,10 @@ function invoke() {
     .option('--knexfile [path]', 'Specify the knexfile path.')
     .option('--knexpath [path]', 'Specify the path to knex instance.')
     .option('--cwd [path]', 'Specify the working directory.')
-    .option('--client [name]', 'Set DB client without a knexfile.')
-    .option('--connection [address]', 'Set DB connection without a knexfile.')
-    .option(
-      '--migrations-directory [path]',
-      'Set migrations directory without a knexfile.'
-    )
-    .option(
-      '--migrations-table-name [path]',
-      'Set migrations table name without a knexfile.'
-    )
+    .option('--client [name]', 'Set DB client.')
+    .option('--connection [address]', 'Set DB connection.')
+    .option('--migrations-directory [path]', 'Set migrations directory.')
+    .option('--migrations-table-name [path]', 'Set migrations table name.')
     .option(
       '--env [name]',
       'environment, default: process.env.NODE_ENV || development'

package/bin/utils/cli-config-utils.js

@@ -1,12 +1,39 @@
 const { DEFAULT_EXT, DEFAULT_TABLE_NAME } = require('./constants');
 const { resolveClientNameWithAliases } = require('../../lib/util/helpers');
-const fs = require('fs');
 const path = require('path');
 const escalade = require('escalade/sync');
 const tildify = require('tildify');
 const color = require('colorette');
 const argv = require('getopts')(process.argv.slice(2));
 
+function findCaseInsensitiveProperty(propertyName, object) {
+  return Object.keys(object).find(
+    (key) => key.toLowerCase() === propertyName.toLowerCase()
+  );
+}
+
+function parseConfigObj(opts) {
+  const config = { migrations: {} };
+
+  if (opts.client) {
+    config.client = opts.client;
+  }
+
+  if (opts.connection) {
+    config.connection = opts.connection;
+  }
+
+  if (opts.migrationsDirectory) {
+    config.migrations.directory = opts.migrationsDirectory;
+  }
+
+  if (opts.migrationsTableName) {
+    config.migrations.tableName = opts.migrationsTableName;
+  }
+
+  return config;
+}
+
 function mkConfigObj(opts) {
   if (!opts.client) {
     throw new Error(
@@ -17,16 +44,14 @@ function mkConfigObj(opts) {
   const envName = opts.env || process.env.NODE_ENV || 'development';
   const resolvedClientName = resolveClientNameWithAliases(opts.client);
   const useNullAsDefault = resolvedClientName === 'sqlite3';
+  const parsedConfig = parseConfigObj(opts);
+
   return {
     ext: DEFAULT_EXT,
     [envName]: {
+      ...parsedConfig,
       useNullAsDefault,
-      client: opts.client,
-      connection: opts.connection,
-      migrations: {
-        directory: opts.migrationsDirectory,
-        tableName: opts.migrationsTableName || DEFAULT_TABLE_NAME,
-      },
+      tableName: parsedConfig.tableName || DEFAULT_TABLE_NAME,
     },
   };
 }
@@ -174,6 +199,7 @@ function findUpConfig(cwd, name, extensions) {
 }
 
 module.exports = {
+  parseConfigObj,
   mkConfigObj,
   resolveEnvironmentConfig,
   exit,

package/bin/utils/migrationsLister.js

@@ -6,7 +6,7 @@ function listMigrations(completed, newMigrations) {
   let message = '';
 
   if (completed.length === 0) {
-    message += color.red('No Completed Migration files Found. \n');
+    message += color.red('No Completed Migration files Found.\n');
   } else {
     message = color.green(
       `Found ${completed.length} Completed Migration file/files.\n`
@@ -14,7 +14,7 @@ function listMigrations(completed, newMigrations) {
 
     for (let i = 0; i < completed.length; i++) {
       const file = completed[i];
-      message += color.cyan(`${file} \n`);
+      message += color.cyan(`${file.name}\n`);
     }
   }
 
@@ -27,7 +27,7 @@ function listMigrations(completed, newMigrations) {
 
     for (let i = 0; i < newMigrations.length; i++) {
       const file = newMigrations[i];
-      message += color.cyan(`${file.file} \n`);
+      message += color.cyan(`${file.file}\n`);
     }
   }
 

package/lib/client.js

@@ -189,7 +189,10 @@ class Client extends EventEmitter {
     try {
       this.driver = this._driver();
     } catch (e) {
-      const message = `Knex: run\n$ npm install ${this.driverName} --save`;
+      const driverName = this.aliasDriverName
+        ? this.aliasDriverName
+        : this.driverName;
+      const message = `Knex: run\n$ npm install ${driverName} --save`;
       this.logger.error(`${message}\n${e.message}\n${e.stack}`);
       throw new Error(`${message}\n${e.message}`);
     }

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

@@ -35,9 +35,9 @@ class QueryCompiler_CRDB extends QueryCompiler_PG {
 
   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/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() +
@@ -135,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: [],
@@ -269,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

@@ -156,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 (

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) {
@@ -341,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/sqlite3/index.js

@@ -232,6 +232,8 @@ Object.assign(Client_SQLite3.prototype, {
   dialect: 'sqlite3',
 
   driverName: 'sqlite3',
+  // SqlLite3 driver package name is different from driver name.
+  aliasDriverName: '@vscode/sqlite3',
 });
 
 module.exports = Client_SQLite3;

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/migrations/util/is-module-type.js

@@ -1,14 +1,9 @@
-const { readFile } = require('./fs');
+const getPackageType = require('get-package-type');
 
 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');
+  return (
+    filepath.endsWith('.mjs') ||
+    (!filepath.endsWith('.cjs') &&
+      (await getPackageType(filepath)) === 'module')
+  );
 };

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',

package/lib/query/querybuilder.js

@@ -691,11 +691,21 @@ class Builder extends EventEmitter {
     return this._whereLike('whereLike', column, value);
   }
 
+  // Adds a `or where like` clause to the query.
+  orWhereLike(column, value) {
+    return this._bool('or')._whereLike('whereLike', column, value);
+  }
+
   // Adds a `where ilike` clause to the query.
   whereILike(column, value) {
     return this._whereLike('whereILike', column, value);
   }
 
+  // Adds a `or where ilike` clause to the query.
+  orWhereILike(column, value) {
+    return this._bool('or')._whereLike('whereILike', column, value);
+  }
+
   // Adds a `group by` clause to the query.
   groupBy(item) {
     if (item && item.isRawInstance) {
@@ -1226,7 +1236,11 @@ class Builder extends EventEmitter {
     const obj = this._single.update || {};
     this._method = 'update';
     if (isString(values)) {
-      obj[values] = returning;
+      if (isPlainObject(returning)) {
+        obj[values] = JSON.stringify(returning);
+      } else {
+        obj[values] = returning;
+      }
       if (arguments.length > 2) {
         ret = arguments[2];
       }
@@ -1505,8 +1519,8 @@ class Builder extends EventEmitter {
     return this;
   }
 
-  orWhereJsonPath(column, operator, value) {
-    return this._bool('or').whereJsonPath(column, operator, value);
+  orWhereJsonPath(column, path, operator, value) {
+    return this._bool('or').whereJsonPath(column, path, operator, value);
   }
 
   // Json superset wheres
@@ -1725,6 +1739,8 @@ Builder.prototype.andWhereNotBetween = Builder.prototype.whereNotBetween;
 Builder.prototype.andWhereJsonObject = Builder.prototype.whereJsonObject;
 Builder.prototype.andWhereNotJsonObject = Builder.prototype.whereJsonObject;
 Builder.prototype.andWhereJsonPath = Builder.prototype.whereJsonPath;
+Builder.prototype.andWhereLike = Builder.prototype.whereLike;
+Builder.prototype.andWhereILike = Builder.prototype.whereILike;
 Builder.prototype.andHaving = Builder.prototype.having;
 Builder.prototype.andHavingIn = Builder.prototype.havingIn;
 Builder.prototype.andHavingNotIn = Builder.prototype.havingNotIn;

package/lib/query/querycompiler.js

@@ -124,8 +124,54 @@ class QueryCompiler {
   select() {
     let sql = this.with();
 
-    const statements = components.map((component) => this[component](this));
-    sql += compact(statements).join(' ');
+    let unionStatement = '';
+
+    const firstStatements = [];
+    const endStatements = [];
+
+    components.forEach((component) => {
+      const statement = this[component](this);
+      // We store the 'union' statement to append it at the end.
+      // We still need to call the component sequentially because of
+      // order of bindings.
+      switch (component) {
+        case 'union':
+          unionStatement = statement;
+          break;
+        case 'columns':
+        case 'join':
+        case 'where':
+          firstStatements.push(statement);
+          break;
+        default:
+          endStatements.push(statement);
+          break;
+      }
+    });
+
+    // Check if we need to wrap the main query.
+    // We need to wrap main query if one of union have wrap options to true
+    // to avoid error syntax (in PostgreSQL for example).
+    const wrapMainQuery =
+      this.grouped.union &&
+      this.grouped.union.map((u) => u.wrap).some((u) => u);
+
+    if (this.onlyUnions()) {
+      const statements = compact(firstStatements.concat(endStatements)).join(
+        ' '
+      );
+      sql += unionStatement + (statements ? ' ' + statements : '');
+    } else {
+      const allStatements =
+        (wrapMainQuery ? '(' : '') +
+        compact(firstStatements).join(' ') +
+        (wrapMainQuery ? ')' : '');
+      const endStat = compact(endStatements).join(' ');
+      sql +=
+        allStatements +
+        (unionStatement ? ' ' + unionStatement : '') +
+        (endStat ? ' ' + endStat : endStat);
+    }
     return sql;
   }
 
@@ -706,9 +752,10 @@ class QueryCompiler {
         this.bindingsHolder
       );
       if (statement) {
-        if (union.wrap) sql += '(';
+        const wrap = union.wrap;
+        if (wrap) sql += '(';
         sql += statement;
-        if (union.wrap) sql += ')';
+        if (wrap) sql += ')';
       }
     }
     return sql;
@@ -842,6 +889,7 @@ class QueryCompiler {
   }
 
   onBasic(clause) {
+    const toWrap = clause.value instanceof QueryBuilder;
     return (
       wrap_(
         clause.column,
@@ -858,13 +906,15 @@ class QueryCompiler {
         this.bindingsHolder
       ) +
       ' ' +
+      (toWrap ? '(' : '') +
       wrap_(
         clause.value,
         undefined,
         this.builder,
         this.client,
         this.bindingsHolder
-      )
+      ) +
+      (toWrap ? ')' : '')
     );
   }