AbstractBuilder | The Extollo Framework

A base class that facilitates building database queries using a fluent interface. This can be specialized by child-classes to yield query results of the given type T.

Type parameters

Hierarchy

AppClass
- AbstractBuilder
  - Builder
  - ModelBuilder

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new AbstractBuilder<T>(): AbstractBuilder<T>

Inherited from AppClass.constructor

Type parameters
- T
Returns AbstractBuilder<T>

Properties

Protected constraints

constraints: Constraint[] = []

Constraints applied to this query.

Protected Readonly databaseService

databaseService: DatabaseService

Protected Optional rawSql

rawSql: string

Raw SQL to use instead. Overrides builder methods.

Protected Optional registeredConnection

registeredConnection: Connection

The connection on which the query should be executed.

Protected registeredDistinct

registeredDistinct: boolean = false

If true, the query should refer to distinct records.

Protected registeredFields

registeredFields: SpecifiedField[] = []

The fields to query from the table.

Protected registeredGroupings

registeredGroupings: string[] = []

Array of SQL group-by clauses.

Protected registeredOrders

registeredOrders: OrderStatement[] = []

Array of SQL order-by clauses.

Protected Optional registeredSkip

registeredSkip: number

The number of records to skip before the result set.

Protected Optional registeredTake

registeredTake: number

The max number of records to include in the result set.

Protected Optional source

source: QuerySource

The source table to query from.

Accessors

Private appClassApplication

get appClassApplication(): Application

- Defined in src/lifecycle/AppClass.ts:31
The global application instance.

Returns Application

appliedConstraints

get appliedConstraints(): Constraint[]

- Defined in src/orm/builder/AbstractBuilder.ts:100
Get the constraints applied to this query.

Returns Constraint[]

appliedDistinction

get appliedDistinction(): boolean

- Defined in src/orm/builder/AbstractBuilder.ts:116
True if the query should be DISTINCT

Returns boolean

appliedFields

get appliedFields(): SpecifiedField[]

- Defined in src/orm/builder/AbstractBuilder.ts:105
Get the fields that should be included in this query.

Returns SpecifiedField[]

appliedGroupings

get appliedGroupings(): string[]

- Defined in src/orm/builder/AbstractBuilder.ts:121
Get the SQL group-by clauses applied to this query.

Returns string[]

appliedOrder

get appliedOrder(): OrderStatement[]

- Defined in src/orm/builder/AbstractBuilder.ts:126
Get the SQL order-by clauses applied to this query.

Returns OrderStatement[]

appliedPagination

get appliedPagination(): { skip: undefined | number; take: undefined | number }

- Defined in src/orm/builder/AbstractBuilder.ts:110
Get the skip/take values of this query.

Returns { skip: undefined | number; take: undefined | number }
- skip: undefined | number
- take: undefined | number

appliedRawSql

get appliedRawSql(): Maybe<string>

- Defined in src/orm/builder/AbstractBuilder.ts:131
Get the raw SQL overriding the builder methods, if it exists.

Returns Maybe<string>

querySource

get querySource(): undefined | QuerySource

- Defined in src/orm/builder/AbstractBuilder.ts:136
Get the source table for this query.

Returns undefined | QuerySource

Methods

Protected app

app(): Application

Inherited from AppClass.app
- Defined in src/lifecycle/AppClass.ts:36
Get the global Application.

Returns Application

clearFields

clearFields(): AbstractBuilder<T>

- Defined in src/orm/builder/AbstractBuilder.ts:209
Remove all selected fields from this query.

Returns AbstractBuilder<T>

clone

clone(): AbstractBuilder<T>

- Defined in src/orm/builder/AbstractBuilder.ts:82
Clone the current query to a new AbstractBuilder instance with the same properties.

Returns AbstractBuilder<T>

connection

connection(nameOrInstance: string | Connection): AbstractBuilder<T>

- Defined in src/orm/builder/AbstractBuilder.ts:442
Specify the connection name or instance to execute the query on.

Parameters
- nameOrInstance: string | Connection
Returns AbstractBuilder<T>

Protected container

container(): Container

Inherited from AppClass.container
- Defined in src/lifecycle/AppClass.ts:41
Get the global Container.

Returns Container

Private createConstraint

createConstraint(preop: ConstraintConnectionOperator, field: string | ConstraintGroupClosure<T>, operator?: ConstraintOperator, operand?: any): void

- Defined in src/orm/builder/AbstractBuilder.ts:598
Adds a constraint to this query. This is used internally by the various where, whereIn, orWhereNot, &c.

Parameters
- preop: ConstraintConnectionOperator
- field: string | ConstraintGroupClosure<T>
- Optional operator: ConstraintOperator
- Optional operand: any
Returns void

delete

delete(): Promise<QueryResult>

- Defined in src/orm/builder/AbstractBuilder.ts:520
Execute a DELETE based on this query.
example
```
query.table('my_table').where('id', <, 44).delete()
```
This is equivalent to:
```
DELETE
FROM my_table
WHERE
 id < 44
```
Returns Promise<QueryResult>

distinct

distinct(): AbstractBuilder<T>

- Defined in src/orm/builder/AbstractBuilder.ts:377
Make the query return only distinct rows.

Returns AbstractBuilder<T>

exists

exists(): Promise<boolean>

- Defined in src/orm/builder/AbstractBuilder.ts:565
Returns true if at least one row matches the current query.

Returns Promise<boolean>

field

field(field: string | QuerySafeValue, alias?: string): AbstractBuilder<T>

- Defined in src/orm/builder/AbstractBuilder.ts:171
Include the given field (and optional alias) in the query.

Parameters
- field: string | QuerySafeValue
- Optional alias: string
Returns AbstractBuilder<T>

fields

fields(...fields: SpecifiedField[]): AbstractBuilder<T>

- Defined in src/orm/builder/AbstractBuilder.ts:185
Include the given fields in the query.

Parameters
- Rest ...fields: SpecifiedField[]
Returns AbstractBuilder<T>

finalize

finalize(): AbstractBuilder<T>

- Defined in src/orm/builder/AbstractBuilder.ts:75
Get a copy of this builder with its values finalized.

Returns AbstractBuilder<T>

first

first(): Promise<undefined | T>

- Defined in src/orm/builder/AbstractBuilder.ts:473
Get the first record matched by this query, if it exists.

Returns Promise<undefined | T>

from

from(table: string, alias?: string): AbstractBuilder<T>

- Defined in src/orm/builder/AbstractBuilder.ts:147
Set the source table (and optional alias) for this query.

Parameters
- table: string
- Optional alias: string
Returns AbstractBuilder<T>

get

get(): ResultCollection<T>

- Defined in src/orm/builder/AbstractBuilder.ts:466
Get an async collection of the rows resulting from this query.

Returns ResultCollection<T>

getBoundMethod

getBoundMethod(methodName: string): (...args: any[]) => any

Inherited from AppClass.getBoundMethod
- Defined in src/lifecycle/AppClass.ts:55
Get the method with the given name from this class, bound to this class.

Parameters
- methodName: string
Returns (...args: any[]) => any

function
- - (...args: any[]): any
  - Parameters
    - Rest ...args: any[]
    Returns any

Abstract getNewInstance

getNewInstance(): AbstractBuilder<T>

- Defined in src/orm/builder/AbstractBuilder.ts:65
Create a new, empty, instance of the current builder.

Returns AbstractBuilder<T>

Abstract getResultIterable

getResultIterable(): AbstractResultIterable<T>

- Defined in src/orm/builder/AbstractBuilder.ts:70
Get a result iterable for the built query.

Returns AbstractResultIterable<T>

groupBy

groupBy(...groupings: string[]): AbstractBuilder<T>

- Defined in src/orm/builder/AbstractBuilder.ts:406
Apply one or more GROUP-BY clauses to the query.

Parameters
- Rest ...groupings: string[]
Returns AbstractBuilder<T>

insert

insert(rowOrRows: {} | {}[]): Promise<QueryResult>

- Defined in src/orm/builder/AbstractBuilder.ts:553
Insert the given rows into the table for this query, returning the fields specified in this query.
example
```
const rows = [
 { name: 'A' },
 { name: 'B' },
]

query.table('my_table')
 .returning('id', 'name')
 .insert(rows)
```
This is equivalent to:
```
INSERT INTO my_table (name)
VALUES ('A'), ('B')
RETURNING id, name
```
Parameters
- rowOrRows: {} | {}[]
Returns Promise<QueryResult>

iterator

iterator(): AbstractResultIterable<T>

- Defined in src/orm/builder/AbstractBuilder.ts:455
Get a result iterable for the rows of this query.

Returns AbstractResultIterable<T>

limit

limit(rows: number): AbstractBuilder<T>

- Defined in src/orm/builder/AbstractBuilder.ts:344
Limit the query to a maximum number of rows.

Parameters
- rows: number
Returns AbstractBuilder<T>

Protected make

make<T>(target: any, ...parameters: any[]): T

Inherited from AppClass.make
- Defined in src/lifecycle/AppClass.ts:46
Call the make() method on the global container.

Type parameters
- T
Parameters
- target: any
- Rest ...parameters: any[]
Returns T

notDistinct

notDistinct(): AbstractBuilder<T>

- Defined in src/orm/builder/AbstractBuilder.ts:385
Allow the query to return non-distinct rows. (Undoes distinct().)

Returns AbstractBuilder<T>

offset

offset(rows: number): AbstractBuilder<T>

- Defined in src/orm/builder/AbstractBuilder.ts:370
Alias of skip().

Parameters
- rows: number
Returns AbstractBuilder<T>

orWhere

orWhere(field: string | ConstraintGroupClosure<T>, operator?: ConstraintOperator, operand?: EscapeValue): AbstractBuilder<T>

- Defined in src/orm/builder/AbstractBuilder.ts:253
Apply an OR WHERE constraint to the query.

Parameters
- field: string | ConstraintGroupClosure<T>
- Optional operator: ConstraintOperator
- Optional operand: EscapeValue
Returns AbstractBuilder<T>

orWhereIn

orWhereIn(field: string, values: EscapeValue): AbstractBuilder<T>

- Defined in src/orm/builder/AbstractBuilder.ts:315
Apply an OR WHERE IN constraint to the query, escaping the values in the set.

Parameters
- field: string
- values: EscapeValue
Returns AbstractBuilder<T>

orWhereNot

orWhereNot(field: string | ConstraintGroupClosure<T>, operator?: ConstraintOperator, operand?: EscapeValue): AbstractBuilder<T>

- Defined in src/orm/builder/AbstractBuilder.ts:264
Apply an OR WHERE NOT constraint to the query.

Parameters
- field: string | ConstraintGroupClosure<T>
- Optional operator: ConstraintOperator
- Optional operand: EscapeValue
Returns AbstractBuilder<T>

orWhereNotIn

orWhereNotIn(field: string, values: EscapeValue): AbstractBuilder<T>

- Defined in src/orm/builder/AbstractBuilder.ts:330
Apply an OR WHERE NOT IN constraint to the query, escaping the values in the set.

Parameters
- field: string
- values: EscapeValue
Returns AbstractBuilder<T>

orWhereRaw

orWhereRaw(field: string, operator: ConstraintOperator, operand: string): AbstractBuilder<T>

- Defined in src/orm/builder/AbstractBuilder.ts:275
Apply an OR WHERE constraint to the query, without escaping operand. Prefer orWhere().

Parameters
- field: string
- operator: ConstraintOperator
- operand: string
Returns AbstractBuilder<T>

orderBy

orderBy(field: string, direction?: OrderDirection): AbstractBuilder<T>

- Defined in src/orm/builder/AbstractBuilder.ts:416
Order the query by the given field.

Parameters
- field: string
- direction: OrderDirection = 'ASC'
Returns AbstractBuilder<T>

orderByAscending

orderByAscending(field: string): AbstractBuilder<T>

- Defined in src/orm/builder/AbstractBuilder.ts:426
Order the query by the given field, ascending.

Parameters
- field: string
Returns AbstractBuilder<T>

orderByDescending

orderByDescending(field: string): AbstractBuilder<T>

- Defined in src/orm/builder/AbstractBuilder.ts:434
Order the query by the given field, descending.

Parameters
- field: string
Returns AbstractBuilder<T>

raw

raw(sql: string): AbstractBuilder<T>

- Defined in src/orm/builder/AbstractBuilder.ts:585
Set the query manually. Overrides any builder methods.
example
```
(new Builder())
 .raw('SELECT NOW() AS example_column')
 .get()
```
Parameters
- sql: string
Returns AbstractBuilder<T>

returning

returning(...fields: SpecifiedField[]): AbstractBuilder<T>

- Defined in src/orm/builder/AbstractBuilder.ts:194
Alias of fields().

Parameters
- Rest ...fields: SpecifiedField[]
Returns AbstractBuilder<T>

select

select(...fields: SpecifiedField[]): AbstractBuilder<T>

- Defined in src/orm/builder/AbstractBuilder.ts:202
Alias of fields().

Parameters
- Rest ...fields: SpecifiedField[]
Returns AbstractBuilder<T>

skip

skip(rows: number): AbstractBuilder<T>

- Defined in src/orm/builder/AbstractBuilder.ts:361
Skip the first rows many rows in the result set.

Parameters
- rows: number
Returns AbstractBuilder<T>

table

table(table: string, alias?: string): AbstractBuilder<T>

- Defined in src/orm/builder/AbstractBuilder.ts:162
Alias of from().

Parameters
- table: string
- Optional alias: string
Returns AbstractBuilder<T>

take

take(rows: number): AbstractBuilder<T>

- Defined in src/orm/builder/AbstractBuilder.ts:353
Alias of limit().

Parameters
- rows: number
Returns AbstractBuilder<T>

update

update(data: {}): Promise<QueryResult>

- Defined in src/orm/builder/AbstractBuilder.ts:494
Run an UPDATE query for all rows matched by this query, setting the given data.
example
```
query.table('my_table').update({ my_col: 4 })
```
This is equivalent to:
```
UPDATE TO my_table
SET
 my_col = 4
```
Parameters
- data: {}
  - [key: string]: EscapeValue
Returns Promise<QueryResult>

where

where(field: string | ConstraintGroupClosure<T>, operator?: ConstraintOperator, operand?: EscapeValue): AbstractBuilder<T>

- Defined in src/orm/builder/AbstractBuilder.ts:220
Apply a new WHERE constraint to the query.

Parameters
- field: string | ConstraintGroupClosure<T>
- Optional operator: ConstraintOperator
- Optional operand: EscapeValue
Returns AbstractBuilder<T>

whereIn

whereIn(field: string, values: EscapeValue): AbstractBuilder<T>

- Defined in src/orm/builder/AbstractBuilder.ts:285
Apply a WHERE IN constraint to the query, escaping the values in the set.

Parameters
- field: string
- values: EscapeValue
Returns AbstractBuilder<T>

whereNot

whereNot(field: string | ConstraintGroupClosure<T>, operator?: ConstraintOperator, operand?: EscapeValue): AbstractBuilder<T>

- Defined in src/orm/builder/AbstractBuilder.ts:242
Apply a new WHERE NOT constraint to the query.

Parameters
- field: string | ConstraintGroupClosure<T>
- Optional operator: ConstraintOperator
- Optional operand: EscapeValue
Returns AbstractBuilder<T>

whereNotIn

whereNotIn(field: string, values: EscapeValue): AbstractBuilder<T>

- Defined in src/orm/builder/AbstractBuilder.ts:300
Apply a WHERE NOT IN constraint to the query, escaping the values in the set.

Parameters
- field: string
- values: EscapeValue
Returns AbstractBuilder<T>

whereRaw

whereRaw(field: string, operator: ConstraintOperator, operand: string): AbstractBuilder<T>

- Defined in src/orm/builder/AbstractBuilder.ts:231
Apply a new WHERE constraint to the query, without escaping operand. Prefer where().

Parameters
- field: string
- operator: ConstraintOperator
- operand: string
Returns AbstractBuilder<T>

Type parameters

T

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type parameters

T

Returns AbstractBuilder<T>

Properties

Protected constraints

Protected Readonly databaseService

Protected Optional rawSql

Protected Optional registeredConnection

Protected registeredDistinct

Protected registeredFields

Protected registeredGroupings

Protected registeredOrders

Protected Optional registeredSkip

Protected Optional registeredTake

Protected Optional source

Accessors

Private appClassApplication

Returns Application

appliedConstraints

Returns Constraint[]

appliedDistinction

Returns boolean

appliedFields

Returns SpecifiedField[]

appliedGroupings

Returns string[]

appliedOrder

Returns OrderStatement[]

appliedPagination

Returns { skip: undefined | number; take: undefined | number }

skip: undefined | number

take: undefined | number

appliedRawSql

Returns Maybe<string>

querySource

Returns undefined | QuerySource

Methods

Protected app

Returns Application

clearFields

Returns AbstractBuilder<T>

clone

Returns AbstractBuilder<T>

connection

Parameters

nameOrInstance: string | Connection

Returns AbstractBuilder<T>

Protected container

Returns Container

Private createConstraint

Parameters

preop: ConstraintConnectionOperator

field: string | ConstraintGroupClosure<T>

Optional operator: ConstraintOperator

Optional operand: any

Returns void

delete

Returns Promise<QueryResult>

distinct

Returns AbstractBuilder<T>

exists

Returns Promise<boolean>

field

Parameters

field: string | QuerySafeValue

Optional alias: string

Returns AbstractBuilder<T>

fields

Parameters

Rest ...fields: SpecifiedField[]