Class Builder<Schema, Ext>

constructor

• new Builder<Schema, Ext>(fn, QueryBuilder?, InsertBuilder?, UpdateBuilder?, DeleteBuilder?, SchemaBuilder?, TypeBuilder?, ConstraintBuilder?, DefaultBuilder?): Builder<Schema, Ext>

• Type Parameters

  • Schema

  • Ext extends BuilderExtension

  Parameters

  • fn: Functions<Schema, {}, Ext>

  • QueryBuilder: typeof QueryBuilder = QB

  • InsertBuilder: typeof InsertBuilder = IB

  • UpdateBuilder: typeof UpdateBuilder = UB

  • DeleteBuilder: typeof DeleteBuilder = DB

  • SchemaBuilder: typeof SchemaBuilder = SB

  • TypeBuilder: typeof TypeBuilder = TB

  • ConstraintBuilder: typeof ConstraintBuilder = CB

  • DefaultBuilder: typeof DefaultBuilder = DefB

  Returns Builder<Schema, Ext>

Readonly ConstraintBuilder

Readonly DefaultBuilder

Readonly DeleteBuilder

Readonly InsertBuilder

Readonly QueryBuilder

Readonly SchemaBuilder

Readonly TypeBuilder

Readonly UpdateBuilder

dialect

Readonly fn

constraint

• get constraint(): ConstraintBuilder<Schema, Ext>

• Returns ConstraintBuilder<Schema, Ext>

default

• get default(): DefaultBuilder<Ext>

• Returns DefaultBuilder<Ext>

schema

• get schema(): SchemaBuilder<Schema, number, Ext>

• Returns SchemaBuilder<Schema, number, Ext>

type

• get type(): TypeBuilder

• Returns TypeBuilder

value

• get value(): TypedAst<Schema, any, ast.Value>

• Returns TypedAst<Schema, any, ast.Value>

as

• as<Col, T>(name, val): WithAlias<Col, T>

• Aliases an expression for use in a select.

  Type Parameters

  • Col extends string

  • T

  Parameters

  • name: Col

  • val: T

  Returns WithAlias<Col, T>

ast

• ast<Return>(e): TypedAst<Schema, Return, Expr<Ext>>

• Allows you to pass a raw bit of AST into the query. You must provide the type of this expression.

  Type Parameters

  • Return

  Parameters

  • e: Expr<Ext>

  Returns TypedAst<Schema, Return, Expr<Ext>>

deleteFrom

• deleteFrom<TableName>(table): DeleteBuilder<Schema, Schema[TableName] & QualifiedTable<Schema, TableName>, number, Ext>

• Type Parameters

  • TableName extends string

  Parameters

  • table: TableName

  Returns DeleteBuilder<Schema, Schema[TableName] & QualifiedTable<Schema, TableName>, number, Ext>

from

• from<TableName>(table?): QueryBuilder<Schema, Schema[TableName] & QualifiedTable<Schema, TableName>, {}, Ext>

• Type Parameters

  • TableName extends string

  Parameters

  • Optional table: TableName

  Returns QueryBuilder<Schema, Schema[TableName] & QualifiedTable<Schema, TableName>, {}, Ext>

insertInto

• insertInto<TableName>(table): InsertBuilder<Schema, Schema[TableName] & QualifiedTable<Schema, TableName>, number, Ext>

• Type Parameters

  • TableName extends string

  Parameters

  • table: TableName

  Returns InsertBuilder<Schema, Schema[TableName] & QualifiedTable<Schema, TableName>, number, Ext>

lit

• lit<Return>(l): TypedAst<Schema, Return, ast.Lit>

• Allows you to insert a literal into the query.

  Type Parameters

  • Return extends any

  Parameters

  • l: Return

  Returns TypedAst<Schema, Return, ast.Lit>

update

• update<TableName>(table): UpdateBuilder<Schema, Schema[TableName] & QualifiedTable<Schema, TableName>, number, Ext>

• Type Parameters

  • TableName extends string

  Parameters

  • table: TableName

  Returns UpdateBuilder<Schema, Schema[TableName] & QualifiedTable<Schema, TableName>, number, Ext>