Class AlterTableColumnAlteringBuilder

Implements

Index

Constructors

Methods

addColumn alterColumn compile dropColumn execute modifyColumn renameColumn toOperationNode

Constructors

constructor

new AlterTableColumnAlteringBuilder(
props: AlterTableColumnAlteringBuilderProps,
): AlterTableColumnAlteringBuilder
Parameters
- props: AlterTableColumnAlteringBuilderProps
Returns AlterTableColumnAlteringBuilder
- Defined in kysely/src/schema/alter-table-builder.ts:404

Methods

addColumn

addColumn(
    columnName: string,
    dataType: DataTypeExpression,
    build?: ColumnDefinitionBuilderCallback,
): AlterTableColumnAlteringBuilder
See CreateTableBuilder.addColumn
Parameters
- columnName: string
- dataType: DataTypeExpression
- build: ColumnDefinitionBuilderCallback = noop
Returns AlterTableColumnAlteringBuilder
Implementation of ColumnAlteringInterface.addColumn
- Defined in kysely/src/schema/alter-table-builder.ts:446

alterColumn

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

compile

compile(): CompiledQuery
Returns CompiledQuery
Implementation of Compilable.compile
- Defined in kysely/src/schema/alter-table-builder.ts:499

dropColumn

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

execute

execute(): Promise<void>
Returns Promise<void>
- Defined in kysely/src/schema/alter-table-builder.ts:506

modifyColumn

modifyColumn(
    columnName: string,
    dataType: DataTypeExpression,
    build?: ColumnDefinitionBuilderCallback,
): AlterTableColumnAlteringBuilder
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 = noop
Returns AlterTableColumnAlteringBuilder
Implementation of ColumnAlteringInterface.modifyColumn
- Defined in kysely/src/schema/alter-table-builder.ts:469

renameColumn

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

toOperationNode

toOperationNode(): AlterTableNode
Returns AlterTableNode
Implementation of OperationNodeSource.toOperationNode
- Defined in kysely/src/schema/alter-table-builder.ts:492