@itwin/core-common 4.1.0-dev.7 → 4.1.0-dev.71

package/lib/esm/ECSqlReader.d.ts

@@ -13,27 +13,99 @@ export declare class PropertyMetaDataMap implements Iterable<QueryPropertyMetaDa
     findByNoCase(name: string): QueryPropertyMetaData | undefined;
 }
 /**
+ * The format for rows returned by [[ECSqlReader]].
  * @beta
-*/
+ */
 export type QueryValueType = any;
-/** @beta */
+/**
+ * Methods and ways of accessing values from rows returned by [[ECSqlReader]].
+ * @beta
+ */
 export interface QueryRowProxy {
+    /**
+     * Get the current row as a JavaScript `object`.
+     *
+     * @returns The current row as a JavaScript `object`.
+     */
     toRow(): any;
+    /**
+     * Get all remaining rows from the query result.
+     * If called on the current row ([[ECSqlReader.current]]), only that row is returned.
+     *
+     * @returns All remaining rows from the query result.
+     */
     toArray(): QueryValueType[];
+    /**
+     * Get the metadata for each column in the query result.
+     *
+     * @returns The metadata for each column in the query result.
+     */
     getMetaData(): QueryPropertyMetaData[];
+    /**
+     * Access a property using its name.
+     *
+     * @returns The value from the row whose key (ECSQL column name) is `propertyName`.
+     *
+     * @example
+     * The following lines will all return the same result:
+     * ```ts
+     * reader.current.ECInstanceId;
+     * reader.current.ecinstanceid;
+     * reader.current.["ECInstanceId"];
+     * ```
+     */
     [propertyName: string]: QueryValueType;
+    /**
+     * Access a property using its index.
+     * The index is relative to the order of the columns returned by the query that produced the row.
+     *
+     * @returns The value from the column at `propertyIndex`.
+     *
+     * @example reader.current[0]
+     */
     [propertyIndex: number]: QueryValueType;
 }
-/** @beta */
+/**
+ * Performance-related statistics for [[ECSqlReader]].
+ * @beta
+ */
 export interface QueryStats {
+    /** Time spent running the query; not including time spent queued. Time is in microseconds */
     backendCpuTime: number;
+    /** Total time it took the backend to run the query. Time is in milliseconds. */
     backendTotalTime: number;
+    /** Estimated memory used for the query. */
     backendMemUsed: number;
+    /** Total number of rows returned by the backend. */
     backendRowsReturned: number;
+    /** The total round trip time from the client's perspective. Time is in milliseconds. */
     totalTime: number;
+    /** The number of retries attempted to execute the query. */
     retryCount: number;
 }
-/** @beta */
+/**
+ * Execute ECSQL statements and read the results.
+ *
+ * The query results are returned one row at a time. The format of the row is dictated by the
+ * [[QueryOptions.rowFormat]] specified in the `options` parameter of the constructed ECSqlReader object. Defaults to
+ * [[QueryRowFormat.UseECSqlPropertyIndexes]] when no `rowFormat` is defined.
+ *
+ * There are three primary ways to interact with and read the results:
+ * - Stream them using ECSqlReader as an asynchronous iterator.
+ * - Iterator over them manually using [[ECSqlReader.step]].
+ * - Capture all of the results at once in an array using [[QueryRowProxy.toArray]].
+ *
+ * @see
+ * - [ECSQL Overview]($docs/learning/backend/ExecutingECSQL)
+ * - [ECSQL Row Formats]($docs/learning/ECSQLRowFormat) for more details on how rows are formatted.
+ * - [ECSQL Code Examples]($docs/learning/ECSQLCodeExamples#iterating-over-query-results) for examples of each
+ *      of the above ways of interacting with ECSqlReader.
+ *
+ * @note When iterating over the results, the current row will be a [[QueryRowProxy]] object. To get the row as a basic
+ *       JavaScript object, call [[QueryRowProxy.toRow]] on it.
+ *
+ * @beta
+ */
 export declare class ECSqlReader implements AsyncIterableIterator<QueryRowProxy> {
     private _executor;
     readonly query: string;
@@ -48,26 +120,111 @@ export declare class ECSqlReader implements AsyncIterableIterator<QueryRowProxy>
     private _param;
     private _lockArgs;
     private _stats;
-    private _rowProxy;
     private _options;
-    /** @internal */
+    private _rowProxy;
+    /**
+     * @internal
+     */
     constructor(_executor: DbRequestExecutor<DbQueryRequest, DbQueryResponse>, query: string, param?: QueryBinder, options?: QueryOptions);
     private static replaceBase64WithUint8Array;
     setParams(param: QueryBinder): void;
     reset(options?: QueryOptions): void;
+    /**
+     * Get the current row from the query result. The current row is the one most recently stepped-to
+     * (by step() or during iteration).
+     *
+     * Each value from the row can be accessed by index or by name.
+     *
+     * The format of the row is dictated by the [[QueryOptions.rowFormat]] specified in the `options` parameter of the
+     * constructed ECSqlReader object.
+     *
+     * @see
+     * - [[QueryRowFormat]]
+     * - [ECSQL Row Formats]($docs/learning/ECSQLRowFormat)
+     *
+     * @note The current row is be a [[QueryRowProxy]] object. To get the row as a basic JavaScript object, call
+     *       [[QueryRowProxy.toRow]] on it.
+     *
+     * @example
+     * ```ts
+     * const reader = iModel.createQueryReader("SELECT ECInstanceId FROM bis.Element");
+     * while (await reader.step()) {
+     *   // Both lines below print the same value
+     *   console.log(reader.current[0]);
+     *   console.log(reader.current.ecinstanceid);
+     * }
+     * ```
+     *
+     * @return The current row as a [[QueryRowProxy]].
+     */
     get current(): QueryRowProxy;
+    /**
+     * Clear all bindings.
+     */
     resetBindings(): void;
+    /**
+     * Returns if there are more rows available.
+     *
+     * @returns `true` if all rows have been stepped through already.<br/>
+     *          `false` if there are any yet unaccessed rows.
+     */
     get done(): boolean;
+    /**
+     *
+     */
     getRowInternal(): any[];
+    /**
+     * Get performance-related statistics for the current query.
+     */
     get stats(): QueryStats;
+    /**
+     *
+     */
     private readRows;
-    private runWithRetry;
+    /**
+     * @internal
+     */
+    protected runWithRetry(request: DbQueryRequest): Promise<DbQueryResponse>;
+    /**
+     *
+     */
     formatCurrentRow(onlyReturnObject?: boolean): any[] | object;
+    /**
+     * Get the metadata for each column in the query result.
+     *
+     * @returns An array of [[QueryPropertyMetaData]].
+     */
     getMetaData(): Promise<QueryPropertyMetaData[]>;
+    /**
+     *
+     */
     private fetchRows;
+    /**
+     * Step to the next row of the query result.
+     *
+     * @returns `true` if a row can be read from `current`.<br/>
+     *          `false` if there are no more rows; i.e., all rows have been stepped through already.
+     */
     step(): Promise<boolean>;
+    /**
+     * Get all remaining rows from the query result.
+     *
+     * @returns An array of all remaining rows from the query result.
+     */
     toArray(): Promise<any[]>;
+    /**
+     * Accessor for using ECSqlReader as an asynchronous iterator.
+     *
+     * @returns An asynchronous iterator over the rows returned by the executed ECSQL query.
+     */
     [Symbol.asyncIterator](): AsyncIterableIterator<QueryRowProxy>;
+    /**
+     * Calls step when called as an iterator.
+     *
+     * Returns the row alongside a `done` boolean to indicate if there are any more rows for an iterator to step to.
+     *
+     * @returns An object with the keys: `value` which contains the row and `done` which contains a boolean.
+     */
     next(): Promise<IteratorResult<QueryRowProxy, any>>;
 }
 //# sourceMappingURL=ECSqlReader.d.ts.map

package/lib/esm/ECSqlReader.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ECSqlReader.d.ts","sourceRoot":"","sources":["../../src/ECSqlReader.ts"],"names":[],"mappings":"AAQA,OAAO,EACS,cAAc,EAAE,eAAe,EAAE,iBAAiB,EAAkD,WAAW,EAAE,YAAY,EAC3I,qBAAqB,EACtB,MAAM,mBAAmB,CAAC;AAE3B,YAAY;AACZ,qBAAa,mBAAoB,YAAW,QAAQ,CAAC,qBAAqB,CAAC;aAItC,UAAU,EAAE,qBAAqB,EAAE;IAHtE,OAAO,CAAC,WAAW,CAA6B;IAChD,OAAO,CAAC,WAAW,CAA6B;IAChD,OAAO,CAAC,SAAS,CAA6B;gBACX,UAAU,EAAE,qBAAqB,EAAE;IAQtE,IAAW,MAAM,IAAI,MAAM,CAAmC;IAEvD,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,QAAQ,CAAC,qBAAqB,EAAE,GAAG,EAAE,SAAS,CAAC;IAGpE,UAAU,CAAC,IAAI,EAAE,MAAM,GAAG,qBAAqB,GAAG,SAAS;IAO3D,cAAc,CAAC,IAAI,EAAE,MAAM,GAAG,qBAAqB,GAAG,SAAS;IAO/D,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,qBAAqB,GAAG,SAAS;CAOrE;AACD;;EAEE;AACF,MAAM,MAAM,cAAc,GAAG,GAAG,CAAC;AAEjC,YAAY;AACZ,MAAM,WAAW,aAAa;IAC5B,KAAK,IAAI,GAAG,CAAC;IACb,OAAO,IAAI,cAAc,EAAE,CAAC;IAC5B,WAAW,IAAI,qBAAqB,EAAE,CAAC;IACvC,CAAC,YAAY,EAAE,MAAM,GAAG,cAAc,CAAC;IACvC,CAAC,aAAa,EAAE,MAAM,GAAG,cAAc,CAAC;CACzC;AAED,YAAY;AACZ,MAAM,WAAW,UAAU;IACzB,cAAc,EAAE,MAAM,CAAC;IACvB,gBAAgB,EAAE,MAAM,CAAC;IACzB,cAAc,EAAE,MAAM,CAAC;IACvB,mBAAmB,EAAE,MAAM,CAAC;IAC5B,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,YAAY;AACZ,qBAAa,WAAY,YAAW,qBAAqB,CAAC,aAAa,CAAC;IAgDnD,OAAO,CAAC,SAAS;aAAsE,KAAK,EAAE,MAAM;IA/CvH,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,cAAc,CAAM;IAC5C,OAAO,CAAC,UAAU,CAAa;IAC/B,OAAO,CAAC,YAAY,CAAa;IACjC,OAAO,CAAC,aAAa,CAAc;IACnC,OAAO,CAAC,YAAY,CAAc;IAClC,OAAO,CAAC,KAAK,CAAkB;IAC/B,OAAO,CAAC,WAAW,CAAkB;IACrC,OAAO,CAAC,MAAM,CAA+B;IAC7C,OAAO,CAAC,MAAM,CAAiC;IAC/C,OAAO,CAAC,SAAS,CAAkB;IACnC,OAAO,CAAC,MAAM,CAAsH;IACpI,OAAO,CAAC,SAAS,CAiCd;IACH,OAAO,CAAC,QAAQ,CAAwD;IACxE,gBAAgB;gBACW,SAAS,EAAE,iBAAiB,CAAC,cAAc,EAAE,eAAe,CAAC,EAAkB,KAAK,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,WAAW,EAAE,OAAO,CAAC,EAAE,YAAY;IASpK,OAAO,CAAC,MAAM,CAAC,2BAA2B;IAYnC,SAAS,CAAC,KAAK,EAAE,WAAW;IAM5B,KAAK,CAAC,OAAO,CAAC,EAAE,YAAY;IAmBnC,IAAW,OAAO,IAAI,aAAa,CAAoC;IAEhE,aAAa;IAKpB,IAAW,IAAI,IAAI,OAAO,CAAuB;IAC1C,cAAc,IAAI,GAAG,EAAE;IAM9B,IAAW,KAAK,IAAI,UAAU,CAAwB;YACxC,QAAQ;YA8BR,YAAY;IA8BnB,gBAAgB,CAAC,gBAAgB,GAAE,OAAe,GAAG,GAAG,EAAE,GAAG,MAAM;IAiB7D,WAAW,IAAI,OAAO,CAAC,qBAAqB,EAAE,CAAC;YAM9C,SAAS;IAOV,IAAI,IAAI,OAAO,CAAC,OAAO,CAAC;IAcxB,OAAO,IAAI,OAAO,CAAC,GAAG,EAAE,CAAC;IAO/B,CAAC,MAAM,CAAC,aAAa,CAAC,IAAI,qBAAqB,CAAC,aAAa,CAAC;IAGxD,IAAI,IAAI,OAAO,CAAC,cAAc,CAAC,aAAa,EAAE,GAAG,CAAC,CAAC;CAajE"}
+{"version":3,"file":"ECSqlReader.d.ts","sourceRoot":"","sources":["../../src/ECSqlReader.ts"],"names":[],"mappings":"AAQA,OAAO,EACS,cAAc,EAAE,eAAe,EAAE,iBAAiB,EAAkD,WAAW,EAAE,YAAY,EAC3I,qBAAqB,EACtB,MAAM,mBAAmB,CAAC;AAE3B,YAAY;AACZ,qBAAa,mBAAoB,YAAW,QAAQ,CAAC,qBAAqB,CAAC;aAKtC,UAAU,EAAE,qBAAqB,EAAE;IAJtE,OAAO,CAAC,WAAW,CAA6B;IAChD,OAAO,CAAC,WAAW,CAA6B;IAChD,OAAO,CAAC,SAAS,CAA6B;gBAEX,UAAU,EAAE,qBAAqB,EAAE;IAStE,IAAW,MAAM,IAAI,MAAM,CAE1B;IAEM,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,QAAQ,CAAC,qBAAqB,EAAE,GAAG,EAAE,SAAS,CAAC;IAIpE,UAAU,CAAC,IAAI,EAAE,MAAM,GAAG,qBAAqB,GAAG,SAAS;IAQ3D,cAAc,CAAC,IAAI,EAAE,MAAM,GAAG,qBAAqB,GAAG,SAAS;IAQ/D,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,qBAAqB,GAAG,SAAS;CAOrE;AAED;;;GAGG;AACH,MAAM,MAAM,cAAc,GAAG,GAAG,CAAC;AAEjC;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC5B;;;;OAIG;IACH,KAAK,IAAI,GAAG,CAAC;IAEb;;;;;OAKG;IACH,OAAO,IAAI,cAAc,EAAE,CAAC;IAE5B;;;;OAIG;IACH,WAAW,IAAI,qBAAqB,EAAE,CAAC;IAEvC;;;;;;;;;;;;OAYG;IACH,CAAC,YAAY,EAAE,MAAM,GAAG,cAAc,CAAC;IAEvC;;;;;;;OAOG;IACH,CAAC,aAAa,EAAE,MAAM,GAAG,cAAc,CAAC;CACzC;AAED;;;GAGG;AACH,MAAM,WAAW,UAAU;IACzB,6FAA6F;IAC7F,cAAc,EAAE,MAAM,CAAC;IACvB,gFAAgF;IAChF,gBAAgB,EAAE,MAAM,CAAC;IACzB,2CAA2C;IAC3C,cAAc,EAAE,MAAM,CAAC;IACvB,oDAAoD;IACpD,mBAAmB,EAAE,MAAM,CAAC;IAC5B,wFAAwF;IACxF,SAAS,EAAE,MAAM,CAAC;IAClB,4DAA4D;IAC5D,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,qBAAa,WAAY,YAAW,qBAAqB,CAAC,aAAa,CAAC;IAqDnD,OAAO,CAAC,SAAS;aAAsE,KAAK,EAAE,MAAM;IApDvH,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,cAAc,CAAM;IAE5C,OAAO,CAAC,UAAU,CAAa;IAC/B,OAAO,CAAC,YAAY,CAAa;IACjC,OAAO,CAAC,aAAa,CAAc;IACnC,OAAO,CAAC,YAAY,CAAc;IAClC,OAAO,CAAC,KAAK,CAAkB;IAC/B,OAAO,CAAC,WAAW,CAAkB;IACrC,OAAO,CAAC,MAAM,CAA+B;IAC7C,OAAO,CAAC,MAAM,CAAiC;IAC/C,OAAO,CAAC,SAAS,CAAkB;IACnC,OAAO,CAAC,MAAM,CAAsH;IACpI,OAAO,CAAC,QAAQ,CAAwD;IAExE,OAAO,CAAC,SAAS,CAiCd;IAEH;;OAEG;gBACwB,SAAS,EAAE,iBAAiB,CAAC,cAAc,EAAE,eAAe,CAAC,EAAkB,KAAK,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,WAAW,EAAE,OAAO,CAAC,EAAE,YAAY;IAUpK,OAAO,CAAC,MAAM,CAAC,2BAA2B;IAanC,SAAS,CAAC,KAAK,EAAE,WAAW;IAO5B,KAAK,CAAC,OAAO,CAAC,EAAE,YAAY;IAoBnC;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,IAAW,OAAO,IAAI,aAAa,CAElC;IAED;;OAEG;IACI,aAAa;IAKpB;;;;;OAKG;IACH,IAAW,IAAI,IAAI,OAAO,CAEzB;IAED;;OAEG;IACI,cAAc,IAAI,GAAG,EAAE;IAM9B;;OAEG;IACH,IAAW,KAAK,IAAI,UAAU,CAE7B;IAED;;OAEG;YACW,QAAQ;IA+BtB;;OAEG;cACa,YAAY,CAAC,OAAO,EAAE,cAAc;IA+BpD;;OAEG;IACI,gBAAgB,CAAC,gBAAgB,GAAE,OAAe,GAAG,GAAG,EAAE,GAAG,MAAM;IAkB1E;;;;OAIG;IACU,WAAW,IAAI,OAAO,CAAC,qBAAqB,EAAE,CAAC;IAO5D;;OAEG;YACW,SAAS;IAQvB;;;;;OAKG;IACU,IAAI,IAAI,OAAO,CAAC,OAAO,CAAC;IAerC;;;;OAIG;IACU,OAAO,IAAI,OAAO,CAAC,GAAG,EAAE,CAAC;IAQtC;;;;OAIG;IACI,CAAC,MAAM,CAAC,aAAa,CAAC,IAAI,qBAAqB,CAAC,aAAa,CAAC;IAIrE;;;;;;OAMG;IACU,IAAI,IAAI,OAAO,CAAC,cAAc,CAAC,aAAa,EAAE,GAAG,CAAC,CAAC;CAajE"}

package/lib/esm/ECSqlReader.js

@@ -21,7 +21,9 @@ export class PropertyMetaDataMap {
             this._byNoCase.set(property.jsonName.toLowerCase(), property.index);
         }
     }
-    get length() { return this.properties.length; }
+    get length() {
+        return this.properties.length;
+    }
     [Symbol.iterator]() {
         return this.properties[Symbol.iterator]();
     }
@@ -47,9 +49,33 @@ export class PropertyMetaDataMap {
         return undefined;
     }
 }
-/** @beta */
+/**
+ * Execute ECSQL statements and read the results.
+ *
+ * The query results are returned one row at a time. The format of the row is dictated by the
+ * [[QueryOptions.rowFormat]] specified in the `options` parameter of the constructed ECSqlReader object. Defaults to
+ * [[QueryRowFormat.UseECSqlPropertyIndexes]] when no `rowFormat` is defined.
+ *
+ * There are three primary ways to interact with and read the results:
+ * - Stream them using ECSqlReader as an asynchronous iterator.
+ * - Iterator over them manually using [[ECSqlReader.step]].
+ * - Capture all of the results at once in an array using [[QueryRowProxy.toArray]].
+ *
+ * @see
+ * - [ECSQL Overview]($docs/learning/backend/ExecutingECSQL)
+ * - [ECSQL Row Formats]($docs/learning/ECSQLRowFormat) for more details on how rows are formatted.
+ * - [ECSQL Code Examples]($docs/learning/ECSQLCodeExamples#iterating-over-query-results) for examples of each
+ *      of the above ways of interacting with ECSqlReader.
+ *
+ * @note When iterating over the results, the current row will be a [[QueryRowProxy]] object. To get the row as a basic
+ *       JavaScript object, call [[QueryRowProxy.toRow]] on it.
+ *
+ * @beta
+ */
 class ECSqlReader {
-    /** @internal */
+    /**
+     * @internal
+     */
     constructor(_executor, query, param, options) {
         this._executor = _executor;
         this.query = query;
@@ -63,6 +89,7 @@ class ECSqlReader {
         this._param = new QueryBinder().serialize();
         this._lockArgs = false;
         this._stats = { backendCpuTime: 0, backendTotalTime: 0, backendMemUsed: 0, backendRowsReturned: 0, totalTime: 0, retryCount: 0 };
+        this._options = new QueryOptionsBuilder().getOptions();
         this._rowProxy = new Proxy(this, {
             get: (target, key) => {
                 if (typeof key === "string") {
@@ -97,7 +124,6 @@ class ECSqlReader {
                 return keys;
             },
         });
-        this._options = new QueryOptionsBuilder().getOptions();
         if (query.trim().length === 0) {
             throw new Error("expecting non-empty ecsql statement");
         }
@@ -144,21 +170,70 @@ class ECSqlReader {
         }
         this._done = false;
     }
-    get current() { return this._rowProxy; }
-    // clear all bindings
+    /**
+     * Get the current row from the query result. The current row is the one most recently stepped-to
+     * (by step() or during iteration).
+     *
+     * Each value from the row can be accessed by index or by name.
+     *
+     * The format of the row is dictated by the [[QueryOptions.rowFormat]] specified in the `options` parameter of the
+     * constructed ECSqlReader object.
+     *
+     * @see
+     * - [[QueryRowFormat]]
+     * - [ECSQL Row Formats]($docs/learning/ECSQLRowFormat)
+     *
+     * @note The current row is be a [[QueryRowProxy]] object. To get the row as a basic JavaScript object, call
+     *       [[QueryRowProxy.toRow]] on it.
+     *
+     * @example
+     * ```ts
+     * const reader = iModel.createQueryReader("SELECT ECInstanceId FROM bis.Element");
+     * while (await reader.step()) {
+     *   // Both lines below print the same value
+     *   console.log(reader.current[0]);
+     *   console.log(reader.current.ecinstanceid);
+     * }
+     * ```
+     *
+     * @return The current row as a [[QueryRowProxy]].
+     */
+    get current() {
+        return this._rowProxy;
+    }
+    /**
+     * Clear all bindings.
+     */
     resetBindings() {
         this._param = new QueryBinder().serialize();
         this._lockArgs = false;
     }
-    // return if there is any more rows available
-    get done() { return this._done; }
+    /**
+     * Returns if there are more rows available.
+     *
+     * @returns `true` if all rows have been stepped through already.<br/>
+     *          `false` if there are any yet unaccessed rows.
+     */
+    get done() {
+        return this._done;
+    }
+    /**
+     *
+     */
     getRowInternal() {
         if (this._localRows.length <= this._localOffset)
             throw new Error("no current row");
         return this._localRows[this._localOffset];
     }
-    // return performance related statistics for current query.
-    get stats() { return this._stats; }
+    /**
+     * Get performance-related statistics for the current query.
+     */
+    get stats() {
+        return this._stats;
+    }
+    /**
+     *
+     */
     async readRows() {
         if (this._globalDone) {
             return [];
@@ -189,13 +264,16 @@ class ECSqlReader {
         }
         return resp.data;
     }
+    /**
+     * @internal
+     */
     async runWithRetry(request) {
-        const needRetry = (rs) => (rs.status === DbResponseStatus.Partial || rs.status === DbResponseStatus.QueueFull || rs.status === DbResponseStatus.Timeout) && (rs.data.length === 0);
+        const needRetry = (rs) => (rs.status === DbResponseStatus.Partial || rs.status === DbResponseStatus.QueueFull || rs.status === DbResponseStatus.Timeout) && (rs.data === undefined || rs.data.length === 0);
         const updateStats = (rs) => {
             this._stats.backendCpuTime += rs.stats.cpuTime;
             this._stats.backendTotalTime += rs.stats.totalTime;
             this._stats.backendMemUsed += rs.stats.memUsed;
-            this._stats.backendRowsReturned += rs.data.length;
+            this._stats.backendRowsReturned += (rs.data === undefined) ? 0 : rs.data.length;
         };
         const execQuery = async (req) => {
             const startTime = Date.now();
@@ -219,6 +297,9 @@ class ECSqlReader {
         updateStats(resp);
         return resp;
     }
+    /**
+     *
+     */
     formatCurrentRow(onlyReturnObject = false) {
         if (!onlyReturnObject && this._options.rowFormat === QueryRowFormat.UseECSqlPropertyIndexes) {
             return this.getRowInternal();
@@ -236,12 +317,20 @@ class ECSqlReader {
         }
         return formattedRow;
     }
+    /**
+     * Get the metadata for each column in the query result.
+     *
+     * @returns An array of [[QueryPropertyMetaData]].
+     */
     async getMetaData() {
         if (this._props.length === 0) {
             await this.fetchRows();
         }
         return this._props.properties;
     }
+    /**
+     *
+     */
     async fetchRows() {
         this._localOffset = -1;
         this._localRows = await this.readRows();
@@ -249,6 +338,12 @@ class ECSqlReader {
             this._done = true;
         }
     }
+    /**
+     * Step to the next row of the query result.
+     *
+     * @returns `true` if a row can be read from `current`.<br/>
+     *          `false` if there are no more rows; i.e., all rows have been stepped through already.
+     */
     async step() {
         if (this._done) {
             return false;
@@ -264,6 +359,11 @@ class ECSqlReader {
         }
         return true;
     }
+    /**
+     * Get all remaining rows from the query result.
+     *
+     * @returns An array of all remaining rows from the query result.
+     */
     async toArray() {
         const rows = [];
         while (await this.step()) {
@@ -271,9 +371,21 @@ class ECSqlReader {
         }
         return rows;
     }
+    /**
+     * Accessor for using ECSqlReader as an asynchronous iterator.
+     *
+     * @returns An asynchronous iterator over the rows returned by the executed ECSQL query.
+     */
     [Symbol.asyncIterator]() {
         return this;
     }
+    /**
+     * Calls step when called as an iterator.
+     *
+     * Returns the row alongside a `done` boolean to indicate if there are any more rows for an iterator to step to.
+     *
+     * @returns An object with the keys: `value` which contains the row and `done` which contains a boolean.
+     */
     async next() {
         if (await this.step()) {
             return {

package/lib/esm/ECSqlReader.js.map

@@ -1 +1 @@
-{"version":3,"file":"ECSqlReader.js","sourceRoot":"","sources":["../../src/ECSqlReader.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AACH,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAC5D,OAAO,EACL,YAAY,EAAsD,aAAa,EAAE,gBAAgB,EAAE,aAAa,EAAE,WAAW,EAAgB,mBAAmB,EACzI,cAAc,GACtC,MAAM,mBAAmB,CAAC;AAE3B,YAAY;AACZ,MAAM,OAAO,mBAAmB;IAI9B,YAAmC,UAAmC;QAAnC,eAAU,GAAV,UAAU,CAAyB;QAH9D,gBAAW,GAAG,IAAI,GAAG,EAAkB,CAAC;QACxC,gBAAW,GAAG,IAAI,GAAG,EAAkB,CAAC;QACxC,cAAS,GAAG,IAAI,GAAG,EAAkB,CAAC;QAE5C,KAAK,MAAM,QAAQ,IAAI,IAAI,CAAC,UAAU,EAAE;YACtC,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC,KAAK,CAAC,CAAC;YACpD,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC,KAAK,CAAC,CAAC;YACxD,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,WAAW,EAAE,EAAE,QAAQ,CAAC,KAAK,CAAC,CAAC;YAChE,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,QAAQ,CAAC,QAAQ,CAAC,WAAW,EAAE,EAAE,QAAQ,CAAC,KAAK,CAAC,CAAC;SACrE;IACH,CAAC;IACD,IAAW,MAAM,KAAa,OAAO,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC;IAEvD,CAAC,MAAM,CAAC,QAAQ,CAAC;QACtB,OAAO,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC;IAC5C,CAAC;IACM,UAAU,CAAC,IAAY;QAC5B,MAAM,KAAK,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QACzC,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;YAC7B,OAAO,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;SAC/B;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;IACM,cAAc,CAAC,IAAY;QAChC,MAAM,KAAK,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QACzC,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;YAC7B,OAAO,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;SAC/B;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;IACM,YAAY,CAAC,IAAY;QAC9B,MAAM,KAAK,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC;QACrD,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;YAC7B,OAAO,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;SAC/B;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;CACF;AAyBD,YAAY;AACZ,MAAa,WAAW;IA+CtB,gBAAgB;IAChB,YAA2B,SAA6D,EAAkB,KAAa,EAAE,KAAmB,EAAE,OAAsB;QAAzI,cAAS,GAAT,SAAS,CAAoD;QAAkB,UAAK,GAAL,KAAK,CAAQ;QA9C/G,eAAU,GAAU,EAAE,CAAC;QACvB,iBAAY,GAAW,CAAC,CAAC;QACzB,kBAAa,GAAW,CAAC,CAAC,CAAC;QAC3B,iBAAY,GAAW,CAAC,CAAC,CAAC;QAC1B,UAAK,GAAY,KAAK,CAAC;QACvB,gBAAW,GAAY,KAAK,CAAC;QAC7B,WAAM,GAAG,IAAI,mBAAmB,CAAC,EAAE,CAAC,CAAC;QACrC,WAAM,GAAG,IAAI,WAAW,EAAE,CAAC,SAAS,EAAE,CAAC;QACvC,cAAS,GAAY,KAAK,CAAC;QAC3B,WAAM,GAAG,EAAE,cAAc,EAAE,CAAC,EAAE,gBAAgB,EAAE,CAAC,EAAE,cAAc,EAAE,CAAC,EAAE,mBAAmB,EAAE,CAAC,EAAE,SAAS,EAAE,CAAC,EAAE,UAAU,EAAE,CAAC,EAAE,CAAC;QAC5H,cAAS,GAAG,IAAI,KAAK,CAAc,IAAI,EAAE;YAC/C,GAAG,EAAE,CAAC,MAAmB,EAAE,GAAoB,EAAE,EAAE;gBACjD,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE;oBAC3B,MAAM,GAAG,GAAG,MAAM,CAAC,QAAQ,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;oBACrC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE;wBACtB,OAAO,MAAM,CAAC,cAAc,EAAE,CAAC,GAAG,CAAC,CAAC;qBACrC;oBACD,MAAM,IAAI,GAAG,MAAM,CAAC,MAAM,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC;oBAC7C,IAAI,IAAI,EAAE;wBACR,OAAO,MAAM,CAAC,cAAc,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;qBAC5C;oBACD,IAAI,GAAG,KAAK,aAAa,EAAE;wBACzB,OAAO,GAAG,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC;qBACvC;oBACD,IAAI,GAAG,KAAK,OAAO,EAAE;wBACnB,OAAO,GAAG,EAAE,CAAC,MAAM,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC;qBAC5C;oBACD,IAAI,GAAG,KAAK,SAAS,EAAE;wBACrB,OAAO,GAAG,EAAE,CAAC,IAAI,CAAC,cAAc,EAAE,CAAC;qBACpC;iBACF;gBACD,OAAO,SAAS,CAAC;YACnB,CAAC;YACD,GAAG,EAAE,CAAC,MAAmB,EAAE,CAAkB,EAAE,EAAE;gBAC/C,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,YAAY,CAAC,CAAW,CAAC,CAAC;YAClD,CAAC;YACD,OAAO,EAAE,CAAC,MAAmB,EAAE,EAAE;gBAC/B,MAAM,IAAI,GAAG,EAAE,CAAC;gBAChB,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,MAAM,EAAE;oBAChC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;iBACtB;gBACD,OAAO,IAAI,CAAC;YACd,CAAC;SACF,CAAC,CAAC;QACK,aAAQ,GAAiB,IAAI,mBAAmB,EAAE,CAAC,UAAU,EAAE,CAAC;QAGtE,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC,MAAM,KAAK,CAAC,EAAE;YAC7B,MAAM,IAAI,KAAK,CAAC,qCAAqC,CAAC,CAAC;SACxD;QACD,IAAI,KAAK,EAAE;YACT,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC,SAAS,EAAE,CAAC;SACjC;QACD,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IACtB,CAAC;IACO,MAAM,CAAC,2BAA2B,CAAC,GAAQ;QACjD,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE;YAClC,MAAM,GAAG,GAAG,GAAG,CAAC,GAAG,CAAC,CAAC;YACrB,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE;gBAC3B,IAAI,mBAAmB,CAAC,SAAS,CAAC,GAAG,CAAC,EAAE;oBACtC,GAAG,CAAC,GAAG,CAAC,GAAG,mBAAmB,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC;iBAClD;aACF;iBAAM,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,GAAG,KAAK,IAAI,EAAE;gBAClD,IAAI,CAAC,2BAA2B,CAAC,GAAG,CAAC,CAAC;aACvC;SACF;IACH,CAAC;IACM,SAAS,CAAC,KAAkB;QACjC,IAAI,IAAI,CAAC,SAAS,EAAE;YAClB,MAAM,IAAI,KAAK,CAAC,4DAA4D,CAAC,CAAC;SAC/E;QACD,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC,SAAS,EAAE,CAAC;IAClC,CAAC;IACM,KAAK,CAAC,OAAsB;QACjC,IAAI,OAAO,EAAE;YACX,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;SACzB;QACD,IAAI,CAAC,MAAM,GAAG,IAAI,mBAAmB,CAAC,EAAE,CAAC,CAAC;QAC1C,IAAI,CAAC,UAAU,GAAG,EAAE,CAAC;QACrB,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC;QACzB,IAAI,CAAC,aAAa,GAAG,CAAC,CAAC;QACvB,IAAI,CAAC,YAAY,GAAG,CAAC,CAAC,CAAC;QACvB,IAAI,OAAO,IAAI,CAAC,QAAQ,CAAC,SAAS,KAAK,WAAW;YAChD,IAAI,CAAC,QAAQ,CAAC,SAAS,GAAG,cAAc,CAAC,uBAAuB,CAAC;QACnE,IAAI,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE;YACvB,IAAI,OAAO,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,KAAK,QAAQ,IAAI,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC;gBAClF,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC;YAClD,IAAI,OAAO,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,KAAK,QAAQ,IAAI,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,GAAG,CAAC;gBAChF,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,CAAC;SACjD;QACD,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;IACrB,CAAC;IACD,IAAW,OAAO,KAAoB,OAAQ,IAAI,CAAC,SAAiB,CAAC,CAAC,CAAC;IACvE,qBAAqB;IACd,aAAa;QAClB,IAAI,CAAC,MAAM,GAAG,IAAI,WAAW,EAAE,CAAC,SAAS,EAAE,CAAC;QAC5C,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC;IACzB,CAAC;IACD,6CAA6C;IAC7C,IAAW,IAAI,KAAc,OAAO,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;IAC1C,cAAc;QACnB,IAAI,IAAI,CAAC,UAAU,CAAC,MAAM,IAAI,IAAI,CAAC,YAAY;YAC7C,MAAM,IAAI,KAAK,CAAC,gBAAgB,CAAC,CAAC;QACpC,OAAO,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,YAAY,CAAU,CAAC;IACrD,CAAC;IACD,2DAA2D;IAC3D,IAAW,KAAK,KAAiB,OAAO,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;IAC9C,KAAK,CAAC,QAAQ;QACpB,IAAI,IAAI,CAAC,WAAW,EAAE;YACpB,OAAO,EAAE,CAAC;SACX;QACD,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;QACtB,IAAI,CAAC,aAAa,IAAI,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC;QAC7C,IAAI,CAAC,YAAY,IAAI,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC;QAC5C,IAAI,IAAI,CAAC,YAAY,KAAK,CAAC,EAAE;YAC3B,OAAO,EAAE,CAAC;SACX;QACD,MAAM,WAAW,GAAG,IAAI,CAAC,QAAQ,CAAC,SAAS,KAAK,cAAc,CAAC,kBAAkB,CAAC,CAAC,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,CAAC,aAAa,CAAC,UAAU,CAAC;QACrI,MAAM,OAAO,GAAmB;YAC9B,GAAI,IAAI,CAAC,QAAQ;YACjB,IAAI,EAAE,aAAa,CAAC,KAAK;YACzB,WAAW;YACX,KAAK,EAAE,IAAI,CAAC,KAAK;YACjB,IAAI,EAAE,IAAI,CAAC,MAAM;SAClB,CAAC;QACF,OAAO,CAAC,eAAe,GAAG,IAAI,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC;QAChE,OAAO,CAAC,KAAK,GAAG,EAAE,MAAM,EAAE,IAAI,CAAC,aAAa,EAAE,KAAK,EAAE,IAAI,CAAC,YAAY,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,EAAE,CAAC;QACtG,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;QAC9C,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,MAAM,KAAK,gBAAgB,CAAC,IAAI,CAAC;QACzD,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM,KAAK,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE;YACpD,IAAI,CAAC,MAAM,GAAG,IAAI,mBAAmB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;SAClD;QACD,KAAK,MAAM,GAAG,IAAI,IAAI,CAAC,IAAI,EAAE;YAC3B,WAAW,CAAC,2BAA2B,CAAC,GAAG,CAAC,CAAC;SAC9C;QACD,OAAO,IAAI,CAAC,IAAI,CAAC;IACnB,CAAC;IACO,KAAK,CAAC,YAAY,CAAC,OAAuB;QAChD,MAAM,SAAS,GAAG,CAAC,EAAmB,EAAE,EAAE,CAAC,CAAC,EAAE,CAAC,MAAM,KAAK,gBAAgB,CAAC,OAAO,IAAI,EAAE,CAAC,MAAM,KAAK,gBAAgB,CAAC,SAAS,IAAI,EAAE,CAAC,MAAM,KAAK,gBAAgB,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC;QACpM,MAAM,WAAW,GAAG,CAAC,EAAmB,EAAE,EAAE;YAC1C,IAAI,CAAC,MAAM,CAAC,cAAc,IAAI,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC;YAC/C,IAAI,CAAC,MAAM,CAAC,gBAAgB,IAAI,EAAE,CAAC,KAAK,CAAC,SAAS,CAAC;YACnD,IAAI,CAAC,MAAM,CAAC,cAAc,IAAI,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC;YAC/C,IAAI,CAAC,MAAM,CAAC,mBAAmB,IAAI,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC;QACpD,CAAC,CAAC;QACF,MAAM,SAAS,GAAG,KAAK,EAAE,GAAmB,EAAE,EAAE;YAC9C,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;YAC7B,MAAM,EAAE,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;YAC7C,IAAI,CAAC,KAAK,CAAC,SAAS,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,SAAS,CAAC,CAAC;YACjD,OAAO,EAAE,CAAC;QACZ,CAAC,CAAC;QACF,IAAI,KAAK,GAAG,WAAW,CAAC,cAAc,CAAC;QACvC,IAAI,IAAI,GAAG,MAAM,SAAS,CAAC,OAAO,CAAC,CAAC;QACpC,YAAY,CAAC,YAAY,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QACzC,OAAO,EAAE,KAAK,GAAG,CAAC,IAAI,SAAS,CAAC,IAAI,CAAC,EAAE;YACrC,IAAI,GAAG,MAAM,SAAS,CAAC,OAAO,CAAC,CAAC;YAChC,IAAI,CAAC,MAAM,CAAC,UAAU,IAAI,CAAC,CAAC;YAC5B,IAAI,SAAS,CAAC,IAAI,CAAC,EAAE;gBACnB,WAAW,CAAC,IAAI,CAAC,CAAC;aACnB;SACF;QACD,IAAI,KAAK,KAAK,CAAC,IAAI,SAAS,CAAC,IAAI,CAAC,EAAE;YAClC,MAAM,IAAI,KAAK,CAAC,iDAAiD,CAAC,CAAC;SACpE;QACD,WAAW,CAAC,IAAI,CAAC,CAAC;QAClB,OAAO,IAAI,CAAC;IACd,CAAC;IACM,gBAAgB,CAAC,mBAA4B,KAAK;QACvD,IAAI,CAAC,gBAAgB,IAAI,IAAI,CAAC,QAAQ,CAAC,SAAS,KAAK,cAAc,CAAC,uBAAuB,EAAE;YAC3F,OAAO,IAAI,CAAC,cAAc,EAAE,CAAC;SAC9B;QACD,MAAM,YAAY,GAAG,EAAE,CAAC;QACxB,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,MAAM,EAAE;YAC9B,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,SAAS,KAAK,cAAc,CAAC,kBAAkB,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;YAC3G,MAAM,GAAG,GAAG,IAAI,CAAC,cAAc,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YAC9C,IAAI,OAAO,GAAG,KAAK,WAAW,IAAI,GAAG,KAAK,IAAI,EAAE;gBAC9C,MAAM,CAAC,cAAc,CAAC,YAAY,EAAE,QAAQ,EAAE;oBAC5C,KAAK,EAAE,GAAG;oBACV,UAAU,EAAE,IAAI;iBACjB,CAAC,CAAC;aACJ;SACF;QACD,OAAO,YAAY,CAAC;IACtB,CAAC;IACM,KAAK,CAAC,WAAW;QACtB,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE;YAC5B,MAAM,IAAI,CAAC,SAAS,EAAE,CAAC;SACxB;QACD,OAAO,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC;IAChC,CAAC;IACO,KAAK,CAAC,SAAS;QACrB,IAAI,CAAC,YAAY,GAAG,CAAC,CAAC,CAAC;QACvB,IAAI,CAAC,UAAU,GAAG,MAAM,IAAI,CAAC,QAAQ,EAAE,CAAC;QACxC,IAAI,IAAI,CAAC,UAAU,CAAC,MAAM,KAAK,CAAC,EAAE;YAChC,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;SACnB;IACH,CAAC;IACM,KAAK,CAAC,IAAI;QACf,IAAI,IAAI,CAAC,KAAK,EAAE;YACd,OAAO,KAAK,CAAC;SACd;QACD,MAAM,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC;QAC1C,IAAI,IAAI,CAAC,YAAY,GAAG,UAAU,GAAG,CAAC,EAAE;YACtC,EAAE,IAAI,CAAC,YAAY,CAAC;SACrB;aAAM;YACL,MAAM,IAAI,CAAC,SAAS,EAAE,CAAC;YACvB,IAAI,CAAC,YAAY,GAAG,CAAC,CAAC;YACtB,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC;SACpB;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IACM,KAAK,CAAC,OAAO;QAClB,MAAM,IAAI,GAAG,EAAE,CAAC;QAChB,OAAO,MAAM,IAAI,CAAC,IAAI,EAAE,EAAE;YACxB,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,gBAAgB,EAAE,CAAC,CAAC;SACpC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IACM,CAAC,MAAM,CAAC,aAAa,CAAC;QAC3B,OAAO,IAAI,CAAC;IACd,CAAC;IACM,KAAK,CAAC,IAAI;QACf,IAAI,MAAM,IAAI,CAAC,IAAI,EAAE,EAAE;YACrB,OAAO;gBACL,IAAI,EAAE,KAAK;gBACX,KAAK,EAAE,IAAI,CAAC,OAAO;aACpB,CAAC;SACH;aAAM;YACL,OAAO;gBACL,IAAI,EAAE,IAAI;gBACV,KAAK,EAAE,IAAI,CAAC,OAAO;aACpB,CAAC;SACH;IACH,CAAC;;AA1OuB,0BAAc,GAAG,EAAE,AAAL,CAAM;SADjC,WAAW","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module iModels\r\n */\r\nimport { Base64EncodedString } from \"./Base64EncodedString\";\r\nimport {\r\n  DbQueryError, DbQueryRequest, DbQueryResponse, DbRequestExecutor, DbRequestKind, DbResponseStatus, DbValueFormat, QueryBinder, QueryOptions, QueryOptionsBuilder,\r\n  QueryPropertyMetaData, QueryRowFormat,\r\n} from \"./ConcurrentQuery\";\r\n\r\n/** @beta */\r\nexport class PropertyMetaDataMap implements Iterable<QueryPropertyMetaData> {\r\n  private _byPropName = new Map<string, number>();\r\n  private _byJsonName = new Map<string, number>();\r\n  private _byNoCase = new Map<string, number>();\r\n  public constructor(public readonly properties: QueryPropertyMetaData[]) {\r\n    for (const property of this.properties) {\r\n      this._byPropName.set(property.name, property.index);\r\n      this._byJsonName.set(property.jsonName, property.index);\r\n      this._byNoCase.set(property.name.toLowerCase(), property.index);\r\n      this._byNoCase.set(property.jsonName.toLowerCase(), property.index);\r\n    }\r\n  }\r\n  public get length(): number { return this.properties.length; }\r\n\r\n  public [Symbol.iterator](): Iterator<QueryPropertyMetaData, any, undefined> {\r\n    return this.properties[Symbol.iterator]();\r\n  }\r\n  public findByName(name: string): QueryPropertyMetaData | undefined {\r\n    const index = this._byPropName.get(name);\r\n    if (typeof index === \"number\") {\r\n      return this.properties[index];\r\n    }\r\n    return undefined;\r\n  }\r\n  public findByJsonName(name: string): QueryPropertyMetaData | undefined {\r\n    const index = this._byJsonName.get(name);\r\n    if (typeof index === \"number\") {\r\n      return this.properties[index];\r\n    }\r\n    return undefined;\r\n  }\r\n  public findByNoCase(name: string): QueryPropertyMetaData | undefined {\r\n    const index = this._byNoCase.get(name.toLowerCase());\r\n    if (typeof index === \"number\") {\r\n      return this.properties[index];\r\n    }\r\n    return undefined;\r\n  }\r\n}\r\n/**\r\n * @beta\r\n*/\r\nexport type QueryValueType = any;\r\n\r\n/** @beta */\r\nexport interface QueryRowProxy {\r\n  toRow(): any;\r\n  toArray(): QueryValueType[];\r\n  getMetaData(): QueryPropertyMetaData[];\r\n  [propertyName: string]: QueryValueType;\r\n  [propertyIndex: number]: QueryValueType;\r\n}\r\n\r\n/** @beta */\r\nexport interface QueryStats {\r\n  backendCpuTime: number; // Time spent running the query. It exclude query time in queue. Time is in microseconds.\r\n  backendTotalTime: number; // backend total time spent running the query. Time is in milliseconds.\r\n  backendMemUsed: number; // Estimated m emory used for query. Time is in milliseconds.\r\n  backendRowsReturned: number; // Total rows returned by backend.\r\n  totalTime: number; // Round trip time from client perspective.Time is in milliseconds.\r\n  retryCount: number;\r\n}\r\n\r\n/** @beta */\r\nexport class ECSqlReader implements AsyncIterableIterator<QueryRowProxy>  {\r\n  private static readonly _maxRetryCount = 10;\r\n  private _localRows: any[] = [];\r\n  private _localOffset: number = 0;\r\n  private _globalOffset: number = -1;\r\n  private _globalCount: number = -1;\r\n  private _done: boolean = false;\r\n  private _globalDone: boolean = false;\r\n  private _props = new PropertyMetaDataMap([]);\r\n  private _param = new QueryBinder().serialize();\r\n  private _lockArgs: boolean = false;\r\n  private _stats = { backendCpuTime: 0, backendTotalTime: 0, backendMemUsed: 0, backendRowsReturned: 0, totalTime: 0, retryCount: 0 };\r\n  private _rowProxy = new Proxy<ECSqlReader>(this, {\r\n    get: (target: ECSqlReader, key: string | Symbol) => {\r\n      if (typeof key === \"string\") {\r\n        const idx = Number.parseInt(key, 10);\r\n        if (!Number.isNaN(idx)) {\r\n          return target.getRowInternal()[idx];\r\n        }\r\n        const prop = target._props.findByNoCase(key);\r\n        if (prop) {\r\n          return target.getRowInternal()[prop.index];\r\n        }\r\n        if (key === \"getMetaData\") {\r\n          return () => target._props.properties;\r\n        }\r\n        if (key === \"toRow\") {\r\n          return () => target.formatCurrentRow(true);\r\n        }\r\n        if (key === \"toArray\") {\r\n          return () => this.getRowInternal();\r\n        }\r\n      }\r\n      return undefined;\r\n    },\r\n    has: (target: ECSqlReader, p: string | symbol) => {\r\n      return !target._props.findByNoCase(p as string);\r\n    },\r\n    ownKeys: (target: ECSqlReader) => {\r\n      const keys = [];\r\n      for (const prop of target._props) {\r\n        keys.push(prop.name);\r\n      }\r\n      return keys;\r\n    },\r\n  });\r\n  private _options: QueryOptions = new QueryOptionsBuilder().getOptions();\r\n  /** @internal */\r\n  public constructor(private _executor: DbRequestExecutor<DbQueryRequest, DbQueryResponse>, public readonly query: string, param?: QueryBinder, options?: QueryOptions) {\r\n    if (query.trim().length === 0) {\r\n      throw new Error(\"expecting non-empty ecsql statement\");\r\n    }\r\n    if (param) {\r\n      this._param = param.serialize();\r\n    }\r\n    this.reset(options);\r\n  }\r\n  private static replaceBase64WithUint8Array(row: any) {\r\n    for (const key of Object.keys(row)) {\r\n      const val = row[key];\r\n      if (typeof val === \"string\") {\r\n        if (Base64EncodedString.hasPrefix(val)) {\r\n          row[key] = Base64EncodedString.toUint8Array(val);\r\n        }\r\n      } else if (typeof val === \"object\" && val !== null) {\r\n        this.replaceBase64WithUint8Array(val);\r\n      }\r\n    }\r\n  }\r\n  public setParams(param: QueryBinder) {\r\n    if (this._lockArgs) {\r\n      throw new Error(\"call resetBindings() before setting or changing parameters\");\r\n    }\r\n    this._param = param.serialize();\r\n  }\r\n  public reset(options?: QueryOptions) {\r\n    if (options) {\r\n      this._options = options;\r\n    }\r\n    this._props = new PropertyMetaDataMap([]);\r\n    this._localRows = [];\r\n    this._globalDone = false;\r\n    this._globalOffset = 0;\r\n    this._globalCount = -1;\r\n    if (typeof this._options.rowFormat === \"undefined\")\r\n      this._options.rowFormat = QueryRowFormat.UseECSqlPropertyIndexes;\r\n    if (this._options.limit) {\r\n      if (typeof this._options.limit.offset === \"number\" && this._options.limit.offset > 0)\r\n        this._globalOffset = this._options.limit.offset;\r\n      if (typeof this._options.limit.count === \"number\" && this._options.limit.count > 0)\r\n        this._globalCount = this._options.limit.count;\r\n    }\r\n    this._done = false;\r\n  }\r\n  public get current(): QueryRowProxy { return (this._rowProxy as any); }\r\n  // clear all bindings\r\n  public resetBindings() {\r\n    this._param = new QueryBinder().serialize();\r\n    this._lockArgs = false;\r\n  }\r\n  // return if there is any more rows available\r\n  public get done(): boolean { return this._done; }\r\n  public getRowInternal(): any[] {\r\n    if (this._localRows.length <= this._localOffset)\r\n      throw new Error(\"no current row\");\r\n    return this._localRows[this._localOffset] as any[];\r\n  }\r\n  // return performance related statistics for current query.\r\n  public get stats(): QueryStats { return this._stats; }\r\n  private async readRows(): Promise<any[]> {\r\n    if (this._globalDone) {\r\n      return [];\r\n    }\r\n    this._lockArgs = true;\r\n    this._globalOffset += this._localRows.length;\r\n    this._globalCount -= this._localRows.length;\r\n    if (this._globalCount === 0) {\r\n      return [];\r\n    }\r\n    const valueFormat = this._options.rowFormat === QueryRowFormat.UseJsPropertyNames ? DbValueFormat.JsNames : DbValueFormat.ECSqlNames;\r\n    const request: DbQueryRequest = {\r\n      ... this._options,\r\n      kind: DbRequestKind.ECSql,\r\n      valueFormat,\r\n      query: this.query,\r\n      args: this._param,\r\n    };\r\n    request.includeMetaData = this._props.length > 0 ? false : true;\r\n    request.limit = { offset: this._globalOffset, count: this._globalCount < 1 ? -1 : this._globalCount };\r\n    const resp = await this.runWithRetry(request);\r\n    this._globalDone = resp.status === DbResponseStatus.Done;\r\n    if (this._props.length === 0 && resp.meta.length > 0) {\r\n      this._props = new PropertyMetaDataMap(resp.meta);\r\n    }\r\n    for (const row of resp.data) {\r\n      ECSqlReader.replaceBase64WithUint8Array(row);\r\n    }\r\n    return resp.data;\r\n  }\r\n  private async runWithRetry(request: DbQueryRequest) {\r\n    const needRetry = (rs: DbQueryResponse) => (rs.status === DbResponseStatus.Partial || rs.status === DbResponseStatus.QueueFull || rs.status === DbResponseStatus.Timeout) && (rs.data.length === 0);\r\n    const updateStats = (rs: DbQueryResponse) => {\r\n      this._stats.backendCpuTime += rs.stats.cpuTime;\r\n      this._stats.backendTotalTime += rs.stats.totalTime;\r\n      this._stats.backendMemUsed += rs.stats.memUsed;\r\n      this._stats.backendRowsReturned += rs.data.length;\r\n    };\r\n    const execQuery = async (req: DbQueryRequest) => {\r\n      const startTime = Date.now();\r\n      const rs = await this._executor.execute(req);\r\n      this.stats.totalTime += (Date.now() - startTime);\r\n      return rs;\r\n    };\r\n    let retry = ECSqlReader._maxRetryCount;\r\n    let resp = await execQuery(request);\r\n    DbQueryError.throwIfError(resp, request);\r\n    while (--retry > 0 && needRetry(resp)) {\r\n      resp = await execQuery(request);\r\n      this._stats.retryCount += 1;\r\n      if (needRetry(resp)) {\r\n        updateStats(resp);\r\n      }\r\n    }\r\n    if (retry === 0 && needRetry(resp)) {\r\n      throw new Error(\"query too long to execute or server is too busy\");\r\n    }\r\n    updateStats(resp);\r\n    return resp;\r\n  }\r\n  public formatCurrentRow(onlyReturnObject: boolean = false): any[] | object {\r\n    if (!onlyReturnObject && this._options.rowFormat === QueryRowFormat.UseECSqlPropertyIndexes) {\r\n      return this.getRowInternal();\r\n    }\r\n    const formattedRow = {};\r\n    for (const prop of this._props) {\r\n      const propName = this._options.rowFormat === QueryRowFormat.UseJsPropertyNames ? prop.jsonName : prop.name;\r\n      const val = this.getRowInternal()[prop.index];\r\n      if (typeof val !== \"undefined\" && val !== null) {\r\n        Object.defineProperty(formattedRow, propName, {\r\n          value: val,\r\n          enumerable: true,\r\n        });\r\n      }\r\n    }\r\n    return formattedRow;\r\n  }\r\n  public async getMetaData(): Promise<QueryPropertyMetaData[]> {\r\n    if (this._props.length === 0) {\r\n      await this.fetchRows();\r\n    }\r\n    return this._props.properties;\r\n  }\r\n  private async fetchRows() {\r\n    this._localOffset = -1;\r\n    this._localRows = await this.readRows();\r\n    if (this._localRows.length === 0) {\r\n      this._done = true;\r\n    }\r\n  }\r\n  public async step(): Promise<boolean> {\r\n    if (this._done) {\r\n      return false;\r\n    }\r\n    const cachedRows = this._localRows.length;\r\n    if (this._localOffset < cachedRows - 1) {\r\n      ++this._localOffset;\r\n    } else {\r\n      await this.fetchRows();\r\n      this._localOffset = 0;\r\n      return !this._done;\r\n    }\r\n    return true;\r\n  }\r\n  public async toArray(): Promise<any[]> {\r\n    const rows = [];\r\n    while (await this.step()) {\r\n      rows.push(this.formatCurrentRow());\r\n    }\r\n    return rows;\r\n  }\r\n  public [Symbol.asyncIterator](): AsyncIterableIterator<QueryRowProxy> {\r\n    return this;\r\n  }\r\n  public async next(): Promise<IteratorResult<QueryRowProxy, any>> {\r\n    if (await this.step()) {\r\n      return {\r\n        done: false,\r\n        value: this.current,\r\n      };\r\n    } else {\r\n      return {\r\n        done: true,\r\n        value: this.current,\r\n      };\r\n    }\r\n  }\r\n}\r\n\r\n"]}
+{"version":3,"file":"ECSqlReader.js","sourceRoot":"","sources":["../../src/ECSqlReader.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AACH,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAC5D,OAAO,EACL,YAAY,EAAsD,aAAa,EAAE,gBAAgB,EAAE,aAAa,EAAE,WAAW,EAAgB,mBAAmB,EACzI,cAAc,GACtC,MAAM,mBAAmB,CAAC;AAE3B,YAAY;AACZ,MAAM,OAAO,mBAAmB;IAK9B,YAAmC,UAAmC;QAAnC,eAAU,GAAV,UAAU,CAAyB;QAJ9D,gBAAW,GAAG,IAAI,GAAG,EAAkB,CAAC;QACxC,gBAAW,GAAG,IAAI,GAAG,EAAkB,CAAC;QACxC,cAAS,GAAG,IAAI,GAAG,EAAkB,CAAC;QAG5C,KAAK,MAAM,QAAQ,IAAI,IAAI,CAAC,UAAU,EAAE;YACtC,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC,KAAK,CAAC,CAAC;YACpD,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC,KAAK,CAAC,CAAC;YACxD,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,WAAW,EAAE,EAAE,QAAQ,CAAC,KAAK,CAAC,CAAC;YAChE,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,QAAQ,CAAC,QAAQ,CAAC,WAAW,EAAE,EAAE,QAAQ,CAAC,KAAK,CAAC,CAAC;SACrE;IACH,CAAC;IAED,IAAW,MAAM;QACf,OAAO,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC;IAChC,CAAC;IAEM,CAAC,MAAM,CAAC,QAAQ,CAAC;QACtB,OAAO,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC;IAC5C,CAAC;IAEM,UAAU,CAAC,IAAY;QAC5B,MAAM,KAAK,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QACzC,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;YAC7B,OAAO,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;SAC/B;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;IAEM,cAAc,CAAC,IAAY;QAChC,MAAM,KAAK,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QACzC,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;YAC7B,OAAO,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;SAC/B;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;IAEM,YAAY,CAAC,IAAY;QAC9B,MAAM,KAAK,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC;QACrD,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;YAC7B,OAAO,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;SAC/B;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;CACF;AAgFD;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAa,WAAW;IAkDtB;;OAEG;IACH,YAA2B,SAA6D,EAAkB,KAAa,EAAE,KAAmB,EAAE,OAAsB;QAAzI,cAAS,GAAT,SAAS,CAAoD;QAAkB,UAAK,GAAL,KAAK,CAAQ;QAlD/G,eAAU,GAAU,EAAE,CAAC;QACvB,iBAAY,GAAW,CAAC,CAAC;QACzB,kBAAa,GAAW,CAAC,CAAC,CAAC;QAC3B,iBAAY,GAAW,CAAC,CAAC,CAAC;QAC1B,UAAK,GAAY,KAAK,CAAC;QACvB,gBAAW,GAAY,KAAK,CAAC;QAC7B,WAAM,GAAG,IAAI,mBAAmB,CAAC,EAAE,CAAC,CAAC;QACrC,WAAM,GAAG,IAAI,WAAW,EAAE,CAAC,SAAS,EAAE,CAAC;QACvC,cAAS,GAAY,KAAK,CAAC;QAC3B,WAAM,GAAG,EAAE,cAAc,EAAE,CAAC,EAAE,gBAAgB,EAAE,CAAC,EAAE,cAAc,EAAE,CAAC,EAAE,mBAAmB,EAAE,CAAC,EAAE,SAAS,EAAE,CAAC,EAAE,UAAU,EAAE,CAAC,EAAE,CAAC;QAC5H,aAAQ,GAAiB,IAAI,mBAAmB,EAAE,CAAC,UAAU,EAAE,CAAC;QAEhE,cAAS,GAAG,IAAI,KAAK,CAAc,IAAI,EAAE;YAC/C,GAAG,EAAE,CAAC,MAAmB,EAAE,GAAoB,EAAE,EAAE;gBACjD,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE;oBAC3B,MAAM,GAAG,GAAG,MAAM,CAAC,QAAQ,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;oBACrC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE;wBACtB,OAAO,MAAM,CAAC,cAAc,EAAE,CAAC,GAAG,CAAC,CAAC;qBACrC;oBACD,MAAM,IAAI,GAAG,MAAM,CAAC,MAAM,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC;oBAC7C,IAAI,IAAI,EAAE;wBACR,OAAO,MAAM,CAAC,cAAc,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;qBAC5C;oBACD,IAAI,GAAG,KAAK,aAAa,EAAE;wBACzB,OAAO,GAAG,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC;qBACvC;oBACD,IAAI,GAAG,KAAK,OAAO,EAAE;wBACnB,OAAO,GAAG,EAAE,CAAC,MAAM,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC;qBAC5C;oBACD,IAAI,GAAG,KAAK,SAAS,EAAE;wBACrB,OAAO,GAAG,EAAE,CAAC,IAAI,CAAC,cAAc,EAAE,CAAC;qBACpC;iBACF;gBACD,OAAO,SAAS,CAAC;YACnB,CAAC;YACD,GAAG,EAAE,CAAC,MAAmB,EAAE,CAAkB,EAAE,EAAE;gBAC/C,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,YAAY,CAAC,CAAW,CAAC,CAAC;YAClD,CAAC;YACD,OAAO,EAAE,CAAC,MAAmB,EAAE,EAAE;gBAC/B,MAAM,IAAI,GAAG,EAAE,CAAC;gBAChB,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,MAAM,EAAE;oBAChC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;iBACtB;gBACD,OAAO,IAAI,CAAC;YACd,CAAC;SACF,CAAC,CAAC;QAMD,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC,MAAM,KAAK,CAAC,EAAE;YAC7B,MAAM,IAAI,KAAK,CAAC,qCAAqC,CAAC,CAAC;SACxD;QACD,IAAI,KAAK,EAAE;YACT,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC,SAAS,EAAE,CAAC;SACjC;QACD,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IACtB,CAAC;IAEO,MAAM,CAAC,2BAA2B,CAAC,GAAQ;QACjD,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE;YAClC,MAAM,GAAG,GAAG,GAAG,CAAC,GAAG,CAAC,CAAC;YACrB,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE;gBAC3B,IAAI,mBAAmB,CAAC,SAAS,CAAC,GAAG,CAAC,EAAE;oBACtC,GAAG,CAAC,GAAG,CAAC,GAAG,mBAAmB,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC;iBAClD;aACF;iBAAM,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,GAAG,KAAK,IAAI,EAAE;gBAClD,IAAI,CAAC,2BAA2B,CAAC,GAAG,CAAC,CAAC;aACvC;SACF;IACH,CAAC;IAEM,SAAS,CAAC,KAAkB;QACjC,IAAI,IAAI,CAAC,SAAS,EAAE;YAClB,MAAM,IAAI,KAAK,CAAC,4DAA4D,CAAC,CAAC;SAC/E;QACD,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC,SAAS,EAAE,CAAC;IAClC,CAAC;IAEM,KAAK,CAAC,OAAsB;QACjC,IAAI,OAAO,EAAE;YACX,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;SACzB;QACD,IAAI,CAAC,MAAM,GAAG,IAAI,mBAAmB,CAAC,EAAE,CAAC,CAAC;QAC1C,IAAI,CAAC,UAAU,GAAG,EAAE,CAAC;QACrB,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC;QACzB,IAAI,CAAC,aAAa,GAAG,CAAC,CAAC;QACvB,IAAI,CAAC,YAAY,GAAG,CAAC,CAAC,CAAC;QACvB,IAAI,OAAO,IAAI,CAAC,QAAQ,CAAC,SAAS,KAAK,WAAW;YAChD,IAAI,CAAC,QAAQ,CAAC,SAAS,GAAG,cAAc,CAAC,uBAAuB,CAAC;QACnE,IAAI,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE;YACvB,IAAI,OAAO,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,KAAK,QAAQ,IAAI,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC;gBAClF,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC;YAClD,IAAI,OAAO,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,KAAK,QAAQ,IAAI,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,GAAG,CAAC;gBAChF,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,CAAC;SACjD;QACD,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;IACrB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,IAAW,OAAO;QAChB,OAAO,IAAI,CAAC,SAAgB,CAAC;IAC/B,CAAC;IAED;;OAEG;IACI,aAAa;QAClB,IAAI,CAAC,MAAM,GAAG,IAAI,WAAW,EAAE,CAAC,SAAS,EAAE,CAAC;QAC5C,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC;IACzB,CAAC;IAED;;;;;OAKG;IACH,IAAW,IAAI;QACb,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAED;;OAEG;IACI,cAAc;QACnB,IAAI,IAAI,CAAC,UAAU,CAAC,MAAM,IAAI,IAAI,CAAC,YAAY;YAC7C,MAAM,IAAI,KAAK,CAAC,gBAAgB,CAAC,CAAC;QACpC,OAAO,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,YAAY,CAAU,CAAC;IACrD,CAAC;IAED;;OAEG;IACH,IAAW,KAAK;QACd,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED;;OAEG;IACK,KAAK,CAAC,QAAQ;QACpB,IAAI,IAAI,CAAC,WAAW,EAAE;YACpB,OAAO,EAAE,CAAC;SACX;QACD,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;QACtB,IAAI,CAAC,aAAa,IAAI,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC;QAC7C,IAAI,CAAC,YAAY,IAAI,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC;QAC5C,IAAI,IAAI,CAAC,YAAY,KAAK,CAAC,EAAE;YAC3B,OAAO,EAAE,CAAC;SACX;QACD,MAAM,WAAW,GAAG,IAAI,CAAC,QAAQ,CAAC,SAAS,KAAK,cAAc,CAAC,kBAAkB,CAAC,CAAC,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,CAAC,aAAa,CAAC,UAAU,CAAC;QACrI,MAAM,OAAO,GAAmB;YAC9B,GAAI,IAAI,CAAC,QAAQ;YACjB,IAAI,EAAE,aAAa,CAAC,KAAK;YACzB,WAAW;YACX,KAAK,EAAE,IAAI,CAAC,KAAK;YACjB,IAAI,EAAE,IAAI,CAAC,MAAM;SAClB,CAAC;QACF,OAAO,CAAC,eAAe,GAAG,IAAI,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC;QAChE,OAAO,CAAC,KAAK,GAAG,EAAE,MAAM,EAAE,IAAI,CAAC,aAAa,EAAE,KAAK,EAAE,IAAI,CAAC,YAAY,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,EAAE,CAAC;QACtG,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;QAC9C,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,MAAM,KAAK,gBAAgB,CAAC,IAAI,CAAC;QACzD,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM,KAAK,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE;YACpD,IAAI,CAAC,MAAM,GAAG,IAAI,mBAAmB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;SAClD;QACD,KAAK,MAAM,GAAG,IAAI,IAAI,CAAC,IAAI,EAAE;YAC3B,WAAW,CAAC,2BAA2B,CAAC,GAAG,CAAC,CAAC;SAC9C;QACD,OAAO,IAAI,CAAC,IAAI,CAAC;IACnB,CAAC;IAED;;OAEG;IACO,KAAK,CAAC,YAAY,CAAC,OAAuB;QAClD,MAAM,SAAS,GAAG,CAAC,EAAmB,EAAE,EAAE,CAAC,CAAC,EAAE,CAAC,MAAM,KAAK,gBAAgB,CAAC,OAAO,IAAI,EAAE,CAAC,MAAM,KAAK,gBAAgB,CAAC,SAAS,IAAI,EAAE,CAAC,MAAM,KAAK,gBAAgB,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,KAAK,SAAS,IAAI,EAAE,CAAC,IAAI,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC;QAC7N,MAAM,WAAW,GAAG,CAAC,EAAmB,EAAE,EAAE;YAC1C,IAAI,CAAC,MAAM,CAAC,cAAc,IAAI,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC;YAC/C,IAAI,CAAC,MAAM,CAAC,gBAAgB,IAAI,EAAE,CAAC,KAAK,CAAC,SAAS,CAAC;YACnD,IAAI,CAAC,MAAM,CAAC,cAAc,IAAI,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC;YAC/C,IAAI,CAAC,MAAM,CAAC,mBAAmB,IAAI,CAAC,EAAE,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC;QAClF,CAAC,CAAC;QACF,MAAM,SAAS,GAAG,KAAK,EAAE,GAAmB,EAAE,EAAE;YAC9C,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;YAC7B,MAAM,EAAE,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;YAC7C,IAAI,CAAC,KAAK,CAAC,SAAS,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,SAAS,CAAC,CAAC;YACjD,OAAO,EAAE,CAAC;QACZ,CAAC,CAAC;QACF,IAAI,KAAK,GAAG,WAAW,CAAC,cAAc,CAAC;QACvC,IAAI,IAAI,GAAG,MAAM,SAAS,CAAC,OAAO,CAAC,CAAC;QACpC,YAAY,CAAC,YAAY,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QACzC,OAAO,EAAE,KAAK,GAAG,CAAC,IAAI,SAAS,CAAC,IAAI,CAAC,EAAE;YACrC,IAAI,GAAG,MAAM,SAAS,CAAC,OAAO,CAAC,CAAC;YAChC,IAAI,CAAC,MAAM,CAAC,UAAU,IAAI,CAAC,CAAC;YAC5B,IAAI,SAAS,CAAC,IAAI,CAAC,EAAE;gBACnB,WAAW,CAAC,IAAI,CAAC,CAAC;aACnB;SACF;QACD,IAAI,KAAK,KAAK,CAAC,IAAI,SAAS,CAAC,IAAI,CAAC,EAAE;YAClC,MAAM,IAAI,KAAK,CAAC,iDAAiD,CAAC,CAAC;SACpE;QACD,WAAW,CAAC,IAAI,CAAC,CAAC;QAClB,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACI,gBAAgB,CAAC,mBAA4B,KAAK;QACvD,IAAI,CAAC,gBAAgB,IAAI,IAAI,CAAC,QAAQ,CAAC,SAAS,KAAK,cAAc,CAAC,uBAAuB,EAAE;YAC3F,OAAO,IAAI,CAAC,cAAc,EAAE,CAAC;SAC9B;QACD,MAAM,YAAY,GAAG,EAAE,CAAC;QACxB,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,MAAM,EAAE;YAC9B,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,SAAS,KAAK,cAAc,CAAC,kBAAkB,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;YAC3G,MAAM,GAAG,GAAG,IAAI,CAAC,cAAc,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YAC9C,IAAI,OAAO,GAAG,KAAK,WAAW,IAAI,GAAG,KAAK,IAAI,EAAE;gBAC9C,MAAM,CAAC,cAAc,CAAC,YAAY,EAAE,QAAQ,EAAE;oBAC5C,KAAK,EAAE,GAAG;oBACV,UAAU,EAAE,IAAI;iBACjB,CAAC,CAAC;aACJ;SACF;QACD,OAAO,YAAY,CAAC;IACtB,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,WAAW;QACtB,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE;YAC5B,MAAM,IAAI,CAAC,SAAS,EAAE,CAAC;SACxB;QACD,OAAO,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC;IAChC,CAAC;IAED;;OAEG;IACK,KAAK,CAAC,SAAS;QACrB,IAAI,CAAC,YAAY,GAAG,CAAC,CAAC,CAAC;QACvB,IAAI,CAAC,UAAU,GAAG,MAAM,IAAI,CAAC,QAAQ,EAAE,CAAC;QACxC,IAAI,IAAI,CAAC,UAAU,CAAC,MAAM,KAAK,CAAC,EAAE;YAChC,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;SACnB;IACH,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,IAAI;QACf,IAAI,IAAI,CAAC,KAAK,EAAE;YACd,OAAO,KAAK,CAAC;SACd;QACD,MAAM,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC;QAC1C,IAAI,IAAI,CAAC,YAAY,GAAG,UAAU,GAAG,CAAC,EAAE;YACtC,EAAE,IAAI,CAAC,YAAY,CAAC;SACrB;aAAM;YACL,MAAM,IAAI,CAAC,SAAS,EAAE,CAAC;YACvB,IAAI,CAAC,YAAY,GAAG,CAAC,CAAC;YACtB,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC;SACpB;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,OAAO;QAClB,MAAM,IAAI,GAAG,EAAE,CAAC;QAChB,OAAO,MAAM,IAAI,CAAC,IAAI,EAAE,EAAE;YACxB,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,gBAAgB,EAAE,CAAC,CAAC;SACpC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;OAIG;IACI,CAAC,MAAM,CAAC,aAAa,CAAC;QAC3B,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,IAAI;QACf,IAAI,MAAM,IAAI,CAAC,IAAI,EAAE,EAAE;YACrB,OAAO;gBACL,IAAI,EAAE,KAAK;gBACX,KAAK,EAAE,IAAI,CAAC,OAAO;aACpB,CAAC;SACH;aAAM;YACL,OAAO;gBACL,IAAI,EAAE,IAAI;gBACV,KAAK,EAAE,IAAI,CAAC,OAAO;aACpB,CAAC;SACH;IACH,CAAC;;AAtVuB,0BAAc,GAAG,EAAE,AAAL,CAAM;SADjC,WAAW","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module iModels\r\n */\r\nimport { Base64EncodedString } from \"./Base64EncodedString\";\r\nimport {\r\n  DbQueryError, DbQueryRequest, DbQueryResponse, DbRequestExecutor, DbRequestKind, DbResponseStatus, DbValueFormat, QueryBinder, QueryOptions, QueryOptionsBuilder,\r\n  QueryPropertyMetaData, QueryRowFormat,\r\n} from \"./ConcurrentQuery\";\r\n\r\n/** @beta */\r\nexport class PropertyMetaDataMap implements Iterable<QueryPropertyMetaData> {\r\n  private _byPropName = new Map<string, number>();\r\n  private _byJsonName = new Map<string, number>();\r\n  private _byNoCase = new Map<string, number>();\r\n\r\n  public constructor(public readonly properties: QueryPropertyMetaData[]) {\r\n    for (const property of this.properties) {\r\n      this._byPropName.set(property.name, property.index);\r\n      this._byJsonName.set(property.jsonName, property.index);\r\n      this._byNoCase.set(property.name.toLowerCase(), property.index);\r\n      this._byNoCase.set(property.jsonName.toLowerCase(), property.index);\r\n    }\r\n  }\r\n\r\n  public get length(): number {\r\n    return this.properties.length;\r\n  }\r\n\r\n  public [Symbol.iterator](): Iterator<QueryPropertyMetaData, any, undefined> {\r\n    return this.properties[Symbol.iterator]();\r\n  }\r\n\r\n  public findByName(name: string): QueryPropertyMetaData | undefined {\r\n    const index = this._byPropName.get(name);\r\n    if (typeof index === \"number\") {\r\n      return this.properties[index];\r\n    }\r\n    return undefined;\r\n  }\r\n\r\n  public findByJsonName(name: string): QueryPropertyMetaData | undefined {\r\n    const index = this._byJsonName.get(name);\r\n    if (typeof index === \"number\") {\r\n      return this.properties[index];\r\n    }\r\n    return undefined;\r\n  }\r\n\r\n  public findByNoCase(name: string): QueryPropertyMetaData | undefined {\r\n    const index = this._byNoCase.get(name.toLowerCase());\r\n    if (typeof index === \"number\") {\r\n      return this.properties[index];\r\n    }\r\n    return undefined;\r\n  }\r\n}\r\n\r\n/**\r\n * The format for rows returned by [[ECSqlReader]].\r\n * @beta\r\n */\r\nexport type QueryValueType = any;\r\n\r\n/**\r\n * Methods and ways of accessing values from rows returned by [[ECSqlReader]].\r\n * @beta\r\n */\r\nexport interface QueryRowProxy {\r\n  /**\r\n   * Get the current row as a JavaScript `object`.\r\n   *\r\n   * @returns The current row as a JavaScript `object`.\r\n   */\r\n  toRow(): any;\r\n\r\n  /**\r\n   * Get all remaining rows from the query result.\r\n   * If called on the current row ([[ECSqlReader.current]]), only that row is returned.\r\n   *\r\n   * @returns All remaining rows from the query result.\r\n   */\r\n  toArray(): QueryValueType[];\r\n\r\n  /**\r\n   * Get the metadata for each column in the query result.\r\n   *\r\n   * @returns The metadata for each column in the query result.\r\n   */\r\n  getMetaData(): QueryPropertyMetaData[];\r\n\r\n  /**\r\n   * Access a property using its name.\r\n   *\r\n   * @returns The value from the row whose key (ECSQL column name) is `propertyName`.\r\n   *\r\n   * @example\r\n   * The following lines will all return the same result:\r\n   * ```ts\r\n   * reader.current.ECInstanceId;\r\n   * reader.current.ecinstanceid;\r\n   * reader.current.[\"ECInstanceId\"];\r\n   * ```\r\n   */\r\n  [propertyName: string]: QueryValueType;\r\n\r\n  /**\r\n   * Access a property using its index.\r\n   * The index is relative to the order of the columns returned by the query that produced the row.\r\n   *\r\n   * @returns The value from the column at `propertyIndex`.\r\n   *\r\n   * @example reader.current[0]\r\n   */\r\n  [propertyIndex: number]: QueryValueType;\r\n}\r\n\r\n/**\r\n * Performance-related statistics for [[ECSqlReader]].\r\n * @beta\r\n */\r\nexport interface QueryStats {\r\n  /** Time spent running the query; not including time spent queued. Time is in microseconds */\r\n  backendCpuTime: number;\r\n  /** Total time it took the backend to run the query. Time is in milliseconds. */\r\n  backendTotalTime: number;\r\n  /** Estimated memory used for the query. */\r\n  backendMemUsed: number;\r\n  /** Total number of rows returned by the backend. */\r\n  backendRowsReturned: number;\r\n  /** The total round trip time from the client's perspective. Time is in milliseconds. */\r\n  totalTime: number;\r\n  /** The number of retries attempted to execute the query. */\r\n  retryCount: number;\r\n}\r\n\r\n/**\r\n * Execute ECSQL statements and read the results.\r\n *\r\n * The query results are returned one row at a time. The format of the row is dictated by the\r\n * [[QueryOptions.rowFormat]] specified in the `options` parameter of the constructed ECSqlReader object. Defaults to\r\n * [[QueryRowFormat.UseECSqlPropertyIndexes]] when no `rowFormat` is defined.\r\n *\r\n * There are three primary ways to interact with and read the results:\r\n * - Stream them using ECSqlReader as an asynchronous iterator.\r\n * - Iterator over them manually using [[ECSqlReader.step]].\r\n * - Capture all of the results at once in an array using [[QueryRowProxy.toArray]].\r\n *\r\n * @see\r\n * - [ECSQL Overview]($docs/learning/backend/ExecutingECSQL)\r\n * - [ECSQL Row Formats]($docs/learning/ECSQLRowFormat) for more details on how rows are formatted.\r\n * - [ECSQL Code Examples]($docs/learning/ECSQLCodeExamples#iterating-over-query-results) for examples of each\r\n *      of the above ways of interacting with ECSqlReader.\r\n *\r\n * @note When iterating over the results, the current row will be a [[QueryRowProxy]] object. To get the row as a basic\r\n *       JavaScript object, call [[QueryRowProxy.toRow]] on it.\r\n *\r\n * @beta\r\n */\r\nexport class ECSqlReader implements AsyncIterableIterator<QueryRowProxy> {\r\n  private static readonly _maxRetryCount = 10;\r\n\r\n  private _localRows: any[] = [];\r\n  private _localOffset: number = 0;\r\n  private _globalOffset: number = -1;\r\n  private _globalCount: number = -1;\r\n  private _done: boolean = false;\r\n  private _globalDone: boolean = false;\r\n  private _props = new PropertyMetaDataMap([]);\r\n  private _param = new QueryBinder().serialize();\r\n  private _lockArgs: boolean = false;\r\n  private _stats = { backendCpuTime: 0, backendTotalTime: 0, backendMemUsed: 0, backendRowsReturned: 0, totalTime: 0, retryCount: 0 };\r\n  private _options: QueryOptions = new QueryOptionsBuilder().getOptions();\r\n\r\n  private _rowProxy = new Proxy<ECSqlReader>(this, {\r\n    get: (target: ECSqlReader, key: string | Symbol) => {\r\n      if (typeof key === \"string\") {\r\n        const idx = Number.parseInt(key, 10);\r\n        if (!Number.isNaN(idx)) {\r\n          return target.getRowInternal()[idx];\r\n        }\r\n        const prop = target._props.findByNoCase(key);\r\n        if (prop) {\r\n          return target.getRowInternal()[prop.index];\r\n        }\r\n        if (key === \"getMetaData\") {\r\n          return () => target._props.properties;\r\n        }\r\n        if (key === \"toRow\") {\r\n          return () => target.formatCurrentRow(true);\r\n        }\r\n        if (key === \"toArray\") {\r\n          return () => this.getRowInternal();\r\n        }\r\n      }\r\n      return undefined;\r\n    },\r\n    has: (target: ECSqlReader, p: string | symbol) => {\r\n      return !target._props.findByNoCase(p as string);\r\n    },\r\n    ownKeys: (target: ECSqlReader) => {\r\n      const keys = [];\r\n      for (const prop of target._props) {\r\n        keys.push(prop.name);\r\n      }\r\n      return keys;\r\n    },\r\n  });\r\n\r\n  /**\r\n   * @internal\r\n   */\r\n  public constructor(private _executor: DbRequestExecutor<DbQueryRequest, DbQueryResponse>, public readonly query: string, param?: QueryBinder, options?: QueryOptions) {\r\n    if (query.trim().length === 0) {\r\n      throw new Error(\"expecting non-empty ecsql statement\");\r\n    }\r\n    if (param) {\r\n      this._param = param.serialize();\r\n    }\r\n    this.reset(options);\r\n  }\r\n\r\n  private static replaceBase64WithUint8Array(row: any) {\r\n    for (const key of Object.keys(row)) {\r\n      const val = row[key];\r\n      if (typeof val === \"string\") {\r\n        if (Base64EncodedString.hasPrefix(val)) {\r\n          row[key] = Base64EncodedString.toUint8Array(val);\r\n        }\r\n      } else if (typeof val === \"object\" && val !== null) {\r\n        this.replaceBase64WithUint8Array(val);\r\n      }\r\n    }\r\n  }\r\n\r\n  public setParams(param: QueryBinder) {\r\n    if (this._lockArgs) {\r\n      throw new Error(\"call resetBindings() before setting or changing parameters\");\r\n    }\r\n    this._param = param.serialize();\r\n  }\r\n\r\n  public reset(options?: QueryOptions) {\r\n    if (options) {\r\n      this._options = options;\r\n    }\r\n    this._props = new PropertyMetaDataMap([]);\r\n    this._localRows = [];\r\n    this._globalDone = false;\r\n    this._globalOffset = 0;\r\n    this._globalCount = -1;\r\n    if (typeof this._options.rowFormat === \"undefined\")\r\n      this._options.rowFormat = QueryRowFormat.UseECSqlPropertyIndexes;\r\n    if (this._options.limit) {\r\n      if (typeof this._options.limit.offset === \"number\" && this._options.limit.offset > 0)\r\n        this._globalOffset = this._options.limit.offset;\r\n      if (typeof this._options.limit.count === \"number\" && this._options.limit.count > 0)\r\n        this._globalCount = this._options.limit.count;\r\n    }\r\n    this._done = false;\r\n  }\r\n\r\n  /**\r\n   * Get the current row from the query result. The current row is the one most recently stepped-to\r\n   * (by step() or during iteration).\r\n   *\r\n   * Each value from the row can be accessed by index or by name.\r\n   *\r\n   * The format of the row is dictated by the [[QueryOptions.rowFormat]] specified in the `options` parameter of the\r\n   * constructed ECSqlReader object.\r\n   *\r\n   * @see\r\n   * - [[QueryRowFormat]]\r\n   * - [ECSQL Row Formats]($docs/learning/ECSQLRowFormat)\r\n   *\r\n   * @note The current row is be a [[QueryRowProxy]] object. To get the row as a basic JavaScript object, call\r\n   *       [[QueryRowProxy.toRow]] on it.\r\n   *\r\n   * @example\r\n   * ```ts\r\n   * const reader = iModel.createQueryReader(\"SELECT ECInstanceId FROM bis.Element\");\r\n   * while (await reader.step()) {\r\n   *   // Both lines below print the same value\r\n   *   console.log(reader.current[0]);\r\n   *   console.log(reader.current.ecinstanceid);\r\n   * }\r\n   * ```\r\n   *\r\n   * @return The current row as a [[QueryRowProxy]].\r\n   */\r\n  public get current(): QueryRowProxy {\r\n    return this._rowProxy as any;\r\n  }\r\n\r\n  /**\r\n   * Clear all bindings.\r\n   */\r\n  public resetBindings() {\r\n    this._param = new QueryBinder().serialize();\r\n    this._lockArgs = false;\r\n  }\r\n\r\n  /**\r\n   * Returns if there are more rows available.\r\n   *\r\n   * @returns `true` if all rows have been stepped through already.<br/>\r\n   *          `false` if there are any yet unaccessed rows.\r\n   */\r\n  public get done(): boolean {\r\n    return this._done;\r\n  }\r\n\r\n  /**\r\n   *\r\n   */\r\n  public getRowInternal(): any[] {\r\n    if (this._localRows.length <= this._localOffset)\r\n      throw new Error(\"no current row\");\r\n    return this._localRows[this._localOffset] as any[];\r\n  }\r\n\r\n  /**\r\n   * Get performance-related statistics for the current query.\r\n   */\r\n  public get stats(): QueryStats {\r\n    return this._stats;\r\n  }\r\n\r\n  /**\r\n   *\r\n   */\r\n  private async readRows(): Promise<any[]> {\r\n    if (this._globalDone) {\r\n      return [];\r\n    }\r\n    this._lockArgs = true;\r\n    this._globalOffset += this._localRows.length;\r\n    this._globalCount -= this._localRows.length;\r\n    if (this._globalCount === 0) {\r\n      return [];\r\n    }\r\n    const valueFormat = this._options.rowFormat === QueryRowFormat.UseJsPropertyNames ? DbValueFormat.JsNames : DbValueFormat.ECSqlNames;\r\n    const request: DbQueryRequest = {\r\n      ... this._options,\r\n      kind: DbRequestKind.ECSql,\r\n      valueFormat,\r\n      query: this.query,\r\n      args: this._param,\r\n    };\r\n    request.includeMetaData = this._props.length > 0 ? false : true;\r\n    request.limit = { offset: this._globalOffset, count: this._globalCount < 1 ? -1 : this._globalCount };\r\n    const resp = await this.runWithRetry(request);\r\n    this._globalDone = resp.status === DbResponseStatus.Done;\r\n    if (this._props.length === 0 && resp.meta.length > 0) {\r\n      this._props = new PropertyMetaDataMap(resp.meta);\r\n    }\r\n    for (const row of resp.data) {\r\n      ECSqlReader.replaceBase64WithUint8Array(row);\r\n    }\r\n    return resp.data;\r\n  }\r\n\r\n  /**\r\n   * @internal\r\n   */\r\n  protected async runWithRetry(request: DbQueryRequest) {\r\n    const needRetry = (rs: DbQueryResponse) => (rs.status === DbResponseStatus.Partial || rs.status === DbResponseStatus.QueueFull || rs.status === DbResponseStatus.Timeout) && (rs.data === undefined || rs.data.length === 0);\r\n    const updateStats = (rs: DbQueryResponse) => {\r\n      this._stats.backendCpuTime += rs.stats.cpuTime;\r\n      this._stats.backendTotalTime += rs.stats.totalTime;\r\n      this._stats.backendMemUsed += rs.stats.memUsed;\r\n      this._stats.backendRowsReturned += (rs.data === undefined) ? 0 : rs.data.length;\r\n    };\r\n    const execQuery = async (req: DbQueryRequest) => {\r\n      const startTime = Date.now();\r\n      const rs = await this._executor.execute(req);\r\n      this.stats.totalTime += (Date.now() - startTime);\r\n      return rs;\r\n    };\r\n    let retry = ECSqlReader._maxRetryCount;\r\n    let resp = await execQuery(request);\r\n    DbQueryError.throwIfError(resp, request);\r\n    while (--retry > 0 && needRetry(resp)) {\r\n      resp = await execQuery(request);\r\n      this._stats.retryCount += 1;\r\n      if (needRetry(resp)) {\r\n        updateStats(resp);\r\n      }\r\n    }\r\n    if (retry === 0 && needRetry(resp)) {\r\n      throw new Error(\"query too long to execute or server is too busy\");\r\n    }\r\n    updateStats(resp);\r\n    return resp;\r\n  }\r\n\r\n  /**\r\n   *\r\n   */\r\n  public formatCurrentRow(onlyReturnObject: boolean = false): any[] | object {\r\n    if (!onlyReturnObject && this._options.rowFormat === QueryRowFormat.UseECSqlPropertyIndexes) {\r\n      return this.getRowInternal();\r\n    }\r\n    const formattedRow = {};\r\n    for (const prop of this._props) {\r\n      const propName = this._options.rowFormat === QueryRowFormat.UseJsPropertyNames ? prop.jsonName : prop.name;\r\n      const val = this.getRowInternal()[prop.index];\r\n      if (typeof val !== \"undefined\" && val !== null) {\r\n        Object.defineProperty(formattedRow, propName, {\r\n          value: val,\r\n          enumerable: true,\r\n        });\r\n      }\r\n    }\r\n    return formattedRow;\r\n  }\r\n\r\n  /**\r\n   * Get the metadata for each column in the query result.\r\n   *\r\n   * @returns An array of [[QueryPropertyMetaData]].\r\n   */\r\n  public async getMetaData(): Promise<QueryPropertyMetaData[]> {\r\n    if (this._props.length === 0) {\r\n      await this.fetchRows();\r\n    }\r\n    return this._props.properties;\r\n  }\r\n\r\n  /**\r\n   *\r\n   */\r\n  private async fetchRows() {\r\n    this._localOffset = -1;\r\n    this._localRows = await this.readRows();\r\n    if (this._localRows.length === 0) {\r\n      this._done = true;\r\n    }\r\n  }\r\n\r\n  /**\r\n   * Step to the next row of the query result.\r\n   *\r\n   * @returns `true` if a row can be read from `current`.<br/>\r\n   *          `false` if there are no more rows; i.e., all rows have been stepped through already.\r\n   */\r\n  public async step(): Promise<boolean> {\r\n    if (this._done) {\r\n      return false;\r\n    }\r\n    const cachedRows = this._localRows.length;\r\n    if (this._localOffset < cachedRows - 1) {\r\n      ++this._localOffset;\r\n    } else {\r\n      await this.fetchRows();\r\n      this._localOffset = 0;\r\n      return !this._done;\r\n    }\r\n    return true;\r\n  }\r\n\r\n  /**\r\n   * Get all remaining rows from the query result.\r\n   *\r\n   * @returns An array of all remaining rows from the query result.\r\n   */\r\n  public async toArray(): Promise<any[]> {\r\n    const rows = [];\r\n    while (await this.step()) {\r\n      rows.push(this.formatCurrentRow());\r\n    }\r\n    return rows;\r\n  }\r\n\r\n  /**\r\n   * Accessor for using ECSqlReader as an asynchronous iterator.\r\n   *\r\n   * @returns An asynchronous iterator over the rows returned by the executed ECSQL query.\r\n   */\r\n  public [Symbol.asyncIterator](): AsyncIterableIterator<QueryRowProxy> {\r\n    return this;\r\n  }\r\n\r\n  /**\r\n   * Calls step when called as an iterator.\r\n   *\r\n   * Returns the row alongside a `done` boolean to indicate if there are any more rows for an iterator to step to.\r\n   *\r\n   * @returns An object with the keys: `value` which contains the row and `done` which contains a boolean.\r\n   */\r\n  public async next(): Promise<IteratorResult<QueryRowProxy, any>> {\r\n    if (await this.step()) {\r\n      return {\r\n        done: false,\r\n        value: this.current,\r\n      };\r\n    } else {\r\n      return {\r\n        done: true,\r\n        value: this.current,\r\n      };\r\n    }\r\n  }\r\n}\r\n\r\n"]}

package/lib/esm/ElementProps.d.ts

@@ -70,7 +70,7 @@ export interface GeometricElementProps extends ElementProps {
     /** The geometry stream properties */
     geom?: GeometryStreamProps;
     /** How to build the element's GeometryStream. This is used for insert and update only. It is not a persistent property. It will be undefined in the properties returned by functions that read a persistent element. It may be specified as an alternative to `geom` when inserting or updating an element.
-     * @alpha
+     * @beta
      */
     elementGeometryBuilderParams?: ElementGeometryBuilderParams;
     /** The placement properties */
@@ -178,7 +178,7 @@ export interface GeometricElement2dProps extends GeometricElementProps {
 export interface GeometryPartProps extends ElementProps {
     geom?: GeometryStreamProps;
     /** How to build the part's GeometryStream. This is used for insert and update only. It is not a persistent property. It will be undefined in the properties returned by functions that read a persistent element. It may be specified as an alternative to `geom` when inserting or updating an element.
-     * @alpha
+     * @beta
      */
     elementGeometryBuilderParams?: ElementGeometryBuilderParamsForPart;
     bbox?: LowAndHighXYZ;