Class SQLBuilder

Implements

SQLBuilderPort

Index

Constructors

Methods

column from groupBy having join leftJoin limit offset orderBy toSQL where

Constructors

constructor

new SQLBuilder(): SQLBuilder
Returns SQLBuilder
- Defined in builder.ts:30

Methods

column

column(name: SQLBuilderField, as?: string): this
Specified select column.
```
builder.column('id')
// `id`
```
Parameters
- name: SQLBuilderField
  Specified column's name.
- Optionalas: string
Returns this
Implementation of SQLBuilderPort.column
- Defined in builder.ts:40

from

from(name: string, as?: string): this
Specified table name.
```
builder.from('users')
// FROM `users`
```
Parameters
- name: string
- Optionalas: string
Returns this
Implementation of SQLBuilderPort.from
- Defined in builder.ts:45

groupBy

groupBy(field: SQLBuilderField): this
Specified group-by condition.
```
builder.groupBy('age')
```
Parameters
- field: SQLBuilderField
Returns this
Implementation of SQLBuilderPort.groupBy
- Defined in builder.ts:73

having

having(...args: SQLBuilderConditionInputPattern): this
Specified having condition.
```
builder.having('value', 1)
builder.having('value', [1, 5, 10])
```
Parameters
- ...args: SQLBuilderConditionInputPattern
Returns this
Implementation of SQLBuilderPort.having
- Defined in builder.ts:68

join

join(
direction: SQLBuilderJoinDirection,
...args: [string, string] | [string, string, string],
): this
Specified join.
Parameters
- direction: SQLBuilderJoinDirection
- ...args: [string, string] | [string, string, string]
Returns this
Implementation of SQLBuilderPort.join
- Defined in builder.ts:55

leftJoin

leftJoin(...args: [string, string] | [string, string, string]): this
Sepcified left join
```
builder.leftJoin('passport', 'passport.id = user.passport_id')
// LEFT JOIN `passport` ON passport.id = user.passport_id
```
Parameters
- ...args: [string, string] | [string, string, string]
Returns this
Implementation of SQLBuilderPort.leftJoin
- Defined in builder.ts:50

limit

limit(value: number): this
Specified limit value.
```
builder.limit(1)
```
Parameters
- value: number
Returns this
Implementation of SQLBuilderPort.limit
- Defined in builder.ts:83

offset

offset(value: number): this
Specified offset value.
```
builder.offset(1)
```
Parameters
- value: number
Returns this
Implementation of SQLBuilderPort.offset
- Defined in builder.ts:88

orderBy

orderBy(field: SQLBuilderField, direction: SQLBuilderOrderDirection): this
Specified order-by condition.
```
builder.orderBy('id', 'asc')
builder.orderBy('id', 'desc')
```
Parameters
- field: SQLBuilderField
- direction: SQLBuilderOrderDirection
Returns this
Implementation of SQLBuilderPort.orderBy
- Defined in builder.ts:78

toSQL

toSQL(input?: SQLBuilderToSQLInputOptions): [string, SQLBuilderBindingValue[]]
Returnes SQL and Binding values.
```
const [sql, bindings] = builder.toSQL()
```
Parameters
- Optionalinput: SQLBuilderToSQLInputOptions
Returns [string, SQLBuilderBindingValue[]]
Implementation of SQLBuilderPort.toSQL
- Defined in builder.ts:93

where

where(...args: SQLBuilderConditionInputPattern): this
Specified search condition.
```
builder.where('id', 1)
builder.where('id', [1, 2, 3]) // use `IN`
```
Parameters
- ...args: SQLBuilderConditionInputPattern
Returns this
Implementation of SQLBuilderPort.where
- Defined in builder.ts:63