Class ModelResultIterable<T>

Implementation of the result iterable that returns query results as instances of the defined model.

Type Parameters

T extends Model<T>

Hierarchy

AbstractResultIterable<T>
- ModelResultIterable

Index

Constructors

Properties

ModelClass builder connection index

Accessors

Methods

all at chunk clone count getContainer inflateRow make next peek processEagerLoads range reset seek setContainer

Constructors

constructor

new ModelResultIterable<T>(builder: ModelBuilder<T>, connection: Connection, ModelClass: Instantiable<T>): ModelResultIterable<T>
Type Parameters
- T extends Model<T, T>
Parameters
- builder: ModelBuilder<T>
- connection: Connection
- ModelClass: Instantiable<T>
  
  The model that should be instantiated for each row.
Returns ModelResultIterable<T>
Overrides AbstractResultIterable.constructor
- Defined in src/orm/model/ModelResultIterable.ts:14

Properties

`Protected` `Readonly` ModelClass

ModelClass: Instantiable<T>

The model that should be instantiated for each row.

`Readonly` builder

builder: ModelBuilder<T>

The builder whose results should be iterated

`Readonly` connection

connection: Connection

The connection on which to execute the builder.

`Protected` index

index: number = 0

The current index of the iterable.

Accessors

selectSQL

get selectSQL(): string
Get the SQL string for the SELECT query for this iterable.

Returns string
Overrides AbstractResultIterable.selectSQL
- Defined in src/orm/model/ModelResultIterable.ts:23

Methods

all

all(): Promise<Collection<T>>
Return all items resulting from this query.

Returns Promise<Collection<T>>
Overrides AbstractResultIterable.all
- Defined in src/orm/model/ModelResultIterable.ts:51

at

at(i: number): Promise<undefined | T>
Get the result at index i.
Parameters
- i: number
Returns Promise<undefined | T>
Overrides AbstractResultIterable.at
- Defined in src/orm/model/ModelResultIterable.ts:27

chunk

chunk(size: number, callback: ChunkCallback<T>): Promise<void>
Chunk the iterable into the given size and call the callback passing the chunk along.

Returns
Promise
Parameters
- size: number
- callback: ChunkCallback<T>
Returns Promise<void>
Inherited from AbstractResultIterable.chunk
- Defined in src/util/collection/Iterable.ts:77

clone

clone(): ModelResultIterable<T>
Create a new iterable based on this query.

Returns ModelResultIterable<T>
Overrides AbstractResultIterable.clone
- Defined in src/orm/model/ModelResultIterable.ts:101

count

count(): Promise<number>
Count the number of results of the query.

Returns Promise<number>
Overrides AbstractResultIterable.count
- Defined in src/orm/model/ModelResultIterable.ts:45

getContainer

getContainer(): Container
Get the container for this instance.

Returns Container
Inherited from AbstractResultIterable.getContainer
- Defined in src/di/InjectionAware.ts:23

`Protected` inflateRow

inflateRow(row: QueryRow): Promise<T>
Protected
Given a query row, create an instance of the configured model class from it.
Parameters
- row: QueryRow
Returns Promise<T>
- Defined in src/orm/model/ModelResultIterable.ts:63

make

make<T>(target: any, ...parameters: any[]): T
Instantiate a new injectable using the container.
Type Parameters
- T
Parameters
- target: any
- Rest ...parameters: any[]
Returns T
Inherited from AbstractResultIterable.make
- Defined in src/di/InjectionAware.ts:28

next

next(): Promise<MaybeIterationItem<T>>
Advance to the next value of this iterable.

Returns
Promise

Returns Promise<MaybeIterationItem<T>>
Inherited from AbstractResultIterable.next
- Defined in src/util/collection/Iterable.ts:59

peek

peek(): Promise<undefined | T>
Peek at the next value of the iterable, without advancing.

Returns
Promise<any|undefined>

Returns Promise<undefined | T>
Inherited from AbstractResultIterable.peek
- Defined in src/util/collection/Iterable.ts:115

`Protected` processEagerLoads

processEagerLoads(results: Collection<T>): Promise<void>
Protected
Eager-load eager-loaded relations for the models in the query result.
Parameters
- results: Collection<T>
Returns Promise<void>
- Defined in src/orm/model/ModelResultIterable.ts:76

range

range(start: number, end: number): Promise<Collection<T>>
Get the results starting at index start and ending at index end.
Parameters
- start: number
- end: number
Returns Promise<Collection<T>>
Overrides AbstractResultIterable.range
- Defined in src/orm/model/ModelResultIterable.ts:38

reset

reset(): Promise<void>
Reset the iterable to the first index.

Returns
Promise

Returns Promise<void>
Inherited from AbstractResultIterable.reset
- Defined in src/util/collection/Iterable.ts:127

seek

seek(index: number): Promise<void>
Advance the iterable to the given index.

Returns
Promise
Parameters
- index: number
Returns Promise<void>
Inherited from AbstractResultIterable.seek
- Defined in src/util/collection/Iterable.ts:102

setContainer

setContainer(ci: Container): ModelResultIterable<T>
Set the container for this instance.
Parameters
- ci: Container
Returns ModelResultIterable<T>
Inherited from AbstractResultIterable.setContainer
- Defined in src/di/InjectionAware.ts:17