knex 2.5.0 → 3.0.0

package/CHANGELOG.md

@@ -1,40 +1,59 @@
 # Master (Unreleased)
 
+# 3.0.0 - 6 October, 2023
+
+- Fix raw bindings typing (#5401)
+- Fix migrate:unlock when used with custom identifier wrapping. (#5353)
+- Fix driver options specified with .options() method being ignored for oracledb dialect (#5123)
+- Drop compatibility for Node < 16
+- Fix knex d.ts to work with mixed modules (#5659)
+- Fix Lexical error from "Instaed" to "Instead" (#5655)
+
+### Bug fixes
+
+- Fix Linting #5455 - #5460
+
+# 2.5.1 - 12 July, 2023
+
+### Bug fixes
+
+- Fix Linting #5455 - #5460
+
 # 2.5.0 - 08 July, 2023
 
 ### New features
 
-- Add uuid helper function #5617
-- Add `nativeBindings` option to `better-sqlite3` options #5461
-- Add QueryBuilder#updateFrom #5386
-- Add readonly transaction access mode #5445
-- Add readonly option to Better-SQLite3 #5530
-- Add EXCEPT as a valid keyword #5357
-- Add ability to prepend query comments #5289
-- Add fetchAsString option #5484
+- Add uuid helper function (#5617)
+- Add `nativeBindings` option to `better-sqlite3` options (#5461)
+- Add QueryBuilder#updateFrom (#5386)
+- Add readonly transaction access mode (#5445)
+- Add readonly option to Better-SQLite3 (#5530)
+- Add EXCEPT as a valid keyword (#5357)
+- Add ability to prepend query comments (#5289)
+- Add fetchAsString option (#5484)
 
 ### Bug fixes
 
-- Avoid password leaks on query logs #5559
-- Add knex.mjs to files in package.json #5518
-- Handle numeric array elements in .orderBy() #5551
-- Attach error handler early enough #5552
-- Fix Returning * in Oracle #5598
-- Fix indexType option in `Postgres` #5601
-- Add mjs extension type #5616
-- Use implicit check on json fields for OracleDB #5478
-- Fix when manually close source stream #5466
-- Fix case sensitive issue with get table #5509
+- Avoid password leaks on query logs (#5559)
+- Add knex.mjs to files in package.json (#5518)
+- Handle numeric array elements in .orderBy() (#5551)
+- Attach error handler early enough (#5552)
+- Fix Returning \* in Oracle (#5598)
+- Fix indexType option in `Postgres` (#5601)
+- Add mjs extension type (#5616)
+- Use implicit check on json fields for OracleDB (#5478)
+- Fix when manually close source stream (#5466)
+- Fix case sensitive issue with get table (#5509)
 
 ### Typings
 
-- Add Object syntax overload to increment method #5512
-- Add object syntax overload to decrement method #5555
-- Fix typing for toSql #5594
-- Add ResolveTableType for `.merge()` #5605
-- Add missing types for havingNull and havingNotNull #5529
-- Add collate to the columnbuilder interface #5568
-- TableBuilder methods return the SchemaBuilder. #5486
+- Add Object syntax overload to increment method (#5512)
+- Add object syntax overload to decrement method (#5555)
+- Fix typing for toSql (#5594)
+- Add ResolveTableType for `.merge()` (#5605)
+- Add missing types for havingNull and havingNotNull (#5529)
+- Add collate to the columnbuilder interface (#5568)
+- TableBuilder methods return the SchemaBuilder. (#5486)
 
 # 2.4.2 - 22 January, 2023
 
@@ -501,13 +520,13 @@ Note: there are many breaking changes in this version, particularly in TypeScrip
 - Change default to not trigger a promise rejection for transactions with a specified handler #4195
 - Make toSQL().toNative() work for Raw to match the API for QueryBuilder #4058
 - Allow 'match' operator #3569
-- Support optimizer hints #4243  
+- Support optimizer hints #4243
 - Add parameter to prevent autoincrement columns from being primary keys #4266
-- Make "first" and "pluck" mutually exclusive #4280  
+- Make "first" and "pluck" mutually exclusive #4280
 - Added merge strategy to allow selecting columns to upsert. #4252
 - Throw error if the array passed to insert is empty #4289
 - Events: introduce queryContext on query-error #4301
-- CLI: Use UTC timestamp for new migrations #4245  
+- CLI: Use UTC timestamp for new migrations #4245
 - MSSQL: Replace MSSQL dialect with Tedious.js implementation #2857 #4281
 - MSSQL: Use "nvarchar(max)" for ".json()" #4278
 - MSSQL: Schema builder - add predictable constraint names for default values #4319
@@ -549,9 +568,9 @@ Note: there are many breaking changes in this version, particularly in TypeScrip
 - Various internal refactorings #4175 #4177 #4178 #4192
 - Refactor to classes #4190 #4191 #4193 #4210 #4253
 - Move transaction type tests to TSD #4208
-- Clean up destroy logic #4248  
-- Colorize code snippets in readme files #4234  
-- Add "Ecosystem" documentation for Knex plugins #4183  
+- Clean up destroy logic #4248
+- Colorize code snippets in readme files #4234
+- Add "Ecosystem" documentation for Knex plugins #4183
 - Documentation cleanup
 - SQLite: Use SQLite "rename column" instead of a DDL helper #4200
 - SQLite: Simplify reinsert logic when altering a table #4272
@@ -606,7 +625,7 @@ Note: there are many breaking changes in this version, particularly in TypeScrip
 
 ### Bug fixes:
 
-- Make sure query-response and query-error events contain _knexTxId #4160
+- Make sure query-response and query-error events contain \_knexTxId #4160
 
 ### Test / internal changes:
 
@@ -862,7 +881,7 @@ Note: there are many breaking changes in this version, particularly in TypeScrip
 
 ### Bug fixes:
 
-- Correctly handle dateToString escaping without timezone passed #3742 
+- Correctly handle dateToString escaping without timezone passed #3742
 - Make protocol length check more defensive #3744
 
 ### Typings:
@@ -873,7 +892,7 @@ Note: there are many breaking changes in this version, particularly in TypeScrip
 
 ### Bug fixes:
 
-- Added missing call to _reject in Transactor#transaction #3706
+- Added missing call to \_reject in Transactor#transaction #3706
 - Fix method binding on knex proxy #3717
 - Oracle: Transaction_OracleDB can use config.connection #3731
 
@@ -884,7 +903,7 @@ Note: there are many breaking changes in this version, particularly in TypeScrip
 ### Test / internal changes:
 
 - Cleanup/remove transaction stalling #3716
-- Rewrote Transaction#acquireConnection() methods to use async #3707 
+- Rewrote Transaction#acquireConnection() methods to use async #3707
 
 # 0.20.11 - 26 February, 2020
 
@@ -920,7 +939,7 @@ Note: there are many breaking changes in this version, particularly in TypeScrip
 ### Typings:
 
 - `fn.now` takes optionally a precision argument. #3662
-- PG: Include SSL in connection definition #3659 
+- PG: Include SSL in connection definition #3659
 
 ### Test / internal changes:
 
@@ -934,7 +953,7 @@ Note: there are many breaking changes in this version, particularly in TypeScrip
 
 ### Typings:
 
-- MSSQL: Add `enableArithAbort` to `MsSqlConnectionConfig` 
+- MSSQL: Add `enableArithAbort` to `MsSqlConnectionConfig`
 
 ### Test / internal changes:
 
@@ -953,7 +972,7 @@ Note: there are many breaking changes in this version, particularly in TypeScrip
 
 ### Typings:
 
-- Fix incorrect type of QueryBuilder.first('*') result #3621
+- Fix incorrect type of QueryBuilder.first('\*') result #3621
 
 # 0.20.7 - 07 January, 2020
 
@@ -1108,7 +1127,7 @@ Note: there are many breaking changes in this version, particularly in TypeScrip
 ### Typings:
 
 - Add missing Migrator.list typing #3460
-- Fix Typescript type inference for to better support wildcard (*) calls #3444
+- Fix Typescript type inference for to better support wildcard (\*) calls #3444
 - Make options argument optional in timeout #3442
 
 ### Test / internal changes:
@@ -1145,7 +1164,7 @@ Note: there are many breaking changes in this version, particularly in TypeScrip
 
 ### Changes:
 
-- migrate: Refactor _lockMigrations to avoid forUpdate - makes migrations compatible with CockroachDB #3395
+- migrate: Refactor \_lockMigrations to avoid forUpdate - makes migrations compatible with CockroachDB #3395
 
 # 0.19.2 - 17 August, 2019
 
@@ -1156,7 +1175,7 @@ Note: there are many breaking changes in this version, particularly in TypeScrip
 
 ### New features:
 
-- Fallback to JSON when using JSONB in MySQL #3394 
+- Fallback to JSON when using JSONB in MySQL #3394
 
 # 0.19.1 - 23 July, 2019
 
@@ -1175,7 +1194,7 @@ Note: there are many breaking changes in this version, particularly in TypeScrip
 
 ### Changes:
 
-- Pooling: tarn.js connection pool was updated to version 2.0.0. This fixes issue with destroying connections and introduces support for connection pool event handlers. Please see tarn.js documentation for more details #3345 
+- Pooling: tarn.js connection pool was updated to version 2.0.0. This fixes issue with destroying connections and introduces support for connection pool event handlers. Please see tarn.js documentation for more details #3345
 - Pooling: Passing unsupported pooling configuration options now throws an error
 - Pooling: `beforeDestroy` configuration option was removed
 
@@ -1366,7 +1385,7 @@ Note: there are many breaking changes in this version, particularly in TypeScrip
 - Typings: Add 'string' as accepted Knex constructor type definition #3105
 - Typings: Add boolean as a column name in join #3121
 - Typings: Add missing clearOrder & clearCounters types #3109
-- Dependencies: Fix security warning #3082 
+- Dependencies: Fix security warning #3082
 - Do not use unsupported column width/length arguments on data types int and tinyint in MSSQL #2738
 
 ### Changes:
@@ -1403,7 +1422,7 @@ Note: there are many breaking changes in this version, particularly in TypeScrip
 
 ### New features:
 
-- Support passing explicit connection to query builder #2817
+- Support passing explicit connection to query builder (#2817)
 - Introduced abstraction for getting migrations to make migration bundling easier #2775
 - Allow timestamp with timezone on mssql databases #2724
 - Allow specifying multiple migration directories #2735
@@ -1460,7 +1479,7 @@ Note: there are many breaking changes in this version, particularly in TypeScrip
 
 ### Changes:
 
-- THIS RELEASE WAS UNPUBLISHED FROM NPM BECAUSE IT HAD BROKEN MIGRATIONS USING `postprocessResponse` FEATURE #2644
+- THIS RELEASE WAS UNPUBLISHED FROM NPM BECAUSE IT HAD BROKEN MIGRATIONS USING `postprocessResponse` FEATURE (#2644)
 
 # 0.15.2 - 19 Jul, 2018
 
@@ -1489,7 +1508,7 @@ Note: there are many breaking changes in this version, particularly in TypeScrip
 - Drop support for strong-oracle #2487
 - Timeout errors doesn't silently ignore the passed errors anymore #2626
 - Removed WebSQL dialect #2647
-- Various fixes to mssql dialect to make it compatible with other dialects #2653, Unique constraint now allow multiple null values, float type is now float instaed of decimal, rolling back transaction with undefined rejects with Error, select for update and select for share actually locks selected row, so basically old schema migrations will work a lot different and produce different schema like before. Also now MSSQL is included in CI tests.
+- Various fixes to mssql dialect to make it compatible with other dialects #2653, Unique constraint now allow multiple null values, float type is now float instead of decimal, rolling back transaction with undefined rejects with Error, select for update and select for share actually locks selected row, so basically old schema migrations will work a lot different and produce different schema like before. Also now MSSQL is included in CI tests.
 
 ### Bug fixes:
 
@@ -1521,7 +1540,7 @@ Note: there are many breaking changes in this version, particularly in TypeScrip
 
 ### Bug fixes:
 
-- Restored functionality of query event #2566 #2549
+- Restored functionality of query event #2566 (#2549)
 
 # 0.14.5 - 8 Apr, 2018
 
@@ -1549,23 +1568,23 @@ Note: there are many breaking changes in this version, particularly in TypeScrip
 
 ### Bug fixes:
 
-- containsUndefined only validate plain objects. Fixes #1898 #2468
-- Add warning when using .returning() in sqlite3. Fixes #1660 #2471
-- Throw an error if .update() results in an empty sql #2472
-- Removed unnecessary createTableIfNotExist and replaced with createTable #2473
+- containsUndefined only validate plain objects. Fixes #1898 (#2468)
+- Add warning when using .returning() in sqlite3. Fixes #1660 (#2471)
+- Throw an error if .update() results in an empty sql (#2472)
+- Removed unnecessary createTableIfNotExist and replaced with createTable (#2473)
 
 ### New Features:
 
-- Allow calling lock procedures (such as forUpdate) outside of transaction. Fixes #2403. #2475
-- Added test and documentation for Event 'start' #2488
+- Allow calling lock procedures (such as forUpdate) outside of transaction. Fixes #2403. (#2475)
+- Added test and documentation for Event 'start' (#2488)
 
 ### Test / internal changes:
 
 - Added stress test, which uses TCP proxy to simulate flaky connection #2460
-- Removed old docker tests, new stress test setup #2474
-- Removed unused property \_\_cid on the base client #2481
-- Changed rm to rimraf in 'npm run dev' #2483
-- Changed babel preset and use latest node as target when running dev #2484
+- Removed old docker tests, new stress test setup (#2474)
+- Removed unused property \_\_cid on the base client (#2481)
+- Changed rm to rimraf in 'npm run dev' (#2483)
+- Changed babel preset and use latest node as target when running dev (#2484)
 
 # 0.14.3 - 8 Feb, 2018
 
@@ -1716,8 +1735,8 @@ Note: there are many breaking changes in this version, particularly in TypeScrip
 
 # 0.12.6 - 19 Oct, 2016
 
-- Address warnings mentioned in #1388 #1740
-- Remove postinstall script #1746
+- Address warnings mentioned in #1388 (#1740)
+- Remove postinstall script (#1746)
 
 # 0.12.5 - 12 Oct, 2016