Interface ColumnAlteringInterface

interface ColumnAlteringInterface {
    addColumn(
        columnName: string,
        dataType: DataTypeExpression,
        build?: ColumnDefinitionBuilderCallback,
    ): ColumnAlteringInterface;
    alterColumn(
        column: string,
        alteration: AlterColumnBuilderCallback,
    ): ColumnAlteringInterface;
    dropColumn(column: string): ColumnAlteringInterface;
    modifyColumn(
        columnName: string,
        dataType: DataTypeExpression,
        build: ColumnDefinitionBuilderCallback,
    ): ColumnAlteringInterface;
    renameColumn(column: string, newColumn: string): ColumnAlteringInterface;
}

Implemented by

Index

Methods

addColumn alterColumn dropColumn modifyColumn renameColumn

Methods

addColumn

addColumn(
    columnName: string,
    dataType: DataTypeExpression,
    build?: ColumnDefinitionBuilderCallback,
): ColumnAlteringInterface
See CreateTableBuilder.addColumn
Parameters
- columnName: string
- dataType: DataTypeExpression
- Optionalbuild: ColumnDefinitionBuilderCallback
Returns ColumnAlteringInterface
- Defined in kysely/src/schema/alter-table-builder.ts:381

alterColumn

alterColumn(
column: string,
alteration: AlterColumnBuilderCallback,
): ColumnAlteringInterface
Parameters
- column: string
- alteration: AlterColumnBuilderCallback
Returns ColumnAlteringInterface
- Defined in kysely/src/schema/alter-table-builder.ts:369

dropColumn

dropColumn(column: string): ColumnAlteringInterface
Parameters
- column: string
Returns ColumnAlteringInterface
- Defined in kysely/src/schema/alter-table-builder.ts:374

modifyColumn

modifyColumn(
    columnName: string,
    dataType: DataTypeExpression,
    build: ColumnDefinitionBuilderCallback,
): ColumnAlteringInterface
Creates an alter table modify column query. The modify column statement is only implemeted by MySQL and oracle AFAIK. On other databases you should use the alterColumn method.
Parameters
- columnName: string
- dataType: DataTypeExpression
- build: ColumnDefinitionBuilderCallback
Returns ColumnAlteringInterface
- Defined in kysely/src/schema/alter-table-builder.ts:392

renameColumn

renameColumn(column: string, newColumn: string): ColumnAlteringInterface
Parameters
- column: string
- newColumn: string
Returns ColumnAlteringInterface
- Defined in kysely/src/schema/alter-table-builder.ts:376