createQueryReader Method
Creates a reader for asynchronous ECSQL query execution.
Execution starts when the reader is consumed using asynchronous iteration or awaited calls to step() or toArray().
Results are fetched and buffered in batches. For synchronous, callback-scoped execution, use withQueryReader.
See also:
createQueryReader(ecsql: string, params?: QueryBinder, config?: QueryOptions): ECSqlReader
@returns Returns an ECSqlReader which helps iterate over the result set and also give access to metadata.
| Parameter | Type | Description |
|---|---|---|
| ecsql | string | |
| params | QueryBinder | The values to bind to the parameters (if the ECSQL has any). |
| config | QueryOptions | Allow to specify certain flags which control how query is executed. |
Returns - ECSqlReader
Returns an ECSqlReader which helps iterate over the result set and also give access to metadata.
Defined in
- backend/src/IModelDb.ts Line 1049
Last Updated: 02 October, 2026
Found something wrong, missing, or unclear on this page? Raise an issue in our repo.