Class AlterTableBuilder

This builder can be used to create a alter table query.

Hierarchy

AlterTableBuilder

Implements

ColumnAlteringInterface

Index

Constructors

constructor

Methods

$call addCheckConstraint addColumn addForeignKeyConstraint addPrimaryKeyConstraint addUniqueConstraint alterColumn dropColumn dropConstraint modifyColumn renameColumn renameTo setSchema

Constructors

constructor

new AlterTableBuilder(props): AlterTableBuilder
Parameters
- props: AlterTableBuilderProps
Returns AlterTableBuilder
- Defined in kysely/src/schema/alter-table-builder.ts:47

Methods

$call

$call<T>(func): T
Calls the given function passing this as the only argument.

See $call
Type Parameters
- T
Parameters
- func: ((qb) => T)
  - - (qb): T
    - Parameters
      
      qb: AlterTableBuilder
      
      Returns T
Returns T
- Defined in kysely/src/schema/alter-table-builder.ts:247

addCheckConstraint

addCheckConstraint(constraintName, checkExpression): AlterTableExecutor
See addCheckConstraint
Parameters
- constraintName: string
- checkExpression: Expression<any>
Returns AlterTableExecutor
- Defined in kysely/src/schema/alter-table-builder.ts:173

addColumn

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

addForeignKeyConstraint

addForeignKeyConstraint(constraintName, columns, targetTable, targetColumns): AlterTableAddForeignKeyConstraintBuilder
See addForeignKeyConstraint

Unlike addForeignKeyConstraint this method returns the constraint builder and doesn't take a callback as the last argument. This is because you can only add one column per ALTER TABLE query.
Parameters
- constraintName: string
- columns: string[]
- targetTable: string
- targetColumns: string[]
Returns AlterTableAddForeignKeyConstraintBuilder
- Defined in kysely/src/schema/alter-table-builder.ts:197

addPrimaryKeyConstraint

addPrimaryKeyConstraint(constraintName, columns): AlterTableExecutor
See addPrimaryKeyConstraint
Parameters
- constraintName: string
- columns: string[]
Returns AlterTableExecutor
- Defined in kysely/src/schema/alter-table-builder.ts:219

addUniqueConstraint

addUniqueConstraint(constraintName, columns): AlterTableExecutor
See addUniqueConstraint
Parameters
- constraintName: string
- columns: string[]
Returns AlterTableExecutor
- Defined in kysely/src/schema/alter-table-builder.ts:156

alterColumn

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

dropColumn

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

dropConstraint

dropConstraint(constraintName): AlterTableDropConstraintBuilder
Parameters
- constraintName: string
Returns AlterTableDropConstraintBuilder
- Defined in kysely/src/schema/alter-table-builder.ts:233

modifyColumn

modifyColumn(columnName, dataType, build?): 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:130

renameColumn

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

renameTo

renameTo(newTableName): AlterTableExecutor
Parameters
- newTableName: string
Returns AlterTableExecutor
- Defined in kysely/src/schema/alter-table-builder.ts:51

setSchema

setSchema(newSchema): AlterTableExecutor
Parameters
- newSchema: string
Returns AlterTableExecutor
- Defined in kysely/src/schema/alter-table-builder.ts:60

Class AlterTableBuilder

Hierarchy

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

props: AlterTableBuilderProps

Returns AlterTableBuilder

Methods

$call

Type Parameters

T

Parameters

func: ((qb) => T)

Parameters

qb: AlterTableBuilder

Returns T

Returns T

addCheckConstraint

Parameters

constraintName: string

checkExpression: Expression<any>

Returns AlterTableExecutor

addColumn

Parameters

columnName: string

dataType: DataTypeExpression

build: ColumnDefinitionBuilderCallback = noop

Returns AlterTableColumnAlteringBuilder

addForeignKeyConstraint

Parameters

constraintName: string

columns: string[]

targetTable: string

targetColumns: string[]

Returns AlterTableAddForeignKeyConstraintBuilder

addPrimaryKeyConstraint

Parameters

constraintName: string

columns: string[]

Returns AlterTableExecutor

addUniqueConstraint

Parameters

constraintName: string

columns: string[]

Returns AlterTableExecutor

alterColumn

Parameters

column: string

alteration: AlterColumnBuilderCallback

Returns AlterTableColumnAlteringBuilder

dropColumn

Parameters

column: string

Returns AlterTableColumnAlteringBuilder

dropConstraint

Parameters

constraintName: string

Returns AlterTableDropConstraintBuilder

modifyColumn

Parameters

columnName: string

dataType: DataTypeExpression

build: ColumnDefinitionBuilderCallback = noop

Returns AlterTableColumnAlteringBuilder

renameColumn

Parameters

column: string

newColumn: string

Returns AlterTableColumnAlteringBuilder

renameTo

Parameters

newTableName: string

Returns AlterTableExecutor

setSchema

Parameters

newSchema: string