kysely 0.27.4 → 0.27.6

package/.renovaterc.json

@@ -0,0 +1,3 @@
+{
+  "rangeStrategy": "bump"  
+}

package/CODE_OF_CONDUCT.md

@@ -0,0 +1,183 @@
+# ~~Contributor Covenant Code of Conduct~~ Kysely Code of Conduct
+
+## Our Pledge
+
+~~We as members, contributors, and leaders pledge to make participation in our~~
+~~community a harassment-free experience for everyone, regardless of age, body~~
+~~size, visible or invisible disability, ethnicity, sex characteristics, gender~~
+~~identity and expression, level of experience, education, socio-economic status,~~
+~~nationality, personal appearance, race, religion, or sexual identity~~
+~~and orientation.~~
+
+~~We pledge to act and interact in ways that contribute to an open, welcoming,~~
+~~diverse, inclusive, and healthy community.~~
+
+Don't be an asshole.
+You are not entitled to other people's time, energy, or attention.
+
+That's it. That's the pledge.
+
+## Our Standards
+
+~~Examples of behavior that contributes to a positive environment for our~~
+~~community include:~~
+
+~~* Demonstrating empathy and kindness toward other people~~
+~~* Being respectful of differing opinions, viewpoints, and experiences~~
+~~* Giving and gracefully accepting constructive feedback~~
+~~* Accepting responsibility and apologizing to those affected by our mistakes,~~
+  ~~and learning from the experience~~
+~~* Focusing on what is best not just for us as individuals, but for the~~
+  ~~overall community~~
+
+~~Examples of unacceptable behavior include:~~
+
+~~* The use of sexualized language or imagery, and sexual attention or~~
+  ~~advances of any kind~~
+~~* Trolling, insulting or derogatory comments, and personal or political attacks~~
+~~* Public or private harassment~~
+~~* Publishing others' private information, such as a physical or email~~
+  ~~address, without their explicit permission~~
+~~* Other conduct which could reasonably be considered inappropriate in a~~
+  ~~professional setting~~
+
+Don't be an asshole.
+You are not entitled to other people's time, energy, or attention.
+
+Examples of being an asshole or entitled include:
+
+* Probably not the best idea to come in complaining and not having minimal respect to develop some basic sentences.
+  > what is the migration_lock ?? why we have this in the database - https://github.com/kysely-org/kysely/issues/973
+* Probably not the best idea to attack the maintainer after he answered succinctly (out of character) for whatever reason (context switch? busy?).
+  > You got any more of them there examples buster? - https://github.com/kysely-org/kysely/issues/677#issuecomment-2019876074
+* Probably not the best idea to come in all yelling and demanding stuff.
+  > NO documentation about error handling!!!!
+  > I am really confused that the docs doesnt have anything about error handling
+  > this is a mandataory things to add!! - https://github.com/kysely-org/kysely/issues/1217
+* Probably not the best idea to tone police the maintainer after he spent time explaining library philosophy, and to publicly refuse to contribute something you demanded.
+  > I'm sorry fella but with your tone I really don't feel like it. Good luck - https://github.com/kysely-org/kysely/issues/709#issuecomment-1727617260
+* Probably not the best idea to question the maintainer's decisions after properly answering your question, and to be entitled for JavaScript skill issue help after the issue is closed.
+  > I don't understand your answer and closing the issue. - https://github.com/kysely-org/kysely/issues/527#issuecomment-1577383794
+* Probably not the best idea to jump into closed issues and be entitled to other people's efforts.
+  > why on earth there is no mention of this in the documentation? - https://github.com/kysely-org/kysely/issues/649#issuecomment-2430854835
+* Probably not the best idea to not search existing issues, and then ask the maintainer to spend time doing it.
+  > could you please provide numbers of duplicated issues to explore the topic? - https://github.com/kysely-org/kysely/issues/762#issuecomment-1801951960
+* Probably not the best idea to sarcastically suggest the maintainer is not helpful while using his hard work for free.
+  > Most helpful man in the world - https://github.com/kysely-org/kysely/issues/762#issuecomment-2404599281
+* Probably not the best idea to side with the asshole/entitled by upvoting them or downvoting us.
+
+  ![image](https://github.com/user-attachments/assets/ca6efd57-d8db-428a-a274-7b45b380887f)
+  ![image](https://github.com/user-attachments/assets/62356fa3-7cea-4b82-9967-d56c76f0beee)
+
+
+
+## Enforcement Responsibilities
+
+~~Community leaders are responsible for clarifying and enforcing our standards of~~
+~~acceptable behavior and will take appropriate and fair corrective action in~~
+~~response to any behavior that they deem inappropriate, threatening, offensive,~~
+~~or harmful.~~
+
+~~Community leaders have the right and responsibility to remove, edit, or reject~~
+~~comments, commits, code, wiki edits, issues, and other contributions that are~~
+~~not aligned to this Code of Conduct, and will communicate reasons for moderation~~
+~~decisions when appropriate.~~
+
+We are here in our free time. We are not getting paid to serve and please you.
+
+We will not tolerate assholes or entitled behavior.
+
+We are capable of banning you from the GitHub organization, Discord server, or any 
+other community space we manage. Don't make us do it.
+
+## Scope
+
+~~This Code of Conduct applies within all community spaces, and also applies when~~
+~~an individual is officially representing the community in public spaces.~~
+~~Examples of representing our community include using an official e-mail address,~~
+~~posting via an official social media account, or acting as an appointed~~
+~~representative at an online or offline event.~~
+
+Relevant to all repositories in the Kysely GitHub organization, the Kysely Discord 
+server, and any other community space managed by Kysely.
+
+## Enforcement
+
+~~Instances of abusive, harassing, or otherwise unacceptable behavior may be~~
+~~reported to the community leaders responsible for enforcement at~~
+~~Kysely's GitHub repositories and Discord server.~~
+~~All complaints will be reviewed and investigated promptly and fairly.~~
+
+~~All community leaders are obligated to respect the privacy and security of the~~
+~~reporter of any incident.~~
+
+Report to us anyone who is being an asshole or entitled.
+We will take appropriate action if necessary.
+
+## Enforcement Guidelines
+
+~~Community leaders will follow these Community Impact Guidelines in determining~~
+~~the consequences for any action they deem in violation of this Code of Conduct:~~
+
+We might do these things:
+
+~~### 1. Correction~~
+
+**Community Impact**: ~~Use of inappropriate language or other behavior deemed~~
+~~unprofessional or unwelcome in the community.~~
+
+Someone being an asshole or entitled.
+
+**Consequence**: ~~A private, written warning from community leaders, providing~~
+~~clarity around the nature of the violation and an explanation of why the~~
+~~behavior was inappropriate. A public apology may be requested.~~
+
+We might return the favor (we're not perfect), ignore you, edit/close/lock/delete 
+your post/comment, or ban you. There is no strike system.
+
+~~### 2. Warning~~
+
+~~**Community Impact**: A violation through a single incident or series~~
+~~of actions.~~
+
+~~**Consequence**: A warning with consequences for continued behavior. No~~
+~~interaction with the people involved, including unsolicited interaction with~~
+~~those enforcing the Code of Conduct, for a specified period of time. This~~
+~~includes avoiding interactions in community spaces as well as external channels~~
+~~like social media. Violating these terms may lead to a temporary or~~
+~~permanent ban.~~
+
+~~### 3. Temporary Ban~~
+
+~~**Community Impact**: A serious violation of community standards, including~~
+~~sustained inappropriate behavior.~~
+
+~~**Consequence**: A temporary ban from any sort of interaction or public~~
+~~communication with the community for a specified period of time. No public or~~
+~~private interaction with the people involved, including unsolicited interaction~~
+~~with those enforcing the Code of Conduct, is allowed during this period.~~
+~~Violating these terms may lead to a permanent ban.~~
+
+~~### 4. Permanent Ban~~
+
+~~**Community Impact**: Demonstrating a pattern of violation of community~~
+~~standards, including sustained inappropriate behavior,  harassment of an~~
+~~individual, or aggression toward or disparagement of classes of individuals.~~
+
+~~**Consequence**: A permanent ban from any sort of public interaction within~~
+~~the community.~~
+
+## ~~Attribution~~
+
+~~This Code of Conduct is adapted from the [Contributor Covenant][homepage],~~
+~~version 2.0, available at~~
+~~https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.~~
+
+~~Community Impact Guidelines were inspired by [Mozilla's code of conduct~~
+~~enforcement ladder](https://github.com/mozilla/diversity).~~
+
+~~[homepage]: https://www.contributor-covenant.org~~
+
+~~For answers to common questions about this code of conduct, see the FAQ at~~
+~~https://www.contributor-covenant.org/faq. Translations are available at~~
+~~https://www.contributor-covenant.org/translations.~~

package/CONTRIBUTING.md

@@ -1,17 +1,115 @@
-Would love to contribute to Kysely?
+# Contribution Guidelines
 
-Awesome! We are not very organized yet. We don't have a plan or a roadmap.
+Wanna contribute to Kysely or other libraries within the [kysely-org](https://github.com/kysely-org) organization?
 
-Probably the best way to get going is to watch the issue list.
-An issue with a `greenlit` label, has been acknowledged by the team and is ready for development.
-Find such an issue you'd like to tackle and ask to be assigned to it in the comment section.
-Feel free to open an issue if you found a bug or a missing feature you'd like to work on,
-and there aren't any issues mentioning it.
+You're awesome! 🤗
 
-If you start working on something larger, it's a good idea to create a draft (WIP) PR at 
-an early stage so that we can guide you to the right direction.
+## 😕 How Can I Contribute?
 
-There are quite a few guidelines to keep in mind:
+## 📢 By Spreading the Word
+
+If you like what we're building here, please: 
+
+1. Tell your friends, co-workers, family, neighbors, followers, etc.
+1. Speak about it in meetups and conferences. (if you need help with the presentation, please ask on Discord!).
+
+There is no company behind this organization and project. We do this in our free time and cannot advertise it
+all by ourselves. Companies have dedicated devrel teams doing all that work, other projects might have community
+managers or full-time developers with the capacity to also handle social media and meetups with higher frequency.
+
+More people using Kysely eventually means:
+
+1. less bugs left unreported and unsolved.
+1. high chance people share workarounds.
+1. more data points for innovation.
+1. more people who might contribute and push this thing even further.
+1. it becomes a standard part of the Node.js/Bun/Deno developer's toolbox so you'll happily stumble upon it
+   in future codebases you'll join, or it'll be easier to get buy-in from co-workers/leadership.
+
+## 🤝 By Helping People in Issues or on Discord
+
+We need all the help we can get with supporting the community, answering questions, triaging! 
+
+If you've been using the library for a while, or know a thing or two about SQL, and specific databases, don't 
+be shy about it!
+
+## 🐛 By Submitting Issues (Bugs, Enhancement Ideas, Questions) or Opening threads on Discord
+
+Please use search and make sure an existing **open** issue or thread doesn't exist before submitting. If an existing
+issue is only somewhat relevant, please submit a new issue and reference the old one instead of commenting
+on the existing one. Let us label your new issue as `duplicate` if it is the same thing - it's fine! If it's not 
+the same thing and you commented on another issue, it makes it harder to track on our end.
+
+If possible/relevant, please provide a [playground link](https://kyse.link), Stackblitz OR a public git repository that 
+reproduces the issue.
+
+Please provide the exact error/warning texts you're getting. "this doesn't work" or "this throws an error"
+are not helping us help you.
+
+Don't be an asshole. Don't demand support/service from us.
+
+## ⌨️ With Code!
+
+### 📘 Documentation Code Contributions
+
+Pull requests are always welcome! 
+
+The [kysely.dev](https://kysely.dev) application is located @ [/site](https://github.com/kysely-org/kysely/tree/master/site).
+
+It is a pretty standard [docusaurus](https://docusaurus.io/) application.
+
+The code examples are extracted, using a custom script (see `"script:generate-site-examples"` @ [package.json](https://github.com/kysely-org/kysely/blob/master/package.json)), 
+and custom annotations, from [JSDocs](https://jsdoc.app/) comments in the source code @ [/src](https://github.com/kysely-org/kysely/tree/master/src).
+If you need to change an existing code example, please do so in the source code AND then run the script.
+_TODO: explain how to add a new code example._
+
+If it is a big change (lots of lines of code OR files involved), please get a conversation going on an issue or on 
+Discord before starting work on it.
+
+### 🧙 Implementation Code Contributions (Bugfixes, Enhancements [Existing or New Features])
+
+Pull requests (PRs) are welcome, BUT since:
+
+1. Our time and capacity as maintainers are limited.
+1. Your time is limited.
+1. Your motivation and morale is important to us.
+1. Onboarding in a new highly opinionated open-source project can be challenging.
+
+We need a process in place:
+
+1. To make sure only things that have a good chance of being accepted are worked on. We hate saying "no".
+1. To make sure that things that are being worked on don't result in too much back-and-forth between authors and maintainers.
+   We hate seeing these things drag on for a long time, and we know how frustrating it is on your end.
+1. To make sure there's no pressure on you when you take on a task.
+1. To make sure there's a clear understanding of who is working on what to avoid redundancies and conflicts.
+
+#### The Process
+
+Here is the gist of it:
+
+1. If an issue on the subject **doesn't exist** yet, **submit** one. If you want to work on it, **ask** to be **assigned**
+   to it in the issue **description**, in the **comments**, OR on **Discord**.
+1. If an issue on the subject **exists** and is labeled with `bug` OR (`enhancement` AND `greenlit`\* OR even `good first issue`\**):
+   1. If there is a pull request (**PR**) **linked** to it:
+      1. If the **PR** is **stale** (a few months without new commits or comments from the PR author OR Kysely maintainers),
+         **ask** to be **assigned** to it and continue work on the PR.
+      1. If the **PR** is **not stale**, you can still offer some review comments, or **ask** to **pair** up with the PR author.
+   1. If there is **no PR linked** to it and a person is **already assigned** to it:
+      1. If the assignment is stale (a few weeks without a PR opened after the person was assigned to the issue), ask
+         to be assigned to the issue in the comments OR on Discord.
+      1. If the assignment is not stale, it's OK to ask the assignee if they'll be willing to pair up.
+   1. If there is no PR linked to it and no assignee, ask to be assigned to it in the comments OR on Discord.
+   
+_\* an issue that was reviewed by the maintainers and would be nice to get a pull request for from the community._
+
+_\** an issue that was reviewed by the maintainers and would be a nice opportunity to onboard an open-source newbie
+  into the codebase._
+
+Once you're assigned to an issue, you can start working on your code changes. It's best to ask questions
+in the issue or on Discord as early as possible, and even share your progress with the maintainers and community via a 
+draft (WIP) pull request.
+
+#### Style/Design Philosophy
 
 * Kysely should have zero dependencies.
 
@@ -40,31 +138,31 @@ for all cases, are best left for consumers to implement.
 
 * Most features should have escape hatches.
 
-# Getting started
+#### Getting Started
 
 1. fork kysely.
 
-2. clone your fork.
+1. clone your fork.
 
-3. install node.js (preferable latest LTS).
+1. install node.js (preferably the latest even-numbered version).
 
-4. run `npm i` in your terminal to install dev dependencies.
+1. run `npm i` in your terminal to install dependencies.
 
-5. create a branch.
+1. create a branch (we don't care about naming).
 
-6. create a draft pull request. link the relevant issue by refering to it in the 
+1. create a draft pull request. link the relevant issue by referring to it in the 
 PR's description. E.g. `closes #123` will link the PR to issue/pull request #123.
 
-7. implement your changes.
+1. implement your changes.
 
-# Testing
+#### Testing
 
-1. write functionality tests in `test/node`.
+1. write functionality tests @ [/test/node](https://github.com/kysely-org/kysely/tree/master/test/node).
 
-2. write typings tests in `test/typings/test-d`
+1. write typings tests @ [/test/typings](https://github.com/kysely-org/kysely/tree/master/test/typings)
 
-3. install docker.
+1. install docker.
 
-4. run `docker-compose up` in your terminal to spin up database instances.
+1. run `docker compose up` in your terminal to spin up database instances.
 
-5. run `npm test` in your terminal to run tests.
+1. run `npm test` in another terminal to run tests.

package/FUNDING.md

@@ -0,0 +1,25 @@
+# Funding
+
+Kysely is an MIT-licensed open-source project and is completely free to use - and will remain so.
+
+Kysely is a labor of love. We do this in our free time.
+
+We do not accept donations.
+
+- Getting paid for open-source won't make us put more time and effort into open-source.
+  We have family, friends, and other hobbies and interests.
+
+- We work in the tech industry, full-time, as software developers. We are comfortable as-is.
+
+- We don't believe in freelance open-source as a stable source of income for the long term.
+  We have mouths to feed, and careers to maintain.
+
+- Sponsored projects tend to be affected by big sponsors. We want to keep Kysely away
+  from companies' and VCs' opinions and business needs.
+
+- Kysely is escapism for us. We don't want it to feel like another job.
+
+
+Instead of donating to us, we encourage you to support meaningful causes or other open-source projects in need of funding.
+
+Thank you for supporting Kysely through your usage, contributions, and feedback.

package/README.md

@@ -1,13 +1,24 @@
 [![Stand With Ukraine](https://raw.githubusercontent.com/vshymanskyy/StandWithUkraine/main/banner2-direct.svg)](https://stand-with-ukraine.pp.ua)
 
-[![Discord](https://img.shields.io/discord/890118421587578920?logo=discord&style=flat)](https://discord.gg/xyBJ3GwvAm)
+[![NPM Version](https://img.shields.io/npm/v/kysely?style=flat&label=latest)](https://github.com/kysely-org/kysely/releases/latest)
 [![Tests](https://github.com/kysely-org/kysely/actions/workflows/test.yml/badge.svg)](https://github.com/kysely-org/kysely)
 [![License](https://img.shields.io/github/license/kysely-org/kysely?style=flat)](https://github.com/kysely-org/kysely/blob/master/LICENSE)
 [![Issues](https://img.shields.io/github/issues-closed/kysely-org/kysely?logo=github)](https://github.com/kysely-org/kysely/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc)
 [![Pull Requests](https://img.shields.io/github/issues-pr-closed/kysely-org/kysely?label=PRs&logo=github&style=flat)](https://github.com/kysely-org/kysely/pulls?q=is%3Apr+is%3Aopen+sort%3Aupdated-desc)
+![GitHub contributors](https://img.shields.io/github/contributors/kysely-org/kysely)
 [![Downloads](https://img.shields.io/npm/dw/kysely?logo=npm)](https://www.npmjs.com/package/kysely)
 [![Bundle Size](https://img.shields.io/bundlephobia/minzip/kysely?label=size&logo=npm)](https://bundlephobia.com/package/kysely)
-[![Social](https://img.shields.io/twitter/follow/kysely_?style=social)](https://twitter.com/kysely_)
+
+###### Join the discussion ⠀⠀⠀⠀⠀⠀⠀ 
+[![Discord](https://img.shields.io/badge/Discord-%235865F2.svg?style=flat&logo=discord&logoColor=white)](https://discord.gg/xyBJ3GwvAm)
+[![Bluesky](https://img.shields.io/badge/Bluesky-0285FF?style=flat&logo=Bluesky&logoColor=white)](https://bsky.app/profile/kysely.dev)
+
+###### Get started
+[![Postgres](https://img.shields.io/badge/postgres-%23316192.svg?style=flat&logo=postgresql&logoColor=white)](https://kysely.dev/docs/getting-started?dialect=postgresql)
+[![MySQL](https://img.shields.io/badge/mysql-4479A1.svg?style=flat&logo=mysql&logoColor=white)](https://kysely.dev/docs/getting-started?dialect=mysql)
+[![MicrosoftSQLServer](https://img.shields.io/badge/Microsoft%20SQL%20Server-CC2927?style=flat&logo=microsoft%20sql%20server&logoColor=white)](https://kysely.dev/docs/getting-started?dialect=mssql)
+[![SQLite](https://img.shields.io/badge/sqlite-%2307405e.svg?style=flat&logo=sqlite&logoColor=white)](https://kysely.dev/docs/getting-started?dialect=sqlite)
+& more!
 
 # [Kysely](https://kysely.dev)
 

package/deno.check.d.ts

@@ -0,0 +1,86 @@
+import type {
+  ColumnType,
+  Generated,
+  GeneratedAlways,
+  Insertable,
+  Kysely,
+  Selectable,
+  SqlBool,
+  Updateable,
+} from './dist/esm'
+
+export interface Database {
+  person: PersonTable
+  pet: PetTable
+  toy: ToyTable
+  wine: WineTable
+  wine_stock_change: WineStockChangeTable
+}
+
+interface PersonTable {
+  id: Generated<number>
+  address: { city: string } | null
+  age: number | null
+  birthdate: ColumnType<Date | null, string | null | undefined, string | null>
+  created_at: GeneratedAlways<Date>
+  deleted_at: ColumnType<Date | null, string | null | undefined, string | null>
+  experience: { role: string }[] | null
+  first_name: string
+  gender: 'male' | 'female' | 'other' | null
+  has_pets: Generated<'Y' | 'N'>
+  last_name: string | null
+  middle_name: string | null
+  nicknames: string[] | null
+  nullable_column: string | null
+  profile: {
+    addresses: { city: string }[]
+    website: { url: string }
+  } | null
+  updated_at: ColumnType<Date | null, string | null | undefined, string | null>
+  marital_status: 'single' | 'married' | 'divorced' | 'widowed' | null
+}
+
+interface PetTable {
+  id: Generated<number>
+  created_at: GeneratedAlways<Date>
+  is_favorite: Generated<SqlBool>
+  name: string
+  owner_id: number
+  species: Species
+}
+
+interface ToyTable {
+  id: Generated<number>
+  pet_id: number
+  price: number
+}
+
+interface WineTable {
+  name: string
+  stock: number
+}
+
+interface WineStockChangeTable {
+  stock_delta: number
+  wine_name: string
+}
+
+export type Person = Selectable<PersonTable>
+export type NewPerson = Insertable<PersonTable>
+export type PersonUpdate = Updateable<PersonTable>
+export type Pet = Selectable<PetTable>
+export type NewPet = Insertable<PetTable>
+export type PetUpdate = Updateable<PetTable>
+export type Species = 'dog' | 'cat' | 'hamster'
+
+declare global {
+  // @ts-ignore
+  export class Buffer {
+    static isBuffer(obj: unknown): obj is { length: number }
+    static compare(a: Buffer, b: Buffer): number
+  }
+  export const db: Kysely<Database>
+  export function functionThatExpectsPersonWithNonNullValue(
+    person: Person & { nullable_column: string },
+  ): void
+}

package/deno.check.json

@@ -0,0 +1,21 @@
+{
+  "$schema": "https://deno.land/x/deno/cli/schemas/config-file.v1.json",
+  "compilerOptions": {
+    "types": ["./deno.check.d.ts"]
+  },
+  "imports": {
+    "better-sqlite3": "npm:better-sqlite3",
+    "kysely": "./dist/esm",
+    "kysely/helpers/mssql": "./dist/esm/helpers/mssql.js",
+    "kysely/helpers/mysql": "./dist/esm/helpers/mysql.js",
+    "kysely/helpers/postgres": "./dist/esm/helpers/postgres.js",
+    "kysely/helpers/sqlite": "./dist/esm/helpers/sqlite.js",
+    "lodash/snakeCase": "npm:lodash/snakeCase",
+    "mysql2": "npm:mysql2",
+    "pg": "npm:pg",
+    "pg-cursor": "npm:pg-cursor",
+    "tarn": "npm:tarn",
+    "tedious": "npm:tedious",
+    "type-editor": "./deno.check.d.ts"
+  }
+}

package/dist/cjs/dialect/dialect-adapter-base.d.ts

@@ -47,8 +47,13 @@ export declare abstract class DialectAdapterBase implements DialectAdapter {
      * have explicit locks but supports `FOR UPDATE` row locks and transactional DDL:
      *
      * ```ts
-     * {
-     *   async acquireMigrationLock(db, options): Promise<void> {
+     * import { DialectAdapterBase, type MigrationLockOptions, Kysely } from 'kysely'
+     *
+     * export class MyAdapter extends DialectAdapterBase {
+     *   override async acquireMigrationLock(
+     *     db: Kysely<any>,
+     *     options: MigrationLockOptions
+     *   ): Promise<void> {
      *     const queryDb = options.lockTableSchema
      *       ? db.withSchema(options.lockTableSchema)
      *       : db
@@ -64,6 +69,10 @@ export declare abstract class DialectAdapterBase implements DialectAdapter {
      *       .forUpdate()
      *       .execute()
      *   }
+     *
+     *   override async releaseMigrationLock() {
+     *     // noop
+     *   }
      * }
      * ```
      *

package/dist/cjs/dialect/dialect-adapter.d.ts

@@ -52,8 +52,13 @@ export interface DialectAdapter {
      * have explicit locks but supports `FOR UPDATE` row locks and transactional DDL:
      *
      * ```ts
-     * {
-     *   async acquireMigrationLock(db, options): Promise<void> {
+     * import { DialectAdapterBase, type MigrationLockOptions, Kysely } from 'kysely'
+     *
+     * export class MyAdapter extends DialectAdapterBase {
+     *   override async acquireMigrationLock(
+     *     db: Kysely<any>,
+     *     options: MigrationLockOptions
+     *   ): Promise<void> {
      *     const queryDb = options.lockTableSchema
      *       ? db.withSchema(options.lockTableSchema)
      *       : db
@@ -69,6 +74,10 @@ export interface DialectAdapter {
      *       .forUpdate()
      *       .execute()
      *   }
+     *
+     *   override async releaseMigrationLock() {
+     *     // noop
+     *   }
      * }
      * ```
      *

package/dist/cjs/dialect/mssql/mssql-adapter.d.ts

@@ -36,8 +36,13 @@ export declare class MssqlAdapter extends DialectAdapterBase {
      * have explicit locks but supports `FOR UPDATE` row locks and transactional DDL:
      *
      * ```ts
-     * {
-     *   async acquireMigrationLock(db, options): Promise<void> {
+     * import { DialectAdapterBase, type MigrationLockOptions, Kysely } from 'kysely'
+     *
+     * export class MyAdapter extends DialectAdapterBase {
+     *   override async acquireMigrationLock(
+     *     db: Kysely<any>,
+     *     options: MigrationLockOptions
+     *   ): Promise<void> {
      *     const queryDb = options.lockTableSchema
      *       ? db.withSchema(options.lockTableSchema)
      *       : db
@@ -53,6 +58,10 @@ export declare class MssqlAdapter extends DialectAdapterBase {
      *       .forUpdate()
      *       .execute()
      *   }
+     *
+     *   override async releaseMigrationLock() {
+     *     // noop
+     *   }
      * }
      * ```
      *