Appearance

API: sql ​

Source: db/sql.ts

Union type representing all supported SQL data types.

Usage ​

javascript
import { sql } from "sdk/db";
import { response } from "sdk/http";

let script = sql.getDialect().select().column("FIRST_NAME").column("LAST_NAME").from("CUSTOMERS").build();

response.println(script);

response.flush();
response.close();

Classes ​

SQLBuilder ​

Main entry point for the SQL Builder. Acts as a factory for specific builders.

Methods ​

getDialect ​

  • getDialect (connection?:Connection):SQLBuilder

    Factory method to get a dialect-specific SQLBuilder instance.

select ​

  • select ():SelectBuilder

    Factory method to get a dialect-specific SQLBuilder instance.

insert ​

  • insert ():InsertBuilder

update ​

  • update ():UpdateBuilder

delete ​

  • delete ():DeleteBuilder

nextval ​

  • nextval (name:string):NextvalBuilder

create ​

  • create ():CreateBuilder

drop ​

  • drop ():DropBuilder

SelectBuilder ​

Builder for SELECT statements.

Methods ​

prepareBuilder ​

  • prepareBuilder (builder:any):any

    Builder for SELECT statements.

distinct ​

  • distinct ():SelectBuilder

    Builder for SELECT statements.

forUpdate ​

  • forUpdate ():SelectBuilder

column ​

  • column (column:string):SelectBuilder

from ​

  • from (table:string, alias?:string):SelectBuilder

join ​

  • join (table:string, on:string, alias?:string, parameters?:any|any[]):SelectBuilder

innerJoin ​

  • innerJoin (table:string, on:string, alias?:string, parameters?:any|any[]):SelectBuilder

outerJoin ​

  • outerJoin (table:string, on:string, alias?:string, parameters?:any|any[]):SelectBuilder

leftJoin ​

  • leftJoin (table:string, on:string, alias?:string, parameters?:any|any[]):SelectBuilder

rightJoin ​

  • rightJoin (table:string, on:string, alias?:string, parameters?:any|any[]):SelectBuilder

fullJoin ​

  • fullJoin (table:string, on:string, alias?:string, parameters?:any|any[]):SelectBuilder

where ​

  • where (condition:string, parameters?:any|any[]):SelectBuilder

    Sets the WHERE condition.
    @param condition The SQL condition string (e.g., "column1 = ?").
    @param parameters Optional parameters to replace '?' in the condition.

order ​

  • order (column:string, asc:boolean=true):SelectBuilder

group ​

  • group (column:string):SelectBuilder

limit ​

  • limit (limit:number):SelectBuilder

offset ​

  • offset (offset:number):SelectBuilder

having ​

  • having (having:string):SelectBuilder

union ​

  • union (select:string):SelectBuilder

InsertBuilder ​

Builder for INSERT statements.

Methods ​

prepareBuilder ​

  • prepareBuilder (builder:any):any

    Builder for INSERT statements.

into ​

  • into (table:string):InsertBuilder

    Builder for INSERT statements.

column ​

  • column (column:string):InsertBuilder

value ​

  • value (value:string, parameters?:any|any[]):InsertBuilder

    Sets the value for the last column specified.
    @param value The value placeholder (e.g., "?") or literal.
    @param parameters Optional parameters if a placeholder was used.

select ​

  • select (select:string):InsertBuilder

UpdateBuilder ​

Builder for UPDATE statements.

Methods ​

prepareBuilder ​

  • prepareBuilder (builder:any):any

    Builder for UPDATE statements.

table ​

  • table (table:string):UpdateBuilder

    Builder for UPDATE statements.

set ​

  • set (column:string, value:string, parameters?:any|any[]):UpdateBuilder

    Sets a column to a value.
    @param column The column name.
    @param value The value placeholder (e.g., "?") or literal.
    @param parameters Optional parameters if a placeholder was used.

where ​

  • where (condition:string, parameters?:any|any[]):UpdateBuilder

    Sets the WHERE condition for the update.
    @param condition The SQL condition string (e.g., "column1 = ?").
    @param parameters Optional parameters to replace '?' in the condition.

DeleteBuilder ​

Builder for DELETE statements.

Methods ​

prepareBuilder ​

  • prepareBuilder (builder:any):any

    Builder for DELETE statements.

from ​

  • from (table:string):DeleteBuilder

    Builder for DELETE statements.

where ​

  • where (condition:string, parameters?:any|any[]):DeleteBuilder

    Sets the WHERE condition for the deletion.
    @param condition The SQL condition string (e.g., "column1 = ?").
    @param parameters Optional parameters to replace '?' in the condition.

NextvalBuilder ​

Builder for selecting the next value from a sequence.

Methods ​

prepareBuilder ​

  • prepareBuilder (builder:any):any

CreateBuilder ​

Builder for CREATE statements (Table, View, Sequence).

Methods ​

table ​

  • table (table:string):CreateTableBuilder

    Builder for CREATE statements (Table, View, Sequence).

view ​

  • view (view:string):CreateViewBuilder

sequence ​

  • sequence (sequence:string):CreateSequenceBuilder

CreateTableBuilder ​

Builder for CREATE TABLE statements.

Methods ​

column ​

  • column (name:string, type:DataType, isPrimaryKey=false, isNullable=true, isUnique=false, isIdentity=false, isFuzzyIndexEnabled=false, ...args:string[]):CreateTableBuilder

    Adds a generic column definition.
    @param args Additional dialect-specific arguments passed as an array to native.

columnVarchar ​

  • columnVarchar (name:string, length:number, isPrimaryKey=false, isNullable=true, isUnique=false, isIdentity=false, ...args:string[]):CreateTableBuilder

    Adds a VARCHAR column.
    @param args Additional dialect-specific arguments passed as an array to native.

columnNvarchar ​

  • columnNvarchar (name:string, length:number, isPrimaryKey=false, isNullable=true, isUnique=false, isIdentity=false, ...args:string[]):CreateTableBuilder

    Adds an NVARCHAR column.
    @param args Additional dialect-specific arguments passed as an array to native.

columnChar ​

  • columnChar (name:string, length:number, isPrimaryKey=false, isNullable=true, isUnique=false, isIdentity=false, ...args:string[]):CreateTableBuilder

    Adds a CHAR column.
    @param args Additional dialect-specific arguments passed as an array to native.

columnDate ​

  • columnDate (name:string, isPrimaryKey=false, isNullable=true, isUnique=false, ...args:string[]):CreateTableBuilder

    Adds a DATE column.
    @param args Additional dialect-specific arguments passed as an array to native.

columnTime ​

  • columnTime (name:string, isPrimaryKey=false, isNullable=true, isUnique=false, ...args:string[]):CreateTableBuilder

    Adds a TIME column.
    @param args Additional dialect-specific arguments passed as an array to native.

columnTimestamp ​

  • columnTimestamp (name:string, isPrimaryKey=false, isNullable=true, isUnique=false, ...args:string[]):CreateTableBuilder

    Adds a TIMESTAMP column.
    @param args Additional dialect-specific arguments passed as an array to native.

columnInteger ​

  • columnInteger (name:string, isPrimaryKey=false, isNullable=true, isUnique=false, isIdentity=false, ...args:string[]):CreateTableBuilder

    Adds an INTEGER column.
    @param args Additional dialect-specific arguments passed as an array to native.

columnTinyint ​

  • columnTinyint (name:string, isPrimaryKey=false, isNullable=true, isUnique=false, ...args:string[]):CreateTableBuilder

    Adds a TINYINT column.
    @param args Additional dialect-specific arguments passed as an array to native.

columnBigint ​

  • columnBigint (name:string, isPrimaryKey=false, isNullable=true, isUnique=false, isIdentity=false, ...args:string[]):CreateTableBuilder

    Adds a BIGINT column.
    @param args Additional dialect-specific arguments passed as an array to native.

columnSmallint ​

  • columnSmallint (name:string, isPrimaryKey=false, isNullable=true, isUnique=false, ...args:string[]):CreateTableBuilder

    Adds a SMALLINT column.
    @param args Additional dialect-specific arguments passed as an array to native.

columnReal ​

  • columnReal (name:string, isPrimaryKey=false, isNullable=true, isUnique=false, ...args:string[]):CreateTableBuilder

    Adds a REAL column.
    @param args Additional dialect-specific arguments passed as an array to native.

columnDouble ​

  • columnDouble (name:string, isPrimaryKey=false, isNullable=true, isUnique=false, ...args:string[]):CreateTableBuilder

    Adds a DOUBLE column.
    @param args Additional dialect-specific arguments passed as an array to native.

columnBoolean ​

  • columnBoolean (name:string, isPrimaryKey=false, isNullable=true, isUnique=false, ...args:string[]):CreateTableBuilder

    Adds a BOOLEAN column.
    @param args Additional dialect-specific arguments passed as an array to native.

columnBlob ​

  • columnBlob (name:string, isNullable=true, ...args:string[]):CreateTableBuilder

    Adds a BLOB column.
    @param args Additional dialect-specific arguments passed as an array to native.

columnDecimal ​

  • columnDecimal (name:string, precision:number, scale:number, isPrimaryKey=false, isNullable=true, isUnique=false, isIdentity=false, ...args:string[]):CreateTableBuilder

    Adds a DECIMAL column with precision and scale.
    @param args Additional dialect-specific arguments passed as an array to native.

primaryKey ​

  • primaryKey (columns:string[], name?:string):CreateTableBuilder

foreignKey ​

  • foreignKey (name:string, columns:string[], referencedTable:string, referencedColumns:string[], referencedTableSchema?:string):CreateTableBuilder

unique ​

  • unique (name:string, columns:string[]):CreateTableBuilder

check ​

  • check (name:string, expression:string):CreateTableBuilder

CreateViewBuilder ​

Builder for CREATE VIEW statements.

Methods ​

column ​

  • column (column:string):CreateViewBuilder

asSelect ​

  • asSelect (select:string):CreateViewBuilder

CreateSequenceBuilder ​

Builder for CREATE SEQUENCE statements.

DropBuilder ​

Builder for DROP statements (Table, View, Sequence).

Methods ​

table ​

  • table (table:string):DropTableBuilder

    Builder for DROP statements (Table, View, Sequence).

view ​

  • view (view:string):DropViewBuilder

sequence ​

  • sequence (sequence:string):DropSequenceBuilder

DropTableBuilder ​

Builder for DROP TABLE statements.

DropViewBuilder ​

Builder for DROP VIEW statements.

DropSequenceBuilder ​

Builder for DROP SEQUENCE statements.