SQL

Overview

Module

package: @aerokit/sdk/db
source: db/sql.ts
last updated:

This module provides a fluent API for building SQL statements in a database-agnostic way. It includes builders for SELECT, INSERT, UPDATE, DELETE, CREATE, and DROP statements, as well as a builder for retrieving the next value from a sequence. The builders allow for method chaining to construct complex SQL queries while managing parameters separately to prevent SQL injection. The module abstracts away differences in SQL dialects and provides a consistent interface for constructing SQL statements across different databases.

Key Features

Fluent API for building SQL statements with method chaining.
Support for SELECT, INSERT, UPDATE, DELETE, CREATE, and DROP statements.
Separate parameter management to prevent SQL injection.
Database-agnostic design that abstracts away SQL dialect differences.
Integration with the underlying database connection for executing built statements.

Use Cases

Constructing complex SQL queries in a readable and maintainable way.
Building SQL statements dynamically based on application logic or user input.
Abstracting database interactions to allow for easier maintenance and potential database engine changes in the future.

Example Usage

import { SQLBuilder } from "@aerokit/sdk/db";

// Example of building a SELECT statement
const sqlBuilder = SQLBuilder.getDialect();
const selectQuery = sqlBuilder.select()
  .column("id")
  .column("name")
  .from("users")
  .where("id = ?", 1);

Classes

SQLBuilder

prepareBuilder()

Hook for subclasses to set up the native builder object (e.g., calling .select()).

ts
prepareBuilder(builder: any): any;
Parameter Type Description
builder any
Returns
Type: any
Description:

Parameter	Type	Description
`builder`	`any`

parameters()

ts
parameters(): void;
Returns
Type: void
Description:

addParameter()

Adds parameter(s) to the internal list. Handles single values and arrays of values.

ts
addParameter(value: any): void;
Parameter Type Description
value any
Returns
Type: void
Description:

Parameter	Type	Description
`value`	`any`

build()

Builds and returns the final SQL string.

ts
build(): string;
Returns
Type: string
Description:

getDialect()

Factory method to get a dialect-specific SQLBuilder instance.

ts
static getDialect(connection: Connection): SQLBuilder;
Parameter Type Description
connection Connection
Returns
Type: SQLBuilder
Description:

Parameter	Type	Description
`connection`	`Connection`

select()

ts
select(): SelectBuilder;
Returns
Type: SelectBuilder
Description:

insert()

ts
insert(): InsertBuilder;
Returns
Type: InsertBuilder
Description:

update()

ts
update(): UpdateBuilder;
Returns
Type: UpdateBuilder
Description:

delete()

ts
delete(): DeleteBuilder;
Returns
Type: DeleteBuilder
Description:

nextval()

ts
nextval(name: string): NextvalBuilder;
Parameter Type Description
name string
Returns
Type: NextvalBuilder
Description:

Parameter	Type	Description
`name`	`string`

create()

ts
create(): CreateBuilder;
Returns
Type: CreateBuilder
Description:

drop()

ts
drop(): DropBuilder;
Returns
Type: DropBuilder
Description:

SelectBuilder

parameters()

ts
parameters(): void;
Returns
Type: void
Description:

addParameter()

Adds parameter(s) to the internal list. Handles single values and arrays of values.

ts
addParameter(value: any): void;
Parameter Type Description
value any
Returns
Type: void
Description:

Parameter	Type	Description
`value`	`any`

build()

Builds and returns the final SQL string.

ts
build(): string;
Returns
Type: string
Description:

prepareBuilder()

Hook for subclasses to set up the native builder object (e.g., calling .select()).

ts
prepareBuilder(builder: any): any;
Parameter Type Description
builder any
Returns
Type: any
Description:

Parameter	Type	Description
`builder`	`any`

distinct()

ts
distinct(): SelectBuilder;
Returns
Type: SelectBuilder
Description:

forUpdate()

ts
forUpdate(): SelectBuilder;
Returns
Type: SelectBuilder
Description:

column()

ts
column(column: string): SelectBuilder;
Parameter Type Description
column string
Returns
Type: SelectBuilder
Description:

Parameter	Type	Description
`column`	`string`

from()

ts
from(table: string, alias: string): SelectBuilder;
Parameter Type Description
table string
alias string
Returns
Type: SelectBuilder
Description:

Parameter	Type	Description
`table`	`string`
`alias`	`string`

join()

ts
join(table: string, on: string, alias: string, parameters: any): SelectBuilder;
Parameter Type Description
table string
on string
alias string
parameters any
Returns
Type: SelectBuilder
Description:

Parameter	Type	Description
`table`	`string`
`on`	`string`
`alias`	`string`
`parameters`	`any`

innerJoin()

ts
innerJoin(table: string, on: string, alias: string, parameters: any): SelectBuilder;
Parameter Type Description
table string
on string
alias string
parameters any
Returns
Type: SelectBuilder
Description:

Parameter	Type	Description
`table`	`string`
`on`	`string`
`alias`	`string`
`parameters`	`any`

outerJoin()

ts
outerJoin(table: string, on: string, alias: string, parameters: any): SelectBuilder;
Parameter Type Description
table string
on string
alias string
parameters any
Returns
Type: SelectBuilder
Description:

Parameter	Type	Description
`table`	`string`
`on`	`string`
`alias`	`string`
`parameters`	`any`

leftJoin()

ts
leftJoin(table: string, on: string, alias: string, parameters: any): SelectBuilder;
Parameter Type Description
table string
on string
alias string
parameters any
Returns
Type: SelectBuilder
Description:

Parameter	Type	Description
`table`	`string`
`on`	`string`
`alias`	`string`
`parameters`	`any`

rightJoin()

ts
rightJoin(table: string, on: string, alias: string, parameters: any): SelectBuilder;
Parameter Type Description
table string
on string
alias string
parameters any
Returns
Type: SelectBuilder
Description:

Parameter	Type	Description
`table`	`string`
`on`	`string`
`alias`	`string`
`parameters`	`any`

fullJoin()

ts
fullJoin(table: string, on: string, alias: string, parameters: any): SelectBuilder;
Parameter Type Description
table string
on string
alias string
parameters any
Returns
Type: SelectBuilder
Description:

Parameter	Type	Description
`table`	`string`
`on`	`string`
`alias`	`string`
`parameters`	`any`

where()

Sets the WHERE condition.

ts
where(condition: string, parameters: any): SelectBuilder;
Parameter Type Description
condition string The SQL condition string (e.g., "column1 = ?").
parameters any Optional parameters to replace '?' in the condition.
Returns
Type: SelectBuilder
Description:

Parameter	Type	Description
`condition`	`string`	The SQL condition string (e.g., "column1 = ?").
`parameters`	`any`	Optional parameters to replace '?' in the condition.

order()

ts
order(column: string, asc: boolean): SelectBuilder;
Parameter Type Description
column string
asc boolean
Returns
Type: SelectBuilder
Description:

Parameter	Type	Description
`column`	`string`
`asc`	`boolean`

group()

ts
group(column: string): SelectBuilder;
Parameter Type Description
column string
Returns
Type: SelectBuilder
Description:

Parameter	Type	Description
`column`	`string`

limit()

ts
limit(limit: number): SelectBuilder;
Parameter Type Description
limit number
Returns
Type: SelectBuilder
Description:

Parameter	Type	Description
`limit`	`number`

offset()

ts
offset(offset: number): SelectBuilder;
Parameter Type Description
offset number
Returns
Type: SelectBuilder
Description:

Parameter	Type	Description
`offset`	`number`

having()

ts
having(having: string): SelectBuilder;
Parameter Type Description
having string
Returns
Type: SelectBuilder
Description:

Parameter	Type	Description
`having`	`string`

union()

ts
union(select: string): SelectBuilder;
Parameter Type Description
select string
Returns
Type: SelectBuilder
Description:

Parameter	Type	Description
`select`	`string`

InsertBuilder

parameters()

ts
parameters(): void;
Returns
Type: void
Description:

addParameter()

Adds parameter(s) to the internal list. Handles single values and arrays of values.

ts
addParameter(value: any): void;
Parameter Type Description
value any
Returns
Type: void
Description:

Parameter	Type	Description
`value`	`any`

build()

Builds and returns the final SQL string.

ts
build(): string;
Returns
Type: string
Description:

prepareBuilder()

Hook for subclasses to set up the native builder object (e.g., calling .select()).

ts
prepareBuilder(builder: any): any;
Parameter Type Description
builder any
Returns
Type: any
Description:

Parameter	Type	Description
`builder`	`any`

into()

ts
into(table: string): InsertBuilder;
Parameter Type Description
table string
Returns
Type: InsertBuilder
Description:

Parameter	Type	Description
`table`	`string`

column()

ts
column(column: string): InsertBuilder;
Parameter Type Description
column string
Returns
Type: InsertBuilder
Description:

Parameter	Type	Description
`column`	`string`

value()

Sets the value for the last column specified.

ts
value(value: string, parameters: any): InsertBuilder;
Parameter Type Description
value string The value placeholder (e.g., "?") or literal.
parameters any Optional parameters if a placeholder was used.
Returns
Type: InsertBuilder
Description:

Parameter	Type	Description
`value`	`string`	The value placeholder (e.g., "?") or literal.
`parameters`	`any`	Optional parameters if a placeholder was used.

select()

ts
select(select: string): InsertBuilder;
Parameter Type Description
select string
Returns
Type: InsertBuilder
Description:

Parameter	Type	Description
`select`	`string`

UpdateBuilder

parameters()

ts
parameters(): void;
Returns
Type: void
Description:

addParameter()

Adds parameter(s) to the internal list. Handles single values and arrays of values.

ts
addParameter(value: any): void;
Parameter Type Description
value any
Returns
Type: void
Description:

Parameter	Type	Description
`value`	`any`

build()

Builds and returns the final SQL string.

ts
build(): string;
Returns
Type: string
Description:

prepareBuilder()

Hook for subclasses to set up the native builder object (e.g., calling .select()).

ts
prepareBuilder(builder: any): any;
Parameter Type Description
builder any
Returns
Type: any
Description:

Parameter	Type	Description
`builder`	`any`

table()

ts
table(table: string): UpdateBuilder;
Parameter Type Description
table string
Returns
Type: UpdateBuilder
Description:

Parameter	Type	Description
`table`	`string`

set()

Sets a column to a value.

ts
set(column: string, value: string, parameters: any): UpdateBuilder;
Parameter Type Description
column string The column name.
value string The value placeholder (e.g., "?") or literal.
parameters any Optional parameters if a placeholder was used.
Returns
Type: UpdateBuilder
Description:

Parameter	Type	Description
`column`	`string`	The column name.
`value`	`string`	The value placeholder (e.g., "?") or literal.
`parameters`	`any`	Optional parameters if a placeholder was used.

where()

Sets the WHERE condition for the update.

ts
where(condition: string, parameters: any): UpdateBuilder;
Parameter Type Description
condition string The SQL condition string (e.g., "column1 = ?").
parameters any Optional parameters to replace '?' in the condition.
Returns
Type: UpdateBuilder
Description:

Parameter	Type	Description
`condition`	`string`	The SQL condition string (e.g., "column1 = ?").
`parameters`	`any`	Optional parameters to replace '?' in the condition.

DeleteBuilder

parameters()

ts
parameters(): void;
Returns
Type: void
Description:

addParameter()

Adds parameter(s) to the internal list. Handles single values and arrays of values.

ts
addParameter(value: any): void;
Parameter Type Description
value any
Returns
Type: void
Description:

Parameter	Type	Description
`value`	`any`

build()

Builds and returns the final SQL string.

ts
build(): string;
Returns
Type: string
Description:

prepareBuilder()

Hook for subclasses to set up the native builder object (e.g., calling .select()).

ts
prepareBuilder(builder: any): any;
Parameter Type Description
builder any
Returns
Type: any
Description:

Parameter	Type	Description
`builder`	`any`

from()

ts
from(table: string): DeleteBuilder;
Parameter Type Description
table string
Returns
Type: DeleteBuilder
Description:

Parameter	Type	Description
`table`	`string`

where()

Sets the WHERE condition for the deletion.

ts
where(condition: string, parameters: any): DeleteBuilder;
Parameter Type Description
condition string The SQL condition string (e.g., "column1 = ?").
parameters any Optional parameters to replace '?' in the condition.
Returns
Type: DeleteBuilder
Description:

Parameter	Type	Description
`condition`	`string`	The SQL condition string (e.g., "column1 = ?").
`parameters`	`any`	Optional parameters to replace '?' in the condition.

NextvalBuilder

parameters()

ts
parameters(): void;
Returns
Type: void
Description:

addParameter()

Adds parameter(s) to the internal list. Handles single values and arrays of values.

ts
addParameter(value: any): void;
Parameter Type Description
value any
Returns
Type: void
Description:

Parameter	Type	Description
`value`	`any`

build()

Builds and returns the final SQL string.

ts
build(): string;
Returns
Type: string
Description:

prepareBuilder()

Hook for subclasses to set up the native builder object (e.g., calling .select()).

ts
prepareBuilder(builder: any): any;
Parameter Type Description
builder any
Returns
Type: any
Description:

Parameter	Type	Description
`builder`	`any`

CreateBuilder

prepareBuilder()

Hook for subclasses to set up the native builder object (e.g., calling .select()).

ts
prepareBuilder(builder: any): any;
Parameter Type Description
builder any
Returns
Type: any
Description:

Parameter	Type	Description
`builder`	`any`

parameters()

ts
parameters(): void;
Returns
Type: void
Description:

addParameter()

Adds parameter(s) to the internal list. Handles single values and arrays of values.

ts
addParameter(value: any): void;
Parameter Type Description
value any
Returns
Type: void
Description:

Parameter	Type	Description
`value`	`any`

build()

Builds and returns the final SQL string.

ts
build(): string;
Returns
Type: string
Description:

table()

ts
table(table: string): CreateTableBuilder;
Parameter Type Description
table string
Returns
Type: CreateTableBuilder
Description:

Parameter	Type	Description
`table`	`string`

view()

ts
view(view: string): CreateViewBuilder;
Parameter Type Description
view string
Returns
Type: CreateViewBuilder
Description:

Parameter	Type	Description
`view`	`string`

sequence()

ts
sequence(sequence: string): CreateSequenceBuilder;
Parameter Type Description
sequence string
Returns
Type: CreateSequenceBuilder
Description:

Parameter	Type	Description
`sequence`	`string`

CreateTableBuilder

prepareBuilder()

Hook for subclasses to set up the native builder object (e.g., calling .select()).

ts
prepareBuilder(builder: any): any;
Parameter Type Description
builder any
Returns
Type: any
Description:

Parameter	Type	Description
`builder`	`any`

parameters()

ts
parameters(): void;
Returns
Type: void
Description:

addParameter()

Adds parameter(s) to the internal list. Handles single values and arrays of values.

ts
addParameter(value: any): void;
Parameter Type Description
value any
Returns
Type: void
Description:

Parameter	Type	Description
`value`	`any`

build()

Builds and returns the final SQL string.

ts
build(): string;
Returns
Type: string
Description:

column()

Adds a generic column definition.

ts
column(name: string, type: DataType, isPrimaryKey: boolean, isNullable: boolean, isUnique: boolean, isIdentity: boolean, isFuzzyIndexEnabled: boolean, args: any): CreateTableBuilder;
Parameter Type Description
name string
type DataType
isPrimaryKey boolean
isNullable boolean
isUnique boolean
isIdentity boolean
isFuzzyIndexEnabled boolean
args any Additional dialect-specific arguments passed as an array to native.
Returns
Type: CreateTableBuilder
Description:

Parameter	Type	Description
`name`	`string`
`type`	`DataType`
`isPrimaryKey`	`boolean`
`isNullable`	`boolean`
`isUnique`	`boolean`
`isIdentity`	`boolean`
`isFuzzyIndexEnabled`	`boolean`
`args`	`any`	Additional dialect-specific arguments passed as an array to native.

columnVarchar()

Adds a VARCHAR column.

ts
columnVarchar(name: string, length: number, isPrimaryKey: boolean, isNullable: boolean, isUnique: boolean, isIdentity: boolean, args: any): CreateTableBuilder;
Parameter Type Description
name string
length number
isPrimaryKey boolean
isNullable boolean
isUnique boolean
isIdentity boolean
args any Additional dialect-specific arguments passed as an array to native.
Returns
Type: CreateTableBuilder
Description:

Parameter	Type	Description
`name`	`string`
`length`	`number`
`isPrimaryKey`	`boolean`
`isNullable`	`boolean`
`isUnique`	`boolean`
`isIdentity`	`boolean`
`args`	`any`	Additional dialect-specific arguments passed as an array to native.

columnNvarchar()

Adds an NVARCHAR column.

ts
columnNvarchar(name: string, length: number, isPrimaryKey: boolean, isNullable: boolean, isUnique: boolean, isIdentity: boolean, args: any): CreateTableBuilder;
Parameter Type Description
name string
length number
isPrimaryKey boolean
isNullable boolean
isUnique boolean
isIdentity boolean
args any Additional dialect-specific arguments passed as an array to native.
Returns
Type: CreateTableBuilder
Description:

Parameter	Type	Description
`name`	`string`
`length`	`number`
`isPrimaryKey`	`boolean`
`isNullable`	`boolean`
`isUnique`	`boolean`
`isIdentity`	`boolean`
`args`	`any`	Additional dialect-specific arguments passed as an array to native.

columnChar()

Adds a CHAR column.

ts
columnChar(name: string, length: number, isPrimaryKey: boolean, isNullable: boolean, isUnique: boolean, isIdentity: boolean, args: any): CreateTableBuilder;
Parameter Type Description
name string
length number
isPrimaryKey boolean
isNullable boolean
isUnique boolean
isIdentity boolean
args any Additional dialect-specific arguments passed as an array to native.
Returns
Type: CreateTableBuilder
Description:

Parameter	Type	Description
`name`	`string`
`length`	`number`
`isPrimaryKey`	`boolean`
`isNullable`	`boolean`
`isUnique`	`boolean`
`isIdentity`	`boolean`
`args`	`any`	Additional dialect-specific arguments passed as an array to native.

columnDate()

Adds a DATE column.

ts
columnDate(name: string, isPrimaryKey: boolean, isNullable: boolean, isUnique: boolean, args: any): CreateTableBuilder;
Parameter Type Description
name string
isPrimaryKey boolean
isNullable boolean
isUnique boolean
args any Additional dialect-specific arguments passed as an array to native.
Returns
Type: CreateTableBuilder
Description:

Parameter	Type	Description
`name`	`string`
`isPrimaryKey`	`boolean`
`isNullable`	`boolean`
`isUnique`	`boolean`
`args`	`any`	Additional dialect-specific arguments passed as an array to native.

columnTime()

Adds a TIME column.

ts
columnTime(name: string, isPrimaryKey: boolean, isNullable: boolean, isUnique: boolean, args: any): CreateTableBuilder;
Parameter Type Description
name string
isPrimaryKey boolean
isNullable boolean
isUnique boolean
args any Additional dialect-specific arguments passed as an array to native.
Returns
Type: CreateTableBuilder
Description:

columnTimestamp()

Adds a TIMESTAMP column.

ts
columnTimestamp(name: string, isPrimaryKey: boolean, isNullable: boolean, isUnique: boolean, args: any): CreateTableBuilder;
Parameter Type Description
name string
isPrimaryKey boolean
isNullable boolean
isUnique boolean
args any Additional dialect-specific arguments passed as an array to native.
Returns
Type: CreateTableBuilder
Description:

columnInteger()

Adds an INTEGER column.

ts
columnInteger(name: string, isPrimaryKey: boolean, isNullable: boolean, isUnique: boolean, isIdentity: boolean, args: any): CreateTableBuilder;
Parameter Type Description
name string
isPrimaryKey boolean
isNullable boolean
isUnique boolean
isIdentity boolean
args any Additional dialect-specific arguments passed as an array to native.
Returns
Type: CreateTableBuilder
Description:

columnTinyint()

Adds a TINYINT column.

ts
columnTinyint(name: string, isPrimaryKey: boolean, isNullable: boolean, isUnique: boolean, args: any): CreateTableBuilder;
Parameter Type Description
name string
isPrimaryKey boolean
isNullable boolean
isUnique boolean
args any Additional dialect-specific arguments passed as an array to native.
Returns
Type: CreateTableBuilder
Description:

columnBigint()

Adds a BIGINT column.

ts
columnBigint(name: string, isPrimaryKey: boolean, isNullable: boolean, isUnique: boolean, isIdentity: boolean, args: any): CreateTableBuilder;
Parameter Type Description
name string
isPrimaryKey boolean
isNullable boolean
isUnique boolean
isIdentity boolean
args any Additional dialect-specific arguments passed as an array to native.
Returns
Type: CreateTableBuilder
Description:

columnSmallint()

Adds a SMALLINT column.

ts
columnSmallint(name: string, isPrimaryKey: boolean, isNullable: boolean, isUnique: boolean, args: any): CreateTableBuilder;
Parameter Type Description
name string
isPrimaryKey boolean
isNullable boolean
isUnique boolean
args any Additional dialect-specific arguments passed as an array to native.
Returns
Type: CreateTableBuilder
Description:

columnReal()

Adds a REAL column.

ts
columnReal(name: string, isPrimaryKey: boolean, isNullable: boolean, isUnique: boolean, args: any): CreateTableBuilder;
Parameter Type Description
name string
isPrimaryKey boolean
isNullable boolean
isUnique boolean
args any Additional dialect-specific arguments passed as an array to native.
Returns
Type: CreateTableBuilder
Description:

columnDouble()

Adds a DOUBLE column.

ts
columnDouble(name: string, isPrimaryKey: boolean, isNullable: boolean, isUnique: boolean, args: any): CreateTableBuilder;
Parameter Type Description
name string
isPrimaryKey boolean
isNullable boolean
isUnique boolean
args any Additional dialect-specific arguments passed as an array to native.
Returns
Type: CreateTableBuilder
Description:

columnBoolean()

Adds a BOOLEAN column.

ts
columnBoolean(name: string, isPrimaryKey: boolean, isNullable: boolean, isUnique: boolean, args: any): CreateTableBuilder;
Parameter Type Description
name string
isPrimaryKey boolean
isNullable boolean
isUnique boolean
args any Additional dialect-specific arguments passed as an array to native.
Returns
Type: CreateTableBuilder
Description:

columnBlob()

Adds a BLOB column.

ts
columnBlob(name: string, isNullable: boolean, args: any): CreateTableBuilder;
Parameter Type Description
name string
isNullable boolean
args any Additional dialect-specific arguments passed as an array to native.
Returns
Type: CreateTableBuilder
Description:

columnDecimal()

Adds a DECIMAL column with precision and scale.

ts
columnDecimal(name: string, precision: number, scale: number, isPrimaryKey: boolean, isNullable: boolean, isUnique: boolean, isIdentity: boolean, args: any): CreateTableBuilder;
Parameter Type Description
name string
precision number
scale number
isPrimaryKey boolean
isNullable boolean
isUnique boolean
isIdentity boolean
args any Additional dialect-specific arguments passed as an array to native.
Returns
Type: CreateTableBuilder
Description:

primaryKey()

ts
primaryKey(columns: any, name: string): CreateTableBuilder;
Parameter Type Description
columns any
name string
Returns
Type: CreateTableBuilder
Description:

foreignKey()

ts
foreignKey(name: string, columns: any, referencedTable: string, referencedColumns: any, referencedTableSchema: string): CreateTableBuilder;
Parameter Type Description
name string
columns any
referencedTable string
referencedColumns any
referencedTableSchema string
Returns
Type: CreateTableBuilder
Description:

unique()

ts
unique(name: string, columns: any): CreateTableBuilder;
Parameter Type Description
name string
columns any
Returns
Type: CreateTableBuilder
Description:

check()

ts
check(name: string, expression: string): CreateTableBuilder;
Parameter Type Description
name string
expression string
Returns
Type: CreateTableBuilder
Description:

CreateViewBuilder

prepareBuilder()

Hook for subclasses to set up the native builder object (e.g., calling .select()).

ts
prepareBuilder(builder: any): any;
Parameter Type Description
builder any
Returns
Type: any
Description:

parameters()

ts
parameters(): void;
Returns
Type: void
Description:

addParameter()

Adds parameter(s) to the internal list. Handles single values and arrays of values.

ts
addParameter(value: any): void;
Parameter Type Description
value any
Returns
Type: void
Description:

build()

Builds and returns the final SQL string.

ts
build(): string;
Returns
Type: string
Description:

column()

ts
column(column: string): CreateViewBuilder;
Parameter Type Description
column string
Returns
Type: CreateViewBuilder
Description:

asSelect()

ts
asSelect(select: string): CreateViewBuilder;
Parameter Type Description
select string
Returns
Type: CreateViewBuilder
Description:

CreateSequenceBuilder

prepareBuilder()

Hook for subclasses to set up the native builder object (e.g., calling .select()).

ts
prepareBuilder(builder: any): any;
Parameter Type Description
builder any
Returns
Type: any
Description:

parameters()

ts
parameters(): void;
Returns
Type: void
Description:

addParameter()

Adds parameter(s) to the internal list. Handles single values and arrays of values.

ts
addParameter(value: any): void;
Parameter Type Description
value any
Returns
Type: void
Description:

build()

Builds and returns the final SQL string.

ts
build(): string;
Returns
Type: string
Description:

DropBuilder

prepareBuilder()

Hook for subclasses to set up the native builder object (e.g., calling .select()).

ts
prepareBuilder(builder: any): any;
Parameter Type Description
builder any
Returns
Type: any
Description:

parameters()

ts
parameters(): void;
Returns
Type: void
Description:

addParameter()

Adds parameter(s) to the internal list. Handles single values and arrays of values.

ts
addParameter(value: any): void;
Parameter Type Description
value any
Returns
Type: void
Description:

build()

Builds and returns the final SQL string.

ts
build(): string;
Returns
Type: string
Description:

table()

ts
table(table: string): DropTableBuilder;
Parameter Type Description
table string
Returns
Type: DropTableBuilder
Description:

view()

ts
view(view: string): DropViewBuilder;
Parameter Type Description
view string
Returns
Type: DropViewBuilder
Description:

sequence()

ts
sequence(sequence: string): DropSequenceBuilder;
Parameter Type Description
sequence string
Returns
Type: DropSequenceBuilder
Description:

DropTableBuilder

prepareBuilder()

Hook for subclasses to set up the native builder object (e.g., calling .select()).

ts
prepareBuilder(builder: any): any;
Parameter Type Description
builder any
Returns
Type: any
Description:

parameters()

ts
parameters(): void;
Returns
Type: void
Description:

addParameter()

Adds parameter(s) to the internal list. Handles single values and arrays of values.

ts
addParameter(value: any): void;
Parameter Type Description
value any
Returns
Type: void
Description:

build()

Builds and returns the final SQL string.

ts
build(): string;
Returns
Type: string
Description:

DropViewBuilder

prepareBuilder()

Hook for subclasses to set up the native builder object (e.g., calling .select()).

ts
prepareBuilder(builder: any): any;
Parameter Type Description
builder any
Returns
Type: any
Description:

parameters()

ts
parameters(): void;
Returns
Type: void
Description:

addParameter()

Adds parameter(s) to the internal list. Handles single values and arrays of values.

ts
addParameter(value: any): void;
Parameter Type Description
value any
Returns
Type: void
Description:

build()

Builds and returns the final SQL string.

ts
build(): string;
Returns
Type: string
Description:

DropSequenceBuilder

prepareBuilder()

Hook for subclasses to set up the native builder object (e.g., calling .select()).

ts
prepareBuilder(builder: any): any;
Parameter Type Description
builder any
Returns
Type: any
Description:

parameters()

ts
parameters(): void;
Returns
Type: void
Description:

addParameter()

Adds parameter(s) to the internal list. Handles single values and arrays of values.

ts
addParameter(value: any): void;
Parameter Type Description
value any
Returns
Type: void
Description:

build()

Builds and returns the final SQL string.

ts
build(): string;
Returns
Type: string
Description:

SQL ​

Overview ​

Key Features ​

Use Cases ​

Example Usage ​

Classes ​

SQLBuilder ​

prepareBuilder() ​

parameters() ​

addParameter() ​

build() ​

getDialect() ​

select() ​

insert() ​

update() ​

delete() ​

nextval() ​

create() ​

drop() ​

SelectBuilder ​

parameters() ​

addParameter() ​

build() ​

prepareBuilder() ​

distinct() ​

forUpdate() ​

column() ​

from() ​

join() ​

innerJoin() ​

outerJoin() ​

leftJoin() ​

rightJoin() ​

fullJoin() ​

where() ​

order() ​

group() ​

limit() ​

offset() ​

having() ​

union() ​

InsertBuilder ​

parameters() ​

addParameter() ​

build() ​

prepareBuilder() ​

into() ​

column() ​

value() ​

select() ​

UpdateBuilder ​

parameters() ​

addParameter() ​

build() ​

prepareBuilder() ​

table() ​

set() ​

where() ​

DeleteBuilder ​

parameters() ​

addParameter() ​

build() ​

prepareBuilder() ​

from() ​

where() ​

NextvalBuilder ​

parameters() ​

addParameter() ​

build() ​

prepareBuilder() ​

CreateBuilder ​

prepareBuilder() ​

parameters() ​

addParameter() ​

build() ​

table() ​

view() ​

sequence() ​

CreateTableBuilder ​

prepareBuilder() ​

SQL

Overview

Key Features

Use Cases

Example Usage

Classes

SQLBuilder

prepareBuilder()

parameters()

addParameter()

build()

getDialect()

select()

insert()

update()

delete()

nextval()

create()

drop()

SelectBuilder

parameters()

addParameter()

build()

prepareBuilder()

distinct()

forUpdate()

column()

from()

join()

innerJoin()

outerJoin()

leftJoin()

rightJoin()

fullJoin()

where()

order()

group()

limit()

offset()

having()

union()

InsertBuilder

parameters()

addParameter()

build()

prepareBuilder()

into()

column()

value()

select()

UpdateBuilder

parameters()

addParameter()

build()

prepareBuilder()

table()

set()

where()

DeleteBuilder

parameters()

addParameter()

build()

prepareBuilder()

from()

where()

NextvalBuilder

parameters()

addParameter()

build()

prepareBuilder()

CreateBuilder

prepareBuilder()

parameters()

addParameter()

build()

table()

view()

sequence()

CreateTableBuilder

prepareBuilder()