Class QueryBuilder

Fluent SQL query builder.

Supports SELECT, INSERT, UPDATE, and DELETE operations with a chainable API.

Example: SELECT query

const sql = new QueryBuilder()
  .select("id", "name")
  .from("users")
  .where("active", "=", true)
  .limit(10)
  .build()

Example: INSERT query

const sql = new QueryBuilder()
  .insertInto("users")
  .columns("name", "email")
  .values("Alice", "alice@example.com")
  .build()

Example: UPDATE query

const sql = new QueryBuilder()
  .update("users")
  .set("status", "inactive")
  .where("last_login", "<", new Date("2024-01-01"))
  .build()

Example: DELETE query

const sql = new QueryBuilder()
  .deleteFrom("users")
  .where("status", "=", "deleted")
  .build()

Index

Constructors

constructor

new QueryBuilder(): QueryBuilder
Returns QueryBuilder

Methods

build

build(): string
Build the SQL query string.

Returns string
The complete SQL query string
- Defined in query-builder.ts:593

buildParameterized

buildParameterized(): BuiltQuery
Build query with parameter placeholders for prepared statements.

Returns BuiltQuery
Object containing SQL with placeholders and parameter values
- Defined in query-builder.ts:611

clone

clone(): QueryBuilder
Create a copy of this query builder.

Returns QueryBuilder
- Defined in query-builder.ts:626

columns

columns(...columns: string[]): this
Specify columns for INSERT.
Parameters
- ...columns: string[]
Returns this
- Defined in query-builder.ts:515

deleteFrom

deleteFrom(table: string): this
Start a DELETE statement.
Parameters
- table: string
  Table to delete from
Returns this
- Defined in query-builder.ts:578

distinct

distinct(): this
Select distinct rows only.

Returns this
- Defined in query-builder.ts:302

from

from(table: string, alias?: string): this
Specify the table to query from.
Parameters
- table: string
  Table name
- Optionalalias: string
  Optional table alias
Returns this
- Defined in query-builder.ts:313

groupBy

groupBy(...columns: string[]): this
Add GROUP BY columns.
Parameters
- ...columns: string[]
Returns this
- Defined in query-builder.ts:441

having

having(column: string, operator: ComparisonOperator, value: SqlValue): this
Add a HAVING condition.
Parameters
- column: string
- operator: ComparisonOperator
- value: SqlValue
Returns this
- Defined in query-builder.ts:449

innerJoin

innerJoin(table: string, on: string, alias?: string): this
Add an INNER JOIN clause.
Parameters
- table: string
- on: string
- Optionalalias: string
Returns this
- Defined in query-builder.ts:339

insertInto

insertInto(table: string): this
Start an INSERT statement.
Parameters
- table: string
  Table to insert into
Returns this
- Defined in query-builder.ts:506

join

join(type: JoinType, table: string, on: string, alias?: string): this
Add a JOIN clause.
Parameters
- type: JoinType
  Join type (INNER, LEFT, RIGHT, FULL, CROSS)
- table: string
  Table to join
- on: string
  Join condition
- Optionalalias: string
  Optional table alias
Returns this
- Defined in query-builder.ts:331

leftJoin

leftJoin(table: string, on: string, alias?: string): this
Add a LEFT JOIN clause.
Parameters
- table: string
- on: string
- Optionalalias: string
Returns this
- Defined in query-builder.ts:346

limit

limit(count: number): this
Set the maximum number of rows to return.
Parameters
- count: number
Returns this
- Defined in query-builder.ts:478

offset

offset(count: number): this
Set the number of rows to skip.
Parameters
- count: number
Returns this
- Defined in query-builder.ts:489

orderBy

orderBy(
    column: string,
    direction?: SortDirection,
    nulls?: "FIRST" | "LAST",
): this
Add ORDER BY clause.
Parameters
- column: string
  Column to order by
- direction: SortDirection = "ASC"
  Sort direction (ASC or DESC)
- Optionalnulls: "FIRST" | "LAST"
  NULLS FIRST or NULLS LAST
Returns this
- Defined in query-builder.ts:470

orWhere

orWhere(column: string, operator: ComparisonOperator, value: SqlValue): this
Add an OR WHERE condition.
Parameters
- column: string
- operator: ComparisonOperator
- value: SqlValue
Returns this
- Defined in query-builder.ts:389

reset

reset(): this
Reset the builder to initial state.

Returns this
- Defined in query-builder.ts:649

rightJoin

rightJoin(table: string, on: string, alias?: string): this
Add a RIGHT JOIN clause.
Parameters
- table: string
- on: string
- Optionalalias: string
Returns this
- Defined in query-builder.ts:353

select

select(...columns: ColumnSpec[]): this
Specify columns to select.
Parameters
- ...columns: ColumnSpec[]
  Column names or column specs with aliases
Returns this
this for chaining
Example
```
.select("id", "name")
.select({ column: "email", alias: "user_email" })
.select("*")
```
- Defined in query-builder.ts:293

set

set(column: string, value: SqlValue): this
Set a column value for UPDATE.
Parameters
- column: string
  Column to update
- value: SqlValue
  New value
Returns this
- Defined in query-builder.ts:552

setMany

setMany(values: Record<string, SqlValue>): this
Set multiple column values for UPDATE.
Parameters
- values: Record<string, SqlValue>
  Object mapping column names to values
Returns this
- Defined in query-builder.ts:562

update

update(table: string): this
Start an UPDATE statement.
Parameters
- table: string
  Table to update
Returns this
- Defined in query-builder.ts:540

values

values(...values: SqlValue[]): this
Add values to INSERT. Can be called multiple times for multi-row inserts.
Parameters
- ...values: SqlValue[]
  Values corresponding to columns
Returns this
- Defined in query-builder.ts:526

where

where(column: string, operator: ComparisonOperator, value: SqlValue): this
Add a WHERE condition.
Parameters
- column: string
  Column name
- operator: ComparisonOperator
  Comparison operator
- value: SqlValue
  Value to compare against
Returns this
Example
```
.where("status", "=", "active")
.where("age", ">=", 18)
.where("role", "IN", ["admin", "moderator"])
.where("deleted_at", "IS", null)
```
- Defined in query-builder.ts:376

whereBetween

whereBetween(column: string, min: SqlValue, max: SqlValue): this
Add a WHERE BETWEEN condition.
Parameters
- column: string
- min: SqlValue
- max: SqlValue
Returns this
- Defined in query-builder.ts:402

whereIn

whereIn(column: string, values: SqlValue[]): this
Add a WHERE IN condition.
Parameters
- column: string
- values: SqlValue[]
Returns this
- Defined in query-builder.ts:416

whereNotNull

whereNotNull(column: string): this
Add a WHERE IS NOT NULL condition.
Parameters
- column: string
Returns this
- Defined in query-builder.ts:430

whereNull

whereNull(column: string): this
Add a WHERE IS NULL condition.
Parameters
- column: string
Returns this
- Defined in query-builder.ts:423

Class QueryBuilder

Example: SELECT query

Example: INSERT query

Example: UPDATE query

Example: DELETE query

Index

Constructors

Methods

Constructors

constructor

Returns QueryBuilder

Methods

build

Returns string

buildParameterized

Returns BuiltQuery

clone

Returns QueryBuilder

columns

Parameters

Returns this

deleteFrom

Parameters

Returns this

distinct

Returns this

from

Parameters

Returns this

groupBy

Parameters

Returns this

having

Parameters

Returns this

innerJoin

Parameters

Returns this

insertInto

Parameters

Returns this

join

Parameters

Returns this

leftJoin

Parameters

Returns this

limit

Parameters

Returns this

offset

Parameters

Returns this

orderBy

Parameters

Returns this

orWhere

Parameters

Returns this

reset

Returns this

rightJoin

Parameters

Returns this

select

Parameters

Returns this

Example

set

Parameters

Returns this

setMany

Parameters

Returns this

update

Parameters

Returns this

values

Parameters

Returns this