RelationBuilder | The Extollo Framework

ModelBuilder instance that queries the related model in a relation.

Type parameters

T: Model<T>

Hierarchy

ModelBuilder<T>
- RelationBuilder

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new RelationBuilder<T>(relation: Relation<any, T, any>): RelationBuilder<T>

Overrides ModelBuilder.constructor
- Defined in src/orm/model/relation/RelationBuilder.ts:8
Type parameters
- T: Model<T, T>
Parameters
- relation: Relation<any, T, any>
Returns RelationBuilder<T>

Properties

Protected Readonly ModelClass

ModelClass: Function & { prototype: T } & typeof Model & Instantiable<T>

Protected appliedScopes

appliedScopes: Collection<{ accessor: string | Instantiable<Scope>; scope: ScopeClosure }> = ...

Protected constraints

constraints: Constraint[] = []

Constraints applied to this query.

Protected Readonly databaseService

databaseService: DatabaseService

Protected eagerLoadRelations

eagerLoadRelations: keyof T[] = []

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 relation

relation: Relation<any, T, any>

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 ModelBuilder.app
- Defined in src/lifecycle/AppClass.ts:36
Get the global Application.

Returns Application

clearFields

clearFields(): RelationBuilder<T>

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

Returns RelationBuilder<T>

clone

clone(): ModelBuilder<T>

Inherited from ModelBuilder.clone
- Defined in src/orm/model/ModelBuilder.ts:130
Create a copy of this builder.

override

to add implementation-specific pass-alongs.

Returns ModelBuilder<T>

connection

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

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

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

Protected container

container(): Container

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

Returns Container

delete

delete(): Promise<QueryResult>

Inherited from ModelBuilder.delete
- 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(): RelationBuilder<T>

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

Returns RelationBuilder<T>

exists

exists(): Promise<boolean>

Inherited from ModelBuilder.exists
- 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): RelationBuilder<T>

Inherited from ModelBuilder.field
- 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 RelationBuilder<T>

fields

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

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

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

finalize

finalize(): AbstractBuilder<T>

Inherited from ModelBuilder.finalize
- Defined in src/orm/model/ModelBuilder.ts:43
Get a copy of this builder with all of its values finalized.

override

to apply scopes

Returns AbstractBuilder<T>

first

first(): Promise<undefined | T>

Inherited from ModelBuilder.first
- 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): RelationBuilder<T>

Inherited from ModelBuilder.from
- 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 RelationBuilder<T>

get

get(): ResultCollection<T>

Inherited from ModelBuilder.get
- 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 ModelBuilder.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

getEagerLoadedRelations

getEagerLoadedRelations(): keyof T[]

Inherited from ModelBuilder.getEagerLoadedRelations
- Defined in src/orm/model/ModelBuilder.ts:107
Get the list of relations to eager-load.

Returns keyof T[]

getNewInstance

getNewInstance(): AbstractBuilder<T>

Inherited from ModelBuilder.getNewInstance
- Defined in src/orm/model/ModelBuilder.ts:31
Returns AbstractBuilder<T>

getResultIterable

getResultIterable(): AbstractResultIterable<T>

Inherited from ModelBuilder.getResultIterable
- Defined in src/orm/model/ModelBuilder.ts:35
Returns AbstractResultIterable<T>

groupBy

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

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

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

insert

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

Inherited from ModelBuilder.insert
- 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>

Inherited from ModelBuilder.iterator
- 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): RelationBuilder<T>

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

Parameters
- rows: number
Returns RelationBuilder<T>

Protected make

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

Inherited from ModelBuilder.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

Protected normalizeModelKeys

normalizeModelKeys(keys: ModelKeys): ModelKey[]

Inherited from ModelBuilder.normalizeModelKeys
- Defined in src/orm/model/ModelBuilder.ts:116
Given some format of keys of the model, try to normalize them to a flat array.

Parameters
- keys: ModelKeys
Returns ModelKey[]

notDistinct

notDistinct(): RelationBuilder<T>

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

Returns RelationBuilder<T>

offset

offset(rows: number): RelationBuilder<T>

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

Parameters
- rows: number
Returns RelationBuilder<T>

orWhere

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

Inherited from ModelBuilder.orWhere
- 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 RelationBuilder<T>

orWhereIn

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

Inherited from ModelBuilder.orWhereIn
- 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 RelationBuilder<T>

orWhereNot

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

Inherited from ModelBuilder.orWhereNot
- 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 RelationBuilder<T>

orWhereNotIn

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

Inherited from ModelBuilder.orWhereNotIn
- 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 RelationBuilder<T>

orWhereRaw

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

Inherited from ModelBuilder.orWhereRaw
- 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 RelationBuilder<T>

orderBy

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

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

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

orderByAscending

orderByAscending(field: string): RelationBuilder<T>

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

Parameters
- field: string
Returns RelationBuilder<T>

orderByDescending

orderByDescending(field: string): RelationBuilder<T>

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

Parameters
- field: string
Returns RelationBuilder<T>

page

page(pageNum?: number, pageSize?: number): RelationBuilder<T>

Inherited from ModelBuilder.page
- Defined in src/orm/builder/AbstractBuilder.ts:396
Apply skip() and take() calls to retrieve the records that should appear on the pageNum page, assuming each page has pageSize many records.

Parameters
- pageNum: number = 1
- pageSize: number = 20
Returns RelationBuilder<T>

raw

raw(sql: string): RelationBuilder<T>

Inherited from ModelBuilder.raw
- 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 RelationBuilder<T>

returning

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

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

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

select

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

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

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

skip

skip(rows: number): RelationBuilder<T>

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

Parameters
- rows: number
Returns RelationBuilder<T>

table

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

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

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

take

take(rows: number): RelationBuilder<T>

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

Parameters
- rows: number
Returns RelationBuilder<T>

update

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

Inherited from ModelBuilder.update
- 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): RelationBuilder<T>

Inherited from ModelBuilder.where
- 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 RelationBuilder<T>

whereIn

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

Inherited from ModelBuilder.whereIn
- 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 RelationBuilder<T>

whereKey

whereKey(keys: ModelKeys): RelationBuilder<T>

Inherited from ModelBuilder.whereKey
- Defined in src/orm/model/ModelBuilder.ts:53
Apply a WHERE...IN... constraint on the primary key of the model.

Parameters
- keys: ModelKeys
Returns RelationBuilder<T>

whereNot

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

Inherited from ModelBuilder.whereNot
- 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 RelationBuilder<T>

whereNotIn

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

Inherited from ModelBuilder.whereNotIn
- 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 RelationBuilder<T>

whereProperty

whereProperty(propertyName: string, operator: ConstraintOperator, operand?: EscapeValue): RelationBuilder<T>

Inherited from ModelBuilder.whereProperty
- Defined in src/orm/model/ModelBuilder.ts:67
Apply a where constraint on the column corresponding the the specified property on the model.

Parameters
- propertyName: string
- operator: ConstraintOperator
- Optional operand: EscapeValue
Returns RelationBuilder<T>

whereRaw

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

Inherited from ModelBuilder.whereRaw
- 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 RelationBuilder<T>

with

with(relationName: keyof T): RelationBuilder<T>

Inherited from ModelBuilder.with
- Defined in src/orm/model/ModelBuilder.ts:79
Mark a relation to be eager-loaded.

Parameters
- relationName: keyof T
Returns RelationBuilder<T>

withScopes

withScopes(scopes: Collection<{ accessor: string | Instantiable<Scope>; scope: ScopeClosure }>): RelationBuilder<T>

Inherited from ModelBuilder.withScopes
- Defined in src/orm/model/ModelBuilder.ts:26
Parameters
- scopes: Collection<{ accessor: string | Instantiable<Scope>; scope: ScopeClosure }>
Returns RelationBuilder<T>

withoutGlobalScope

withoutGlobalScope(name: string | Instantiable<Scope>): RelationBuilder<T>

Inherited from ModelBuilder.withoutGlobalScope
- Defined in src/orm/model/ModelBuilder.ts:101
Remove a specific scope from this query by its identifier.

Parameters
- name: string | Instantiable<Scope>
Returns RelationBuilder<T>

withoutGlobalScopes

withoutGlobalScopes(): RelationBuilder<T>

Inherited from ModelBuilder.withoutGlobalScopes
- Defined in src/orm/model/ModelBuilder.ts:92
Remove all global scopes from this query.

Returns RelationBuilder<T>

Type parameters

T: Model<T>

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type parameters

T: Model<T, T>

Parameters

relation: Relation<any, T, any>

Returns RelationBuilder<T>

Properties

Protected Readonly ModelClass

Protected appliedScopes

Protected constraints

Protected Readonly databaseService

Protected eagerLoadRelations

Protected Optional rawSql

Protected Optional registeredConnection

Protected registeredDistinct

Protected registeredFields

Protected registeredGroupings

Protected registeredOrders

Protected Optional registeredSkip

Protected Optional registeredTake

Protected relation

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 RelationBuilder<T>

clone

Returns ModelBuilder<T>

connection

Parameters

nameOrInstance: string | Connection

Returns RelationBuilder<T>

Protected container

Returns Container

delete

Returns Promise<QueryResult>

distinct

Returns RelationBuilder<T>

exists

Returns Promise<boolean>

field

Parameters

field: string | QuerySafeValue

Optional alias: string

Returns RelationBuilder<T>

fields

Parameters

Rest ...fields: SpecifiedField[]

Returns RelationBuilder<T>