kysely 0.12.0 → 0.14.0

package/dist/cjs/schema/column-definition-builder.d.ts

@@ -66,6 +66,12 @@ export interface ColumnDefinitionBuilderInterface {
      * Adds a `not null` constraint for the column.
      */
     notNull(): ColumnDefinitionBuilderInterface;
+    /**
+     * Adds a `unsigned` modifier for the column.
+     *
+     * This only works on some dialects like MySQL.
+     */
+    unsigned(): ColumnDefinitionBuilderInterface;
     /**
      * Adds a default value constraint for the column.
      *
@@ -87,11 +93,13 @@ export interface ColumnDefinitionBuilderInterface {
      * ```ts
      * db.schema
      *   .createTable('pet')
-     *   .addColumn('number_of_legs', 'integer', (col) => col.check('number_of_legs < 5'))
+     *   .addColumn('number_of_legs', 'integer', (col) =>
+     *     col.check(db.raw('number_of_legs < 5'))
+     *   )
      *   .execute()
      * ```
      */
-    check(sql: string): ColumnDefinitionBuilderInterface;
+    check(expression: AnyRawBuilder): ColumnDefinitionBuilderInterface;
     /**
      * Makes the column a generated column using a `generated always as` statement.
      *
@@ -101,12 +109,20 @@ export interface ColumnDefinitionBuilderInterface {
      * db.schema
      *   .createTable('person')
      *   .addColumn('full_name', 'varchar(255)',
-     *     (col) => col.generatedAlwaysAs("concat(first_name, ' ', last_name)")
+     *     (col) => col.generatedAlwaysAs(db.raw("concat(first_name, ' ', last_name)"))
      *   )
      *   .execute()
      * ```
      */
-    generatedAlwaysAs(sql: string): ColumnDefinitionBuilderInterface;
+    generatedAlwaysAs(expression: AnyRawBuilder): ColumnDefinitionBuilderInterface;
+    /**
+     * Adds the `generated always as identity` specifier on supported dialects.
+     */
+    generatedAlwaysAsIdentity(): ColumnDefinitionBuilderInterface;
+    /**
+     * Adds the `generated by default as identity` specifier on supported dialects.
+     */
+    generatedByDefaultAsIdentity(): ColumnDefinitionBuilderInterface;
     /**
      * Makes a generated column stored instead of virtual. This method can only
      * be used with {@link generatedAlwaysAs}
@@ -128,16 +144,140 @@ export interface ColumnDefinitionBuilderInterface {
 export declare class ColumnDefinitionBuilder implements ColumnDefinitionBuilderInterface, OperationNodeSource {
     #private;
     constructor(node: ColumnDefinitionNode);
+    /**
+     * Adds `auto_increment` or `autoincrement` to the column definition
+     * depending on the dialect.
+     *
+     * Some dialects like PostgreSQL don't support this. On PostgreSQL
+     * you can use the `serial` or `bigserial` data type instead.
+     */
     autoIncrement(): ColumnDefinitionBuilder;
+    /**
+     * Makes the column the primary key.
+     *
+     * If you want to specify a composite primary key use the
+     * {@link TableBuilder.addPrimaryKeyConstraint} method.
+     */
     primaryKey(): ColumnDefinitionBuilder;
+    /**
+     * Adds a foreign key constraint for the column.
+     *
+     * If your database engine doesn't support foreign key constraints in the
+     * column definition (like MySQL 5) you need to call the table level
+     * {@link TableBuilder.addForeignKeyConstraint} method instead.
+     *
+     * ### Examples
+     *
+     * ```ts
+     * col.references('person.id')
+     * ```
+     */
     references(ref: string): ColumnDefinitionBuilder;
+    /**
+     * Adds an `on delete` constraint for the foreign key column.
+     *
+     * If your database engine doesn't support foreign key constraints in the
+     * column definition (like MySQL 5) you need to call the table level
+     * {@link TableBuilder.addForeignKeyConstraint} method instead.
+     *
+     * ### Examples
+     *
+     * ```ts
+     * col.references('person.id').onDelete('cascade')
+     * ```
+     */
     onDelete(onDelete: OnModifyForeignAction): ColumnDefinitionBuilder;
+    /**
+     * Adds an `on update` constraint for the foreign key column.
+     *
+     * ### Examples
+     *
+     * ```ts
+     * col.references('person.id').onUpdate('cascade')
+     * ```
+     */
     onUpdate(onUpdate: OnModifyForeignAction): ColumnDefinitionBuilder;
+    /**
+     * Adds a unique constraint for the column.
+     */
     unique(): ColumnDefinitionBuilder;
+    /**
+     * Adds a `not null` constraint for the column.
+     */
     notNull(): ColumnDefinitionBuilder;
+    /**
+     * Adds a `unsigned` modifier for the column.
+     *
+     * This only works on some dialects like MySQL.
+     */
+    unsigned(): ColumnDefinitionBuilder;
+    /**
+     * Adds a default value constraint for the column.
+     *
+     * ### Examples
+     *
+     * ```ts
+     * db.schema
+     *   .createTable('pet')
+     *   .addColumn('number_of_legs', 'integer', (col) => col.defaultTo(4))
+     *   .execute()
+     * ```
+     */
     defaultTo(value: DefaultValueExpression): ColumnDefinitionBuilder;
-    check(sql: string): ColumnDefinitionBuilder;
-    generatedAlwaysAs(sql: string): ColumnDefinitionBuilder;
+    /**
+     * Adds a check constraint for the column.
+     *
+     * ### Examples
+     *
+     * ```ts
+     * db.schema
+     *   .createTable('pet')
+     *   .addColumn('number_of_legs', 'integer', (col) =>
+     *     col.check(db.raw('number_of_legs < 5'))
+     *   )
+     *   .execute()
+     * ```
+     */
+    check(expression: AnyRawBuilder): ColumnDefinitionBuilder;
+    /**
+     * Makes the column a generated column using a `generated always as` statement.
+     *
+     * ### Examples
+     *
+     * ```ts
+     * db.schema
+     *   .createTable('person')
+     *   .addColumn('full_name', 'varchar(255)',
+     *     (col) => col.generatedAlwaysAs(db.raw("concat(first_name, ' ', last_name)"))
+     *   )
+     *   .execute()
+     * ```
+     */
+    generatedAlwaysAs(expression: AnyRawBuilder): ColumnDefinitionBuilder;
+    /**
+     * Adds the `generated always as identity` specifier on supported dialects.
+     */
+    generatedAlwaysAsIdentity(): ColumnDefinitionBuilder;
+    /**
+     * Adds the `generated by default as identity` specifier on supported dialects.
+     */
+    generatedByDefaultAsIdentity(): ColumnDefinitionBuilder;
+    /**
+     * Makes a generated column stored instead of virtual. This method can only
+     * be used with {@link generatedAlwaysAs}
+     *
+     * ### Examples
+     *
+     * ```ts
+     * db.schema
+     *   .createTable('person')
+     *   .addColumn('full_name', 'varchar(255)', (col) => col
+     *     .generatedAlwaysAs("concat(first_name, ' ', last_name)")
+     *     .stored()
+     *   )
+     *   .execute()
+     * ```
+     */
     stored(): ColumnDefinitionBuilder;
     toOperationNode(): ColumnDefinitionNode;
 }

package/dist/cjs/schema/column-definition-builder.js

@@ -9,7 +9,7 @@ const reference_parser_js_1 = require("../parser/reference-parser.js");
 const prevent_await_js_1 = require("../util/prevent-await.js");
 const column_definition_node_js_1 = require("../operation-node/column-definition-node.js");
 const default_value_parser_js_1 = require("../parser/default-value-parser.js");
-const generated_always_as_node_js_1 = require("../operation-node/generated-always-as-node.js");
+const generated_node_js_1 = require("../operation-node/generated-node.js");
 const default_value_node_js_1 = require("../operation-node/default-value-node.js");
 class ColumnDefinitionBuilder {
     #node;
@@ -53,29 +53,42 @@ class ColumnDefinitionBuilder {
         return new ColumnDefinitionBuilder(column_definition_node_js_1.ColumnDefinitionNode.cloneWith(this.#node, { unique: true }));
     }
     notNull() {
-        return new ColumnDefinitionBuilder(column_definition_node_js_1.ColumnDefinitionNode.cloneWith(this.#node, { nullable: false }));
+        return new ColumnDefinitionBuilder(column_definition_node_js_1.ColumnDefinitionNode.cloneWith(this.#node, { notNull: true }));
+    }
+    unsigned() {
+        return new ColumnDefinitionBuilder(column_definition_node_js_1.ColumnDefinitionNode.cloneWith(this.#node, { unsigned: true }));
     }
     defaultTo(value) {
         return new ColumnDefinitionBuilder(column_definition_node_js_1.ColumnDefinitionNode.cloneWith(this.#node, {
             defaultTo: default_value_node_js_1.DefaultValueNode.create((0, default_value_parser_js_1.parseDefaultValueExpression)(value)),
         }));
     }
-    check(sql) {
+    check(expression) {
+        return new ColumnDefinitionBuilder(column_definition_node_js_1.ColumnDefinitionNode.cloneWith(this.#node, {
+            check: check_constraint_node_js_1.CheckConstraintNode.create(expression.toOperationNode()),
+        }));
+    }
+    generatedAlwaysAs(expression) {
+        return new ColumnDefinitionBuilder(column_definition_node_js_1.ColumnDefinitionNode.cloneWith(this.#node, {
+            generated: generated_node_js_1.GeneratedNode.createWithExpression(expression.toOperationNode()),
+        }));
+    }
+    generatedAlwaysAsIdentity() {
         return new ColumnDefinitionBuilder(column_definition_node_js_1.ColumnDefinitionNode.cloneWith(this.#node, {
-            check: check_constraint_node_js_1.CheckConstraintNode.create(sql),
+            generated: generated_node_js_1.GeneratedNode.create({ identity: true, always: true }),
         }));
     }
-    generatedAlwaysAs(sql) {
+    generatedByDefaultAsIdentity() {
         return new ColumnDefinitionBuilder(column_definition_node_js_1.ColumnDefinitionNode.cloneWith(this.#node, {
-            generatedAlwaysAs: generated_always_as_node_js_1.GeneratedAlwaysAsNode.create(sql),
+            generated: generated_node_js_1.GeneratedNode.create({ identity: true, byDefault: true }),
         }));
     }
     stored() {
-        if (!this.#node.generatedAlwaysAs) {
+        if (!this.#node.generated) {
             throw new Error('stored() can only be called after generatedAlwaysAs');
         }
         return new ColumnDefinitionBuilder(column_definition_node_js_1.ColumnDefinitionNode.cloneWith(this.#node, {
-            generatedAlwaysAs: generated_always_as_node_js_1.GeneratedAlwaysAsNode.cloneWith(this.#node.generatedAlwaysAs, {
+            generated: generated_node_js_1.GeneratedNode.cloneWith(this.#node.generated, {
                 stored: true,
             }),
         }));

package/dist/cjs/schema/create-index-builder.d.ts

@@ -4,6 +4,7 @@ import { CompiledQuery } from '../query-compiler/compiled-query.js';
 import { Compilable } from '../util/compilable.js';
 import { QueryExecutor } from '../query-executor/query-executor.js';
 import { QueryId } from '../util/query-id.js';
+import { AnyRawBuilder } from '../util/type-utils.js';
 export declare class CreateIndexBuilder implements OperationNodeSource, Compilable {
     #private;
     constructor(props: CreateIndexBuilderProps);
@@ -36,11 +37,11 @@ export declare class CreateIndexBuilder implements OperationNodeSource, Compilab
      * await db.schema
      *   .createIndex('person_first_name_index')
      *   .on('person')
-     *   .expression('first_name COLLATE "fi_FI"')
+     *   .expression(db.raw('first_name COLLATE "fi_FI"'))
      *   .execute()
      * ```
      */
-    expression(expression: string): CreateIndexBuilder;
+    expression(expression: AnyRawBuilder): CreateIndexBuilder;
     /**
      * Specifies the index type.
      */

package/dist/cjs/schema/create-index-builder.js

@@ -70,7 +70,7 @@ class CreateIndexBuilder {
      * await db.schema
      *   .createIndex('person_first_name_index')
      *   .on('person')
-     *   .expression('first_name COLLATE "fi_FI"')
+     *   .expression(db.raw('first_name COLLATE "fi_FI"'))
      *   .execute()
      * ```
      */
@@ -78,7 +78,7 @@ class CreateIndexBuilder {
         return new CreateIndexBuilder({
             ...this.#props,
             createIndexNode: create_index_node_js_1.CreateIndexNode.cloneWith(this.#props.createIndexNode, {
-                expression: raw_node_js_1.RawNode.createWithSql(expression),
+                expression: expression.toOperationNode(),
             }),
         });
     }

package/dist/cjs/schema/create-table-builder.d.ts

@@ -7,6 +7,7 @@ import { ColumnDefinitionBuilder } from './column-definition-builder.js';
 import { QueryId } from '../util/query-id.js';
 import { ForeignKeyConstraintBuilder } from './foreign-key-constraint-builder.js';
 import { DataTypeExpression } from '../parser/data-type-parser.js';
+import { AnyRawBuilder } from '../util/type-utils.js';
 /**
  * This builder can be used to create a `create table` query.
  */
@@ -110,10 +111,10 @@ export declare class CreateTableBuilder<TB extends string, C extends string = ne
      * ### Examples
      *
      * ```ts
-     * addCheckConstraint('check_legs', 'number_of_legs < 5')
+     * addCheckConstraint('check_legs', db.raw('number_of_legs < 5'))
      * ```
      */
-    addCheckConstraint(constraintName: string, checkExpression: string): CreateTableBuilder<TB, C>;
+    addCheckConstraint(constraintName: string, checkExpression: AnyRawBuilder): CreateTableBuilder<TB, C>;
     /**
      * Adds a foreign key constraint.
      *

package/dist/cjs/schema/create-table-builder.js

@@ -156,13 +156,13 @@ class CreateTableBuilder {
      * ### Examples
      *
      * ```ts
-     * addCheckConstraint('check_legs', 'number_of_legs < 5')
+     * addCheckConstraint('check_legs', db.raw('number_of_legs < 5'))
      * ```
      */
     addCheckConstraint(constraintName, checkExpression) {
         return new CreateTableBuilder({
             ...this.#props,
-            createTableNode: create_table_node_js_1.CreateTableNode.cloneWithConstraint(this.#props.createTableNode, check_constraint_node_js_1.CheckConstraintNode.create(checkExpression, constraintName)),
+            createTableNode: create_table_node_js_1.CreateTableNode.cloneWithConstraint(this.#props.createTableNode, check_constraint_node_js_1.CheckConstraintNode.create(checkExpression.toOperationNode(), constraintName)),
         });
     }
     /**

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

@@ -7,8 +7,44 @@ import { DialectAdapter } from './dialect-adapter.js';
  * they are added and there will be less breaking changes.
  */
 export declare abstract class DialectAdapterBase implements DialectAdapter {
+    /**
+     * Whether or not this dialect supports transactional DDL.
+     *
+     * If this is true, migrations are executed inside a transaction.
+     */
     get supportsTransactionalDdl(): boolean;
+    /**
+     * Whether or not this dialect supports the `returning` in inserts
+     * updates and deletes.
+     */
     get supportsReturning(): boolean;
+    /**
+     * This method is used to acquire a lock for the migrations so that
+     * it's not possible for two migration processes to run in parallel.
+     *
+     * Most dialects have explicit locks that can be used, like advisory locks
+     * in PostgreSQL and the get_lock function in MySQL.
+     *
+     * If the dialect doesn't have explicit locks the {@link MIGRATION_LOCK_TABLE}
+     * created by Kysely can be used instead. {@link MIGRATION_LOCK_TABLE}
+     * has two columns `id` and `is_locked` and there's only one row in the
+     * table whose id is {@link MIGRATION_LOCK_ID}. `is_locked` is an integer.
+     * Kysely takes care of creating the lock table and inserting the one single
+     * row to it before this method is executed.
+     *
+     * If `supportsTransactionalDdl` is `true` then the `db` passed to this method
+     * is a transaction inside which the migrations will be executed. Otherwise
+     * `db` is a single connection (session) that will be used to execute the
+     * migrations.
+     */
     abstract acquireMigrationLock(db: Kysely<any>): Promise<void>;
+    /**
+     * Releases the migration lock. See {@link acquireMigrationLock}.
+     *
+     * If `supportsTransactionalDdl` is `true` then the `db` passed to this method
+     * is a transaction inside which the migrations were executed. Otherwise `db`
+     * is a single connection (session) that was used to execute the migrations
+     * and the `acquireMigrationLock` call.
+     */
     abstract releaseMigrationLock(db: Kysely<any>): Promise<void>;
 }

package/dist/esm/dialect/dialect.d.ts

@@ -1,7 +1,7 @@
 import { Driver } from '../driver/driver.js';
 import { Kysely } from '../kysely.js';
 import { QueryCompiler } from '../query-compiler/query-compiler.js';
-import { DatabaseIntrospector } from '../introspection/database-introspector.js';
+import { DatabaseIntrospector } from './database-introspector.js';
 import { DialectAdapter } from './dialect-adapter.js';
 /**
  * A Dialect is the glue between Kysely and the underlying database engine.

package/dist/esm/dialect/mysql/mysql-adapter.d.ts

@@ -1,8 +1,44 @@
 import { Kysely } from '../../kysely.js';
-import { DialectAdapter } from '../dialect-adapter.js';
-export declare class MysqlAdapter implements DialectAdapter {
+import { DialectAdapterBase } from '../dialect-adapter-base.js';
+export declare class MysqlAdapter extends DialectAdapterBase {
+    /**
+     * Whether or not this dialect supports transactional DDL.
+     *
+     * If this is true, migrations are executed inside a transaction.
+     */
     get supportsTransactionalDdl(): boolean;
+    /**
+     * Whether or not this dialect supports the `returning` in inserts
+     * updates and deletes.
+     */
     get supportsReturning(): boolean;
+    /**
+     * This method is used to acquire a lock for the migrations so that
+     * it's not possible for two migration processes to run in parallel.
+     *
+     * Most dialects have explicit locks that can be used, like advisory locks
+     * in PostgreSQL and the get_lock function in MySQL.
+     *
+     * If the dialect doesn't have explicit locks the {@link MIGRATION_LOCK_TABLE}
+     * created by Kysely can be used instead. {@link MIGRATION_LOCK_TABLE}
+     * has two columns `id` and `is_locked` and there's only one row in the
+     * table whose id is {@link MIGRATION_LOCK_ID}. `is_locked` is an integer.
+     * Kysely takes care of creating the lock table and inserting the one single
+     * row to it before this method is executed.
+     *
+     * If `supportsTransactionalDdl` is `true` then the `db` passed to this method
+     * is a transaction inside which the migrations will be executed. Otherwise
+     * `db` is a single connection (session) that will be used to execute the
+     * migrations.
+     */
     acquireMigrationLock(db: Kysely<any>): Promise<void>;
+    /**
+     * Releases the migration lock. See {@link acquireMigrationLock}.
+     *
+     * If `supportsTransactionalDdl` is `true` then the `db` passed to this method
+     * is a transaction inside which the migrations were executed. Otherwise `db`
+     * is a single connection (session) that was used to execute the migrations
+     * and the `acquireMigrationLock` call.
+     */
     releaseMigrationLock(db: Kysely<any>): Promise<void>;
 }

package/dist/esm/dialect/mysql/mysql-adapter.js

@@ -1,6 +1,7 @@
+import { DialectAdapterBase } from '../dialect-adapter-base.js';
 const LOCK_ID = 'ea586330-2c93-47c8-908d-981d9d270f9d';
 const LOCK_TIMEOUT_SECONDS = 60 * 60;
-export class MysqlAdapter {
+export class MysqlAdapter extends DialectAdapterBase {
     get supportsTransactionalDdl() {
         return false;
     }

package/dist/esm/dialect/mysql/mysql-dialect.d.ts

@@ -2,7 +2,7 @@ import { Driver } from '../../driver/driver.js';
 import { Kysely } from '../../kysely.js';
 import { QueryCompiler } from '../../query-compiler/query-compiler.js';
 import { Dialect } from '../dialect.js';
-import { DatabaseIntrospector } from '../../introspection/database-introspector.js';
+import { DatabaseIntrospector } from '../database-introspector.js';
 import { DialectAdapter } from '../dialect-adapter.js';
 import { DatabaseConnection } from '../../driver/database-connection.js';
 /**
@@ -15,9 +15,25 @@ import { DatabaseConnection } from '../../driver/database-connection.js';
 export declare class MysqlDialect implements Dialect {
     #private;
     constructor(config: MysqlDialectConfig);
+    /**
+     * Creates a driver for the dialect.
+     */
     createDriver(): Driver;
+    /**
+     * Creates a query compiler for the dialect.
+     */
     createQueryCompiler(): QueryCompiler;
+    /**
+     * Creates an adapter for the dialect.
+     */
     createAdapter(): DialectAdapter;
+    /**
+     * Creates a database introspector that can be used to get the database metadata
+     * such as the tables and columns that exist in the database.
+     *
+     * `db` never has any plugins installed. It's created using
+     * {@link Kysely.withoutPlugins}.
+     */
     createIntrospector(db: Kysely<any>): DatabaseIntrospector;
 }
 /**

package/dist/esm/dialect/mysql/mysql-driver.d.ts

@@ -4,11 +4,40 @@ import { MysqlDialectConfig } from './mysql-dialect.js';
 export declare class MysqlDriver implements Driver {
     #private;
     constructor(config: MysqlDialectConfig);
+    /**
+     * Initializes the driver.
+     *
+     * After calling this method the driver should be usable and `acquireConnection` etc.
+     * methods should be callable.
+     *
+     * IMPORTANT: The underlying database engine driver (like [pg](https://node-postgres.com/))
+     * should be imported inside this function, not at the top of the driver file! This is
+     * important so that Kysely is usable without installing all database driver libraries
+     * it supports.
+     */
     init(): Promise<void>;
+    /**
+     * Acquires a new connection from the pool.
+     */
     acquireConnection(): Promise<DatabaseConnection>;
+    /**
+     * Begins a transaction.
+     */
     beginTransaction(connection: DatabaseConnection, settings: TransactionSettings): Promise<void>;
+    /**
+     * Commits a transaction.
+     */
     commitTransaction(connection: DatabaseConnection): Promise<void>;
+    /**
+     * Rolls back a transaction.
+     */
     rollbackTransaction(connection: DatabaseConnection): Promise<void>;
+    /**
+     * Releases a connection back to the pool.
+     */
     releaseConnection(connection: DatabaseConnection): Promise<void>;
+    /**
+     * Destroys the driver and releases all resources.
+     */
     destroy(): Promise<void>;
 }

package/dist/esm/dialect/mysql/mysql-introspector.d.ts

@@ -1,7 +1,10 @@
-import { DatabaseIntrospector, DatabaseMetadata, DatabaseMetadataOptions } from '../../introspection/database-introspector.js';
+import { DatabaseIntrospector, DatabaseMetadata, DatabaseMetadataOptions } from '../database-introspector.js';
 import { Kysely } from '../../kysely.js';
 export declare class MysqlIntrospector implements DatabaseIntrospector {
     #private;
     constructor(db: Kysely<any>);
+    /**
+     * Get the database metadata such as the names of the tables and columns.
+     */
     getMetadata(options?: DatabaseMetadataOptions): Promise<DatabaseMetadata>;
 }

package/dist/esm/dialect/postgres/postgres-adapter.d.ts

@@ -1,8 +1,44 @@
 import { Kysely } from '../../kysely.js';
-import { DialectAdapter } from '../dialect-adapter.js';
-export declare class PostgresAdapter implements DialectAdapter {
+import { DialectAdapterBase } from '../dialect-adapter-base.js';
+export declare class PostgresAdapter extends DialectAdapterBase {
+    /**
+     * Whether or not this dialect supports transactional DDL.
+     *
+     * If this is true, migrations are executed inside a transaction.
+     */
     get supportsTransactionalDdl(): boolean;
+    /**
+     * Whether or not this dialect supports the `returning` in inserts
+     * updates and deletes.
+     */
     get supportsReturning(): boolean;
+    /**
+     * This method is used to acquire a lock for the migrations so that
+     * it's not possible for two migration processes to run in parallel.
+     *
+     * Most dialects have explicit locks that can be used, like advisory locks
+     * in PostgreSQL and the get_lock function in MySQL.
+     *
+     * If the dialect doesn't have explicit locks the {@link MIGRATION_LOCK_TABLE}
+     * created by Kysely can be used instead. {@link MIGRATION_LOCK_TABLE}
+     * has two columns `id` and `is_locked` and there's only one row in the
+     * table whose id is {@link MIGRATION_LOCK_ID}. `is_locked` is an integer.
+     * Kysely takes care of creating the lock table and inserting the one single
+     * row to it before this method is executed.
+     *
+     * If `supportsTransactionalDdl` is `true` then the `db` passed to this method
+     * is a transaction inside which the migrations will be executed. Otherwise
+     * `db` is a single connection (session) that will be used to execute the
+     * migrations.
+     */
     acquireMigrationLock(db: Kysely<any>): Promise<void>;
+    /**
+     * Releases the migration lock. See {@link acquireMigrationLock}.
+     *
+     * If `supportsTransactionalDdl` is `true` then the `db` passed to this method
+     * is a transaction inside which the migrations were executed. Otherwise `db`
+     * is a single connection (session) that was used to execute the migrations
+     * and the `acquireMigrationLock` call.
+     */
     releaseMigrationLock(): Promise<void>;
 }

package/dist/esm/dialect/postgres/postgres-adapter.js

@@ -1,6 +1,7 @@
+import { DialectAdapterBase } from '../dialect-adapter-base.js';
 // Random id for our transaction lock.
 const LOCK_ID = '3853314791062309107';
-export class PostgresAdapter {
+export class PostgresAdapter extends DialectAdapterBase {
     get supportsTransactionalDdl() {
         return true;
     }

package/dist/esm/dialect/postgres/postgres-dialect.d.ts

@@ -5,7 +5,7 @@ import { Driver } from '../../driver/driver.js';
 import { Kysely } from '../../kysely.js';
 import { QueryCompiler } from '../../query-compiler/query-compiler.js';
 import { Dialect } from '../dialect.js';
-import { DatabaseIntrospector } from '../../introspection/database-introspector.js';
+import { DatabaseIntrospector } from '../database-introspector.js';
 import { DialectAdapter } from '../dialect-adapter.js';
 import { DatabaseConnection } from '../../driver/database-connection.js';
 /**
@@ -21,9 +21,25 @@ import { DatabaseConnection } from '../../driver/database-connection.js';
 export declare class PostgresDialect implements Dialect {
     #private;
     constructor(config: PostgresDialectConfig);
+    /**
+     * Creates a driver for the dialect.
+     */
     createDriver(): Driver;
+    /**
+     * Creates a query compiler for the dialect.
+     */
     createQueryCompiler(): QueryCompiler;
+    /**
+     * Creates an adapter for the dialect.
+     */
     createAdapter(): DialectAdapter;
+    /**
+     * Creates a database introspector that can be used to get the database metadata
+     * such as the tables and columns that exist in the database.
+     *
+     * `db` never has any plugins installed. It's created using
+     * {@link Kysely.withoutPlugins}.
+     */
     createIntrospector(db: Kysely<any>): DatabaseIntrospector;
 }
 /**