Class CreateTypeBuilder

Hierarchy

CreateTypeBuilder

Implements

Index

Constructors

Methods

$call asEnum compile execute toOperationNode

Constructors

constructor

new CreateTypeBuilder(props): CreateTypeBuilder
Parameters
- props: CreateTypeBuilderProps
Returns CreateTypeBuilder
- Defined in kysely/src/schema/create-type-builder.ts:13

Methods

$call

$call<T>(func): T
Simply calls the provided function passing this as the only argument. $call returns what the provided function returns.
Type Parameters
- T
Parameters
- func: ((qb) => T)
  - - (qb): T
    - Parameters
      
      qb: CreateTypeBuilder
      
      Returns T
Returns T
- Defined in kysely/src/schema/create-type-builder.ts:44

asEnum

asEnum(values): CreateTypeBuilder
Creates an anum type.

Examples
```
db.schema.createType('species').asEnum(['cat', 'dog', 'frog'])
```
Parameters
- values: string[]
Returns CreateTypeBuilder
- Defined in kysely/src/schema/create-type-builder.ts:33

compile

compile(): CompiledQuery<unknown>
Returns CompiledQuery<unknown>
Implementation of Compilable.compile
- Defined in kysely/src/schema/create-type-builder.ts:48

execute

execute(): Promise<void>
Returns Promise<void>
- Defined in kysely/src/schema/create-type-builder.ts:55

toOperationNode

toOperationNode(): CreateTypeNode
Returns CreateTypeNode
Implementation of OperationNodeSource.toOperationNode
- Defined in kysely/src/schema/create-type-builder.ts:17

Generated using TypeDoc