v0.28

[igalklebanov]

Hey 👋

(changes since last edit: 74aed5d...v0.28)

It's been a long time coming, and now you can finally start transactions, and commit or roll them back manually!

const trx = await db.startTransaction().execute()

try {
  // do stuff with `trx`, including work with savepoints via the new `savepoint(name)`, `rollbackToSavepoint(name)` and `releaseSavepoint(name)` methods!

  await trx.commit().execute()
} catch (error) {
  await trx.rollback().execute()

  throw error
}

We also added using keyword support, so now you can write:

await using db = new Kysely({...})

and db.destroy() will be called automatically once the current scope is exited.
If you plan on trying this out (it is optional, you can still const db = new Kysely({...}) and await db.destroy() manually), the using keyword requires typescript >= 5.2 and the following tsconfig.json options:

{
  "compilerOptions": {
    "target": "ES2022",
    "lib": ["ESNext", ...],
    ...
  }
  ...
}

We also added a plugin to handle in () and not in (). It comes with 2 handling strategies, one similar to how Knex.js, PrismaORM, Laravel and SQLAlchemy do it, and one similar to how TypeORM and Sequelize do it. It also supports custom strategies, e.g. throwing an error to avoid making a call to the database and wasting resources. Here's an example with one of the strategies we ship:

import {
  // ...
  HandleEmptyInListsPlugin,
  // ...
  replaceWithNoncontingentExpression,
  // ...
} from 'kysely'

const db = new Kysely<Database>({
  // ...
  plugins: [
    new HandleEmptyInListsPlugin({
      strategy: replaceWithNoncontingentExpression
    })
  ],
})

// ...
  .where('id', 'in', [])
  .where('first_name', 'not in', []) // => `where 1 = 0 and 1 = 1`

🚀 Features

• InferResult should output plural. by @igalklebanov in InferResult should output plural. #1064
• Speedup types with huge databases. Fixes Case of extremely slow type checking #867 by @koskimas in Speedup types with huge databases. Fixes #867 #1080
• implement missing expression features by @koskimas in add reusable helpers recipe and implement missing expression features #1085
• Remove preventAwait by @wirekang in Remove preventAwait #1160
• add ControlledTransaction. by @igalklebanov in add ControlledTransaction. #962 & fix TS backwards compat following ControlledTransaction. #1193
• await using kysely = new Kysely() support. by @igalklebanov in await using kysely = new Kysely() support. #1167
• feat: add HandleEmtpyInListsPlugin. by @austinwoon and @igalklebanov in feat: add HandleEmtpyInListsPlugin. #925
• Add Date as a valid return type for max and min by @samclearman & @igalklebanov in Add Date as a valid return type for max and min #1062
• Add support for cross join and cross join lateral by @ersinakinci in Add support for cross join and cross join lateral #1325
• dry up joins. by @igalklebanov in c95f499
• revisiting orderBy - deprecations, new order by item builder (nullFirst(), nullsLast(), collate()). by @igalklebanov in revisiting orderBy - deprecations, new order by item builder (nullFirst(), nullsLast(), collate()). #1326
• add queryId to CompiledQuery and all transformer methods. by @igalklebanov in add queryId to CompiledQuery and all transformer methods. #176
• feat: Add disableTransactions option to Migrator by @reidswan in feat: Add disableTransactions option to Migrator #1335

PostgreSQL 🐘 / MS SQL Server 🥅

• Add within group clause support for aggregate function builder by @ivashog in Add within group clause support for aggregate function builder #1024

PostgreSQL 🐘

• feat: support refresh materialized view by @QuentinJanuel in feat: support refresh materialized view #990
• add returning support in MERGE queries. by @igalklebanov in add returning support in MERGE queries. #1171
• Support json_agg(column_ref) by @SimonSimCity in Support json_agg(column_ref) #1316

MySQL 🐬

• Support update table1, table2, ... query support. Closes Update statements with joins don't seem to work #192 by @koskimas in Support update table1, table2, ... query support. Closes #192 #1079

MS SQL Server 🥅

• Add outer and cross apply (mssql) by @drew-marsh in Add outer and cross apply (mssql) #1074

SQLite 📘

• SQLite's OR CONFLICT clause for inserts by @vincentiusvin & @igalklebanov in SQLite's OR CONFLICT clause for inserts #976

🐞 Bugfixes

📖 Documentation

• add reusable helpers recipe by @koskimas in add reusable helpers recipe and implement missing expression features #1085
• fix jsdocs. by @igalklebanov in 1c5e03a

📦 CICD & Tooling

• ci: run 22.x by @igalklebanov in 9736aeb
• chore: enforce min TS version by @igalklebanov in chore: enforce min TS version #1194
• fix package-lock. by @igalklebanov in f348dfb
• add TypeScript benchmarks. by @igalklebanov in add TypeScript benchmarks. #1314
• improve join tests dialect coverage. by @igalklebanov in 6eaf754
• minor ci tweaks. by @igalklebanov in ca11632

⚠️ Breaking Changes

• InferResult now outputs InsertResult[], UpdateResult[], DeleteResult[], MergeResult[], instead of InsertResult, UpdateResult, DeleteResult, MergeResult. To get the singular form, use type Result = InferResult<T>[number].
• Some generic/wide usages of QueryCreator's methods should no longer pass type checks. We never supported these officially.
• As preventAwait is now removed on all builders, you must avoid awaiting builders without calling execute-like methods on your own.
• TypeScript versions 4.5 and older are no longer supported. You will get an immediate compilation error telling you to upgrade.
• QueryResult.numUpdatedOrDeletedRows has been removed (after spending ~2 years in deprecation). We still log a warning. Outdated dialects that don't use QueryResult.numAffectedRows should be updated OR forked.
• DefaultQueryExecutor.compileQuery now requires passing a queryId argument. Use the newly exported createQueryId() as that argument value from now on.

🐤 New Contributors

• @QuentinJanuel made their first contribution in feat: support refresh materialized view #990
• @austinwoon made their first contribution in feat: add HandleEmtpyInListsPlugin. #925
• @samclearman made their first contribution in Add Date as a valid return type for max and min #1062
• @drew-marsh made their first contribution in Add outer and cross apply (mssql) #1074
• @SimonSimCity made their first contribution in Support json_agg(column_ref) #1316
• @ersinakinci made their first contribution in Add support for cross join and cross join lateral #1325
• @reidswan made their first contribution in feat: Add disableTransactions option to Migrator #1335

Full Changelog: master...v0.28

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
kysely	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Feb 1, 2025 2:02pm

[pkg-pr-new]

Open in Stackblitz • kysely_koa_example

npm i https://pkg.pr.new/kysely-org/kysely@1278

commit: 74aed5d

[belgattitude]

Btw thank you so much for the work you’re doing. Started using kysely and was really impressed !

congrats 🙌

[koskimas]

@igalklebanov Feel free to merge this when you feel it's ready. I simply don't have the time right now to review. I trust you. Let me know when you want me to publish to npm.

[igalklebanov]

Hey @koskimas 👋

Just parked it here to run CI (tests and preview release).
I wanna see if possible to add another long awaited feature before finalizing the list - and maybe some community PRs.

[cseickel]

@igalklebanov do you have any estimate on when v0.28 will be released? I'm itching to try out the performance improvements.

[igalklebanov]

@igalklebanov do you have any estimate on when v0.28 will be released? I'm itching to try out the performance improvements.

We have preview releases. Try today.

npm i https://pkg.pr.new/kysely-org/kysely@1278

[flodlc]

@igalklebanov, thanks for the preview release.
Just tried it, I got JavaScript heap out of memory with 4gb allowed after a time approximately equal or higher than successful typecheck on version 0.27.4.
What time improvements should we expect? Is it an issue you already encountered?

Edit: with 8gb it works but I don't see any typecheck perf improvements on my side. I have around 60 tables and large codebase.

[igalklebanov]

@flodlc your comment is not actionable. Please submit a new issue with some traces, numbers, minimal reproduction, tsconfigs, TypeScript version, etc.

[flodlc]

@flodlc your comment is not actionable. Please submit a new issue with some traces, numbers, minimal reproduction, tsconfigs, TypeScript version, etc.

@igalklebanov Ok, I'll open an issue with a maximum of information soon and try to isolate the problem. What I can say for now is that there are cases (mine) where 0.28 break the typechecking performance.