kysely 0.27.4 → 0.27.5

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

@@ -12,6 +12,23 @@ export declare class ColumnDefinitionBuilder implements OperationNodeSource {
      *
      * Some dialects like PostgreSQL don't support this. On PostgreSQL
      * you can use the `serial` or `bigserial` data type instead.
+     *
+     * ### Examples
+     *
+     * ```ts
+     * await db.schema
+     *   .createTable('person')
+     *   .addColumn('id', 'integer', col => col.autoIncrement().primaryKey())
+     *   .execute()
+     * ```
+     *
+     * The generated SQL (MySQL):
+     *
+     * ```sql
+     * create table `person` (
+     *   `id` integer primary key auto_increment
+     * )
+     * ```
      */
     autoIncrement(): ColumnDefinitionBuilder;
     /**
@@ -20,6 +37,23 @@ export declare class ColumnDefinitionBuilder implements OperationNodeSource {
      * This only works on some dialects like MS SQL Server (MSSQL).
      *
      * For PostgreSQL's `generated always as identity` use {@link generatedAlwaysAsIdentity}.
+     *
+     * ### Examples
+     *
+     * ```ts
+     * await db.schema
+     *   .createTable('person')
+     *   .addColumn('id', 'integer', col => col.identity().primaryKey())
+     *   .execute()
+     * ```
+     *
+     * The generated SQL (MSSQL):
+     *
+     * ```sql
+     * create table "person" (
+     *   "id" integer identity primary key
+     * )
+     * ```
      */
     identity(): ColumnDefinitionBuilder;
     /**
@@ -27,6 +61,22 @@ export declare class ColumnDefinitionBuilder implements OperationNodeSource {
      *
      * If you want to specify a composite primary key use the
      * {@link CreateTableBuilder.addPrimaryKeyConstraint} method.
+     *
+     * ### Examples
+     *
+     * ```ts
+     * await db.schema
+     *   .createTable('person')
+     *   .addColumn('id', 'integer', col => col.primaryKey())
+     *   .execute()
+     * ```
+     *
+     * The generated SQL (MySQL):
+     *
+     * ```sql
+     * create table `person` (
+     *   `id` integer primary key
+     * )
      */
     primaryKey(): ColumnDefinitionBuilder;
     /**
@@ -39,7 +89,18 @@ export declare class ColumnDefinitionBuilder implements OperationNodeSource {
      * ### Examples
      *
      * ```ts
-     * col.references('person.id')
+     * await db.schema
+     *   .createTable('pet')
+     *   .addColumn('owner_id', 'integer', (col) => col.references('person.id'))
+     *   .execute()
+     * ```
+     *
+     * The generated SQL (PostgreSQL):
+     *
+     * ```sql
+     * create table "pet" (
+     *   "owner_id" integer references "person" ("id")
+     * )
      * ```
      */
     references(ref: string): ColumnDefinitionBuilder;
@@ -53,32 +114,117 @@ export declare class ColumnDefinitionBuilder implements OperationNodeSource {
      * ### Examples
      *
      * ```ts
-     * col.references('person.id').onDelete('cascade')
+     * await db.schema
+     *   .createTable('pet')
+     *   .addColumn(
+     *     'owner_id',
+     *     'integer',
+     *     (col) => col.references('person.id').onDelete('cascade')
+     *   )
+     *   .execute()
+     * ```
+     *
+     * The generated SQL (PostgreSQL):
+     *
+     * ```sql
+     * create table "pet" (
+     *   "owner_id" integer references "person" ("id") on delete cascade
+     * )
      * ```
      */
     onDelete(onDelete: OnModifyForeignAction): ColumnDefinitionBuilder;
     /**
      * Adds an `on update` 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 CreateTableBuilder.addForeignKeyConstraint} method instead.
+     *
      * ### Examples
      *
      * ```ts
-     * col.references('person.id').onUpdate('cascade')
+     * await db.schema
+     *   .createTable('pet')
+     *   .addColumn(
+     *     'owner_id',
+     *     'integer',
+     *     (col) => col.references('person.id').onUpdate('cascade')
+     *   )
+     *   .execute()
+     * ```
+     *
+     * The generated SQL (PostgreSQL):
+     *
+     * ```sql
+     * create table "pet" (
+     *   "owner_id" integer references "person" ("id") on update cascade
+     * )
      * ```
      */
     onUpdate(onUpdate: OnModifyForeignAction): ColumnDefinitionBuilder;
     /**
      * Adds a unique constraint for the column.
+     *
+     * ### Examples
+     *
+     * ```ts
+     * await db.schema
+     *   .createTable('person')
+     *   .addColumn('email', 'varchar(255)', col => col.unique())
+     *   .execute()
+     * ```
+     *
+     * The generated SQL (MySQL):
+     *
+     * ```sql
+     * create table `person` (
+     *   `email` varchar(255) unique
+     * )
+     * ```
      */
     unique(): ColumnDefinitionBuilder;
     /**
      * Adds a `not null` constraint for the column.
+     *
+     * ### Examples
+     *
+     * ```ts
+     * await db.schema
+     *   .createTable('person')
+     *   .addColumn('first_name', 'varchar(255)', col => col.notNull())
+     *   .execute()
+     * ```
+     *
+     * The generated SQL (MySQL):
+     *
+     * ```sql
+     * create table `person` (
+     *   `first_name` varchar(255) not null
+     * )
+     * ```
      */
     notNull(): ColumnDefinitionBuilder;
     /**
      * Adds a `unsigned` modifier for the column.
      *
      * This only works on some dialects like MySQL.
+     *
+     * ### Examples
+     *
+     * ```ts
+     * await db.schema
+     *   .createTable('person')
+     *   .addColumn('age', 'integer', col => col.unsigned())
+     *   .execute()
+     * ```
+     *
+     * The generated SQL (MySQL):
+     *
+     * ```sql
+     * create table `person` (
+     *   `age` integer unsigned
+     * )
+     * ```
      */
     unsigned(): ColumnDefinitionBuilder;
     /**
@@ -87,27 +233,43 @@ export declare class ColumnDefinitionBuilder implements OperationNodeSource {
      * ### Examples
      *
      * ```ts
-     * db.schema
+     * await db.schema
      *   .createTable('pet')
      *   .addColumn('number_of_legs', 'integer', (col) => col.defaultTo(4))
      *   .execute()
      * ```
      *
+     * The generated SQL (MySQL):
+     *
+     * ```sql
+     * create table `pet` (
+     *   `number_of_legs` integer default 4
+     * )
+     * ```
+     *
      * Values passed to `defaultTo` are interpreted as value literals by default. You can define
      * an arbitrary SQL expression using the {@link sql} template tag:
      *
      * ```ts
      * import { sql } from 'kysely'
      *
-     * db.schema
+     * await db.schema
      *   .createTable('pet')
      *   .addColumn(
-     *     'number_of_legs',
-     *     'integer',
-     *     (col) => col.defaultTo(sql`any SQL here`)
+     *     'created_at',
+     *     'timestamp',
+     *     (col) => col.defaultTo(sql`CURRENT_TIMESTAMP`)
      *   )
      *   .execute()
      * ```
+     *
+     * The generated SQL (MySQL):
+     *
+     * ```sql
+     * create table `pet` (
+     *   `created_at` timestamp default CURRENT_TIMESTAMP
+     * )
+     * ```
      */
     defaultTo(value: DefaultValueExpression): ColumnDefinitionBuilder;
     /**
@@ -118,13 +280,21 @@ export declare class ColumnDefinitionBuilder implements OperationNodeSource {
      * ```ts
      * import { sql } from 'kysely'
      *
-     * db.schema
+     * await db.schema
      *   .createTable('pet')
      *   .addColumn('number_of_legs', 'integer', (col) =>
      *     col.check(sql`number_of_legs < 5`)
      *   )
      *   .execute()
      * ```
+     *
+     * The generated SQL (MySQL):
+     *
+     * ```sql
+     * create table `pet` (
+     *   `number_of_legs` integer check (number_of_legs < 5)
+     * )
+     * ```
      */
     check(expression: Expression<any>): ColumnDefinitionBuilder;
     /**
@@ -135,13 +305,21 @@ export declare class ColumnDefinitionBuilder implements OperationNodeSource {
      * ```ts
      * import { sql } from 'kysely'
      *
-     * db.schema
+     * await db.schema
      *   .createTable('person')
      *   .addColumn('full_name', 'varchar(255)',
      *     (col) => col.generatedAlwaysAs(sql`concat(first_name, ' ', last_name)`)
      *   )
      *   .execute()
      * ```
+     *
+     * The generated SQL (MySQL):
+     *
+     * ```sql
+     * create table `person` (
+     *   `full_name` varchar(255) generated always as (concat(first_name, ' ', last_name))
+     * )
+     * ```
      */
     generatedAlwaysAs(expression: Expression<any>): ColumnDefinitionBuilder;
     /**
@@ -150,10 +328,48 @@ export declare class ColumnDefinitionBuilder implements OperationNodeSource {
      * This only works on some dialects like PostgreSQL.
      *
      * For MS SQL Server (MSSQL)'s identity column use {@link identity}.
+     *
+     * ### Examples
+     *
+     * ```ts
+     * await db.schema
+     *   .createTable('person')
+     *   .addColumn('id', 'integer', col => col.generatedAlwaysAsIdentity().primaryKey())
+     *   .execute()
+     * ```
+     *
+     * The generated SQL (PostgreSQL):
+     *
+     * ```sql
+     * create table "person" (
+     *   "id" integer generated always as identity primary key
+     * )
+     * ```
      */
     generatedAlwaysAsIdentity(): ColumnDefinitionBuilder;
     /**
      * Adds the `generated by default as identity` specifier on supported dialects.
+     *
+     * This only works on some dialects like PostgreSQL.
+     *
+     * For MS SQL Server (MSSQL)'s identity column use {@link identity}.
+     *
+     * ### Examples
+     *
+     * ```ts
+     * await db.schema
+     *   .createTable('person')
+     *   .addColumn('id', 'integer', col => col.generatedByDefaultAsIdentity().primaryKey())
+     *   .execute()
+     * ```
+     *
+     * The generated SQL (PostgreSQL):
+     *
+     * ```sql
+     * create table "person" (
+     *   "id" integer generated by default as identity primary key
+     * )
+     * ```
      */
     generatedByDefaultAsIdentity(): ColumnDefinitionBuilder;
     /**
@@ -163,14 +379,24 @@ export declare class ColumnDefinitionBuilder implements OperationNodeSource {
      * ### Examples
      *
      * ```ts
-     * db.schema
+     * import { sql } from 'kysely'
+     *
+     * await db.schema
      *   .createTable('person')
      *   .addColumn('full_name', 'varchar(255)', (col) => col
-     *     .generatedAlwaysAs("concat(first_name, ' ', last_name)")
+     *     .generatedAlwaysAs(sql`concat(first_name, ' ', last_name)`)
      *     .stored()
      *   )
      *   .execute()
      * ```
+     *
+     * The generated SQL (MySQL):
+     *
+     * ```sql
+     * create table `person` (
+     *   `full_name` varchar(255) generated always as (concat(first_name, ' ', last_name)) stored
+     * )
+     * ```
      */
     stored(): ColumnDefinitionBuilder;
     /**
@@ -179,10 +405,17 @@ export declare class ColumnDefinitionBuilder implements OperationNodeSource {
      * ### Examples
      *
      * ```ts
-     * db.schema.createTable('person')
-     *  .addColumn('id', 'integer', col => col.primaryKey())
-     *  .addColumn('first_name', 'varchar(36)', col => col.modifyFront(sql`collate utf8mb4_general_ci`).notNull())
-     *  .execute()
+     * import { sql } from 'kysely'
+     *
+     * await db.schema
+     *   .createTable('person')
+     *   .addColumn('id', 'integer', col => col.primaryKey())
+     *   .addColumn(
+     *     'first_name',
+     *     'varchar(36)',
+     *     (col) => col.modifyFront(sql`collate utf8mb4_general_ci`).notNull()
+     *   )
+     *   .execute()
      * ```
      *
      * The generated SQL (MySQL):
@@ -204,10 +437,11 @@ export declare class ColumnDefinitionBuilder implements OperationNodeSource {
      * ### Examples
      *
      * ```ts
-     * db.schema.createTable('person')
-     *  .addColumn('id', 'integer', col => col.primaryKey())
-     *  .addColumn('first_name', 'varchar(30)', col => col.unique().nullsNotDistinct())
-     *  .execute()
+     * db.schema
+     *   .createTable('person')
+     *   .addColumn('id', 'integer', col => col.primaryKey())
+     *   .addColumn('first_name', 'varchar(30)', col => col.unique().nullsNotDistinct())
+     *   .execute()
      * ```
      *
      * The generated SQL (PostgreSQL):
@@ -221,8 +455,22 @@ export declare class ColumnDefinitionBuilder implements OperationNodeSource {
      */
     nullsNotDistinct(): ColumnDefinitionBuilder;
     /**
-     * Adds `if not exists` specifier.
-     * This only works for PostgreSQL.
+     * Adds `if not exists` specifier. This only works for PostgreSQL.
+     *
+     * ### Examples
+     *
+     * ```ts
+     * await db.schema
+     *   .alterTable('person')
+     *   .addColumn('email', 'varchar(255)', col => col.unique().ifNotExists())
+     *   .execute()
+     * ```
+     *
+     * The generated SQL (PostgreSQL):
+     *
+     * ```sql
+     * alter table "person" add column if not exists "email" varchar(255) unique
+     * ```
      */
     ifNotExists(): ColumnDefinitionBuilder;
     /**
@@ -231,10 +479,19 @@ export declare class ColumnDefinitionBuilder implements OperationNodeSource {
      * ### Examples
      *
      * ```ts
-     * db.schema.createTable('person')
-     *  .addColumn('id', 'integer', col => col.primaryKey())
-     *  .addColumn('age', 'integer', col => col.unsigned().notNull().modifyEnd(sql`comment ${sql.lit('it is not polite to ask a woman her age')}`))
-     *  .execute()
+     * import { sql } from 'kysely'
+     *
+     * await db.schema
+     *   .createTable('person')
+     *   .addColumn('id', 'integer', col => col.primaryKey())
+     *   .addColumn(
+     *     'age',
+     *     'integer',
+     *     col => col.unsigned()
+     *       .notNull()
+     *       .modifyEnd(sql`comment ${sql.lit('it is not polite to ask a woman her age')}`)
+     *   )
+     *   .execute()
      * ```
      *
      * The generated SQL (MySQL):