Class ResultIterable

Implementation of AbstractResultIterable that yields simple QueryRow instances (objects).

Hierarchy

AbstractResultIterable<QueryRow>
- ResultIterable

Index

Constructors

Properties

builder connection index

Accessors

Methods

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

Constructors

constructor

new ResultIterable(builder: Builder, connection: Connection): ResultIterable
Parameters
- builder: Builder
- connection: Connection
Returns ResultIterable
Overrides AbstractResultIterable.constructor
- Defined in src/orm/builder/result/ResultIterable.ts:11

Properties

`Readonly` builder

builder: Builder

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/builder/result/ResultIterable.ts:18

Methods

all

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

Returns Promise<Collection<QueryRow>>
Overrides AbstractResultIterable.all
- Defined in src/orm/builder/result/ResultIterable.ts:38

at

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

chunk

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

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

clone

clone(): ResultIterable
Create a new iterable based on this query.

Returns ResultIterable
Overrides AbstractResultIterable.clone
- Defined in src/orm/builder/result/ResultIterable.ts:43

count

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

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

getContainer

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

Returns Container
Inherited from AbstractResultIterable.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 AbstractResultIterable.make
- Defined in src/di/InjectionAware.ts:28

next

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

Returns
Promise

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

peek

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

Returns
Promise<any|undefined>

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

range

range(start: number, end: number): Promise<Collection<QueryRow>>
Get the results starting at index start and ending at index end.
Parameters
- start: number
- end: number
Returns Promise<Collection<QueryRow>>
Overrides AbstractResultIterable.range
- Defined in src/orm/builder/result/ResultIterable.ts:27

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): ResultIterable
Set the container for this instance.
Parameters
- ci: Container
Returns ResultIterable
Inherited from AbstractResultIterable.setContainer
- Defined in src/di/InjectionAware.ts:17