Class AbstractResultIterable<T>`Abstract`

Base Iterable class that generates the results of a Builder query.

Type Parameters

T

Hierarchy

Iterable<T>
- AbstractResultIterable
  - ResultIterable
  - ModelResultIterable

Index

Constructors

Properties

builder connection index

Accessors

Methods

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

Constructors

`Protected` constructor

new AbstractResultIterable<T>(builder: AbstractBuilder<T>, connection: Connection): AbstractResultIterable<T>
Type Parameters
- T
Parameters
- builder: AbstractBuilder<T>
  
  The builder whose results should be iterated
- connection: Connection
  
  The connection on which to execute the builder.
Returns AbstractResultIterable<T>
Overrides Iterable.constructor
- Defined in src/orm/builder/result/AbstractResultIterable.ts:9

Properties

`Readonly` builder

builder: AbstractBuilder<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

`Abstract` selectSQL

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

Returns string
- Defined in src/orm/builder/result/AbstractResultIterable.ts:22

Methods

`Abstract` all

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

Returns Promise<Collection<T>>
Overrides Iterable.all
- Defined in src/orm/builder/result/AbstractResultIterable.ts:45

`Abstract` at

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

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 Iterable.chunk
- Defined in src/util/collection/Iterable.ts:77

`Abstract` clone

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

Returns AbstractResultIterable<T>
Overrides Iterable.clone
- Defined in src/orm/builder/result/AbstractResultIterable.ts:50

`Abstract` count

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

Returns Promise<number>
Overrides Iterable.count
- Defined in src/orm/builder/result/AbstractResultIterable.ts:40

getContainer

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

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

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 Iterable.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 Iterable.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 Iterable.peek
- Defined in src/util/collection/Iterable.ts:115

`Abstract` 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 Iterable.range
- Defined in src/orm/builder/result/AbstractResultIterable.ts:35

reset

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

Returns
Promise

Returns Promise<void>
Inherited from Iterable.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 Iterable.seek
- Defined in src/util/collection/Iterable.ts:102

setContainer

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