knex 1.0.3 → 1.0.4

package/CHANGELOG.md

@@ -1,5 +1,27 @@
 # 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:

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/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/query/method-constants.js

@@ -27,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) {
@@ -1505,8 +1515,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 +1735,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,36 @@ class QueryCompiler {
   select() {
     let sql = this.with();
 
-    const statements = components.map((component) => this[component](this));
-    sql += compact(statements).join(' ');
+    let unionStatement = '';
+    // Compute all statements to main query
+    const statements = components.map((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.
+      if (component === 'union') {
+        unionStatement = statement;
+      } else {
+        return statement;
+      }
+    });
+
+    // 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);
+    const allStatements =
+      (wrapMainQuery ? '(' : '') +
+      compact(statements).join(' ') +
+      (wrapMainQuery ? ')' : '');
+
+    if (this.onlyUnions()) {
+      sql += unionStatement + ' ' + allStatements;
+    } else {
+      sql += allStatements + (unionStatement ? ' ' + unionStatement : '');
+    }
     return sql;
   }
 
@@ -706,9 +734,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 +871,7 @@ class QueryCompiler {
   }
 
   onBasic(clause) {
+    const toWrap = clause.value instanceof QueryBuilder;
     return (
       wrap_(
         clause.column,
@@ -858,13 +888,15 @@ class QueryCompiler {
         this.bindingsHolder
       ) +
       ' ' +
+      (toWrap ? '(' : '') +
       wrap_(
         clause.value,
         undefined,
         this.builder,
         this.client,
         this.bindingsHolder
-      )
+      ) +
+      (toWrap ? ')' : '')
     );
   }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "knex",
-  "version": "1.0.3",
+  "version": "1.0.4",
   "description": "A batteries-included SQL query & schema builder for PostgresSQL, MySQL, CockroachDB, MSSQL and SQLite3",
   "main": "knex",
   "types": "types/index.d.ts",
@@ -114,7 +114,7 @@
     "husky": "^4.3.8",
     "jake": "^8.1.1",
     "JSONStream": "^1.3.5",
-    "lint-staged": "^11.1.2",
+    "lint-staged": "^12.3.4",
     "mocha": "^9.2.0",
     "mock-fs": "^5.1.2",
     "mysql": "^2.18.1",
@@ -123,7 +123,7 @@
     "oracledb": "^5.3.0",
     "pg": "^8.7.1",
     "pg-query-stream": "^4.2.1",
-    "prettier": "2.4.1",
+    "prettier": "2.5.1",
     "rimraf": "^3.0.2",
     "sinon": "^13.0.1",
     "sinon-chai": "^3.7.0",
@@ -146,7 +146,7 @@
     "type": "git",
     "url": "git://github.com/knex/knex.git"
   },
-  "homepage": "https://knexjs.org",
+  "homepage": "https://knex.github.io/documentation/",
   "keywords": [
     "sql",
     "query",
@@ -175,6 +175,9 @@
       "name": "Igor Savin",
       "web": "https://www.codeflashbacks.com"
     },
+    {
+      "name": "Olivier Cavadenti"
+    },
     {
       "name": "Simon Liden"
     },
@@ -185,9 +188,6 @@
     {
       "name": "Brian Lauber",
       "web": "https://briandamaged.org"
-    },
-    {
-      "name": "Olivier Cavadenti"
     }
   ],
   "browser": {

package/types/index.d.ts

@@ -284,27 +284,6 @@ type AggregationQueryResult<TResult, TIntersectProps2> = ArrayIfAlready<
   : TIntersectProps2
 >;
 
-// Convenience alias and associated companion namespace for working
-// with DeferredSelection having TSingle=true.
-//
-// When TSingle=true in DeferredSelection, then we are effectively
-// deferring an index access operation (TBase[TKey]) over a potentially
-// unknown initial type of TBase and potentially never initial type of TKey
-
-type DeferredIndex<TBase, TKey extends string> = DeferredKeySelection<TBase, TKey, false, {}, true>;
-
-declare namespace DeferredIndex {
-  type Augment<
-    T,
-    TBase,
-    TKey extends string,
-    TAliasMapping = {}
-    > = DeferredKeySelection.SetSingle<
-      DeferredKeySelection.AddKey<DeferredKeySelection.SetBase<T, TBase>, TKey>,
-      true
-    >;
-}
-
 // If we have more categories of deferred selection in future,
 // this will combine all of them
 type ResolveResult<S> = DeferredKeySelection.Resolve<S>;
@@ -548,7 +527,11 @@ export declare namespace Knex {
     whereNotIn: WhereIn<TRecord, TResult>;
     orWhereNotIn: WhereIn<TRecord, TResult>;
     whereLike: Where<TRecord, TResult>;
+    andWhereLike: Where<TRecord, TResult>;
+    orWhereLike: Where<TRecord, TResult>;
     whereILike: Where<TRecord, TResult>;
+    andWhereILike: Where<TRecord, TResult>;
+    orWhereILike: Where<TRecord, TResult>;
     whereNull: WhereNull<TRecord, TResult>;
     orWhereNull: WhereNull<TRecord, TResult>;
     whereNotNull: WhereNull<TRecord, TResult>;
@@ -694,7 +677,7 @@ export declare namespace Knex {
     ): QueryBuilder<TRecord, DeferredKeySelection<TRecord, never>[]>;
     insert<
       TKey extends StrKey<ResolveTableType<TRecord>>,
-      TResult2 = DeferredIndex.Augment<
+      TResult2 = DeferredKeySelection.Augment<
         UnwrapArrayMember<TResult>,
         ResolveTableType<TRecord>,
         TKey
@@ -722,7 +705,7 @@ export declare namespace Knex {
     ): QueryBuilder<TRecord, TResult2>;
     insert<
       TKey extends string,
-      TResult2 = DeferredIndex.Augment<
+      TResult2 = DeferredKeySelection.Augment<
         UnwrapArrayMember<TResult>,
         TRecord,
         TKey
@@ -736,7 +719,7 @@ export declare namespace Knex {
     ): QueryBuilder<TRecord, TResult2>;
     insert<
       TKey extends string,
-      TResult2 = DeferredIndex.Augment<
+      TResult2 = DeferredKeySelection.Augment<
         UnwrapArrayMember<TResult>,
         TRecord,
         TKey
@@ -763,7 +746,7 @@ export declare namespace Knex {
     ): QueryBuilder<TRecord, DeferredKeySelection<TRecord, never>[]>;
     upsert<
       TKey extends StrKey<ResolveTableType<TRecord>>,
-      TResult2 = DeferredIndex.Augment<
+      TResult2 = DeferredKeySelection.Augment<
         UnwrapArrayMember<TResult>,
         ResolveTableType<TRecord>,
         TKey
@@ -791,7 +774,7 @@ export declare namespace Knex {
     ): QueryBuilder<TRecord, TResult2>;
     upsert<
       TKey extends string,
-      TResult2 = DeferredIndex.Augment<
+      TResult2 = DeferredKeySelection.Augment<
         UnwrapArrayMember<TResult>,
         TRecord,
         TKey
@@ -805,7 +788,7 @@ export declare namespace Knex {
     ): QueryBuilder<TRecord, TResult2>;
     upsert<
       TKey extends string,
-      TResult2 = DeferredIndex.Augment<
+      TResult2 = DeferredKeySelection.Augment<
         UnwrapArrayMember<TResult>,
         TRecord,
         TKey
@@ -830,7 +813,7 @@ export declare namespace Knex {
     update<
       K1 extends StrKey<ResolveTableType<TRecord, 'update'>>,
       K2 extends StrKey<ResolveTableType<TRecord>>,
-      TResult2 = DeferredIndex.Augment<
+      TResult2 = DeferredKeySelection.Augment<
         UnwrapArrayMember<TResult>,
         ResolveTableType<TRecord>,
         K2
@@ -872,7 +855,7 @@ export declare namespace Knex {
     ): QueryBuilder<TRecord, DeferredKeySelection<TRecord, never>[]>;
     update<
       TKey extends StrKey<ResolveTableType<TRecord>>,
-      TResult2 = DeferredIndex.Augment<
+      TResult2 = DeferredKeySelection.Augment<
         UnwrapArrayMember<TResult>,
         ResolveTableType<TRecord>,
         TKey
@@ -927,7 +910,7 @@ export declare namespace Knex {
     returning(column: '*', options?: DMLOptions): QueryBuilder<TRecord, DeferredKeySelection<TRecord, never>[]>;
     returning<
       TKey extends StrKey<ResolveTableType<TRecord>>,
-      TResult2 = DeferredIndex.Augment<
+      TResult2 = DeferredKeySelection.Augment<
         UnwrapArrayMember<TResult>,
         ResolveTableType<TRecord>,
         TKey
@@ -952,24 +935,15 @@ export declare namespace Knex {
     ): QueryBuilder<TRecord, TResult2>;
 
     onConflict<
-      TKey extends StrKey<ResolveTableType<TRecord>>,
-      TResult2 = DeferredIndex.Augment<
-        UnwrapArrayMember<TResult>,
-        TRecord,
-        TKey
-      >[]
+      TKey extends StrKey<ResolveTableType<TRecord>>
     >(
       column: TKey
-    ): OnConflictQueryBuilder<TRecord, TResult2>;
+    ): OnConflictQueryBuilder<TRecord, TResult>;
     onConflict<
-      TKey extends StrKey<ResolveTableType<TRecord>>,
-      TResult2 = DeferredKeySelection.SetSingle<
-        DeferredKeySelection.Augment<UnwrapArrayMember<TResult>, TRecord, TKey>,
-        false
-      >[]
+      TKey extends StrKey<ResolveTableType<TRecord>>
     >(
       columns: readonly TKey[]
-    ): OnConflictQueryBuilder<TRecord, TResult2>;
+    ): OnConflictQueryBuilder<TRecord, TResult>;
 
     onConflict(
       columns: string
@@ -991,7 +965,7 @@ export declare namespace Knex {
     ): QueryBuilder<TRecord, DeferredKeySelection<TRecord, never>[]>;
     del<
       TKey extends StrKey<TRecord>,
-      TResult2 = DeferredIndex.Augment<
+      TResult2 = DeferredKeySelection.Augment<
         UnwrapArrayMember<TResult>,
         TRecord,
         TKey
@@ -1023,7 +997,7 @@ export declare namespace Knex {
     ): QueryBuilder<TRecord, DeferredKeySelection<TRecord, never>[]>;
     delete<
       TKey extends StrKey<ResolveTableType<TRecord>>,
-      TResult2 = DeferredIndex.Augment<
+      TResult2 = DeferredKeySelection.Augment<
         UnwrapArrayMember<TResult>,
         ResolveTableType<TRecord>,
         TKey
@@ -1833,7 +1807,7 @@ export declare namespace Knex {
     returning(column: '*'): BatchInsertBuilder<TRecord, DeferredKeySelection<TRecord, never>[]>;
     returning<
       TKey extends StrKey<ResolveTableType<TRecord>>,
-      TResult2 = DeferredIndex.Augment<
+      TResult2 = DeferredKeySelection.Augment<
         UnwrapArrayMember<TResult>,
         ResolveTableType<TRecord>,
         TKey
@@ -2031,7 +2005,7 @@ export declare namespace Knex {
     createTableLike(
       tableName: string,
       tableNameLike: string,
-      callback: (tableBuilder: CreateTableBuilder) => any
+      callback?: (tableBuilder: CreateTableBuilder) => any
     ): SchemaBuilder;
     alterTable(
       tableName: string,