Class SelectBuilder

Fluent builder for SELECT queries.

Example

const sql = select('id', 'name')
  .from('users')
  .where(col('status').eq(lit('active')))
  .orderBy(col('name').asc())
  .limit(10)
  .toSql('postgresql');

Index

Constructors

constructor

Constructors

constructor

new SelectBuilder(): SelectBuilder
Returns SelectBuilder
- Defined in builders.ts:548

Methods

build

build(): any
Return the Expression AST as a plain JS object.

Returns any
- Defined in builders.ts:716

crossJoin

crossJoin(tableName: string): this
Add a CROSS JOIN.
Parameters
- tableName: string
Returns this
- Defined in builders.ts:589

ctas

ctas(tableName: string): any
Convert to CREATE TABLE AS SELECT and return the AST. This is a terminal operation that consumes the builder.
Parameters
- tableName: string
Returns any
- Defined in builders.ts:672

ctasSql

ctasSql(tableName: string, dialect?: string): string
Convert to CREATE TABLE AS SELECT and return generated SQL. This is a terminal operation that consumes the builder.
Parameters
- tableName: string
- dialect: string = 'generic'
Returns string
- Defined in builders.ts:680

distinct

distinct(): this
Enable DISTINCT.

Returns this
- Defined in builders.ts:633

except

except(other: SelectBuilder): SetOpBuilder
Combine with EXCEPT.
Parameters
- other: SelectBuilder
Returns SetOpBuilder
- Defined in builders.ts:706

forUpdate

forUpdate(): this
Add FOR UPDATE locking.

Returns this
- Defined in builders.ts:685

free

free(): void
Free the underlying WASM handle.

Returns void
- Defined in builders.ts:721

from

from(tableOrExpr: string | Expr): this
Set the FROM clause.
Parameters
- tableOrExpr: string | Expr
Returns this
- Defined in builders.ts:564

groupBy

groupBy(...cols: ExprInput[]): this
Set the GROUP BY clause.
Parameters
- ...cols: ExprInput[]
Returns this
- Defined in builders.ts:603

having

having(condition: ExprInput): this
Set the HAVING clause.
Parameters
- condition: ExprInput
Returns this
- Defined in builders.ts:609

hint

hint(text: string): this
Add a query hint (e.g. Oracle hint expressions).
Parameters
- text: string
Returns this
- Defined in builders.ts:663

intersect

intersect(other: SelectBuilder): SetOpBuilder
Combine with INTERSECT.
Parameters
- other: SelectBuilder
Returns SetOpBuilder
- Defined in builders.ts:701

join

join(tableName: string, on: ExprInput): this
Add an INNER JOIN.
Parameters
- tableName: string
- on: ExprInput
Returns this
- Defined in builders.ts:571

lateral

lateral(funcExpr: Expr, tableAlias: string, colAliases: string[]): this
Add a LATERAL VIEW clause (Hive/Spark UDTF expansion).
Parameters
- funcExpr: Expr
- tableAlias: string
- colAliases: string[]
Returns this
- Defined in builders.ts:657

leftJoin

leftJoin(tableName: string, on: ExprInput): this
Add a LEFT JOIN.
Parameters
- tableName: string
- on: ExprInput
Returns this
- Defined in builders.ts:577

limit

limit(n: number): this
Set the LIMIT.
Parameters
- n: number
Returns this
- Defined in builders.ts:621

offset

offset(n: number): this
Set the OFFSET.
Parameters
- n: number
Returns this
- Defined in builders.ts:627

orderBy

orderBy(...exprs: ExprInput[]): this
Set the ORDER BY clause.
Parameters
- ...exprs: ExprInput[]
Returns this
- Defined in builders.ts:615

qualify

qualify(condition: ExprInput): this
Set the QUALIFY clause (Snowflake/BigQuery/DuckDB).
Parameters
- condition: ExprInput
Returns this
- Defined in builders.ts:639

rightJoin

rightJoin(tableName: string, on: ExprInput): this
Add a RIGHT JOIN.
Parameters
- tableName: string
- on: ExprInput
Returns this
- Defined in builders.ts:583

select

select(...columns: ExprInput[]): this
Add columns to the SELECT list. Accepts Expr, strings (→ col), or '*'.
Parameters
- ...columns: ExprInput[]
Returns this
- Defined in builders.ts:553

sortBy

sortBy(...exprs: ExprInput[]): this
Set the SORT BY clause (Hive/Spark — sorts within each partition).
Parameters
- ...exprs: ExprInput[]
Returns this
- Defined in builders.ts:645

toSql

toSql(dialect?: string): string
Generate SQL string. Defaults to generic dialect.
Parameters
- dialect: string = 'generic'
Returns string
- Defined in builders.ts:711

union

union(other: SelectBuilder): SetOpBuilder
Combine with UNION.
Parameters
- other: SelectBuilder
Returns SetOpBuilder
- Defined in builders.ts:691

unionAll

unionAll(other: SelectBuilder): SetOpBuilder
Combine with UNION ALL.
Parameters
- other: SelectBuilder
Returns SetOpBuilder
- Defined in builders.ts:696

where

where(condition: ExprInput): this
Set the WHERE clause. Accepts an Expr or a raw SQL string.
Parameters
- condition: ExprInput
Returns this
- Defined in builders.ts:595

window

window(name: string, def: WindowDefBuilder): this
Add a named WINDOW clause definition.
Parameters
- name: string
- def: WindowDefBuilder
Returns this
- Defined in builders.ts:651

Class SelectBuilder

Example

Index

Constructors

Methods

Constructors

constructor

Returns SelectBuilder

Methods

build

Returns any

crossJoin

Parameters

Returns this

ctas

Parameters

Returns any

ctasSql

Parameters

Returns string

distinct

Returns this

except

Parameters

Returns SetOpBuilder

forUpdate

Returns this

free

Returns void

from

Parameters

Returns this

groupBy

Parameters

Returns this

having

Parameters

Returns this

hint

Parameters

Returns this

intersect

Parameters

Returns SetOpBuilder

join

Parameters

Returns this

lateral

Parameters

Returns this

leftJoin

Parameters

Returns this

limit

Parameters

Returns this

offset

Parameters

Returns this

orderBy

Parameters

Returns this

qualify

Parameters

Returns this

rightJoin

Parameters

Returns this

select

Parameters

Returns this

sortBy

Parameters

Returns this

toSql

Parameters

Returns string

union

Parameters

Returns SetOpBuilder