@itwin/core-common 5.7.2 → 5.8.0-dev.10

package/lib/esm/ECSqlReader.js

@@ -5,53 +5,8 @@
 /** @packageDocumentation
  * @module iModels
  */
-import { Base64EncodedString } from "./Base64EncodedString";
 import { DbQueryError, DbRequestKind, DbResponseStatus, DbValueFormat, QueryBinder, QueryOptionsBuilder, QueryRowFormat, } from "./ConcurrentQuery";
-/** @public */
-export class PropertyMetaDataMap {
-    properties;
-    _byPropName = new Map();
-    _byJsonName = new Map();
-    _byNoCase = new Map();
-    constructor(properties) {
-        this.properties = properties;
-        for (const property of this.properties) {
-            property.extendType = property.extendedType !== undefined ? property.extendedType : ""; // eslint-disable-line @typescript-eslint/no-deprecated
-            property.extendedType = property.extendedType === "" ? undefined : property.extendedType;
-            this._byPropName.set(property.name, property.index);
-            this._byJsonName.set(property.jsonName, property.index);
-            this._byNoCase.set(property.name.toLowerCase(), property.index);
-            this._byNoCase.set(property.jsonName.toLowerCase(), property.index);
-        }
-    }
-    get length() {
-        return this.properties.length;
-    }
-    [Symbol.iterator]() {
-        return this.properties[Symbol.iterator]();
-    }
-    findByName(name) {
-        const index = this._byPropName.get(name);
-        if (typeof index === "number") {
-            return this.properties[index];
-        }
-        return undefined;
-    }
-    findByJsonName(name) {
-        const index = this._byJsonName.get(name);
-        if (typeof index === "number") {
-            return this.properties[index];
-        }
-        return undefined;
-    }
-    findByNoCase(name) {
-        const index = this._byNoCase.get(name.toLowerCase());
-        if (typeof index === "number") {
-            return this.properties[index];
-        }
-        return undefined;
-    }
-}
+import { ECSqlReaderBase, PropertyMetaDataMap } from "./ECSqlReaderBase";
 /**
  * Execute ECSQL statements and read the results.
  *
@@ -74,7 +29,7 @@ export class PropertyMetaDataMap {
  *       JavaScript object, call [[QueryRowProxy.toRow]] on it.
  * @public
  */
-export class ECSqlReader {
+export class ECSqlReader extends ECSqlReaderBase {
     _executor;
     query;
     static _maxRetryCount = 10;
@@ -82,51 +37,16 @@ export class ECSqlReader {
     _localOffset = 0;
     _globalOffset = -1;
     _globalCount = -1;
-    _done = false;
     _globalDone = false;
-    _props = new PropertyMetaDataMap([]);
     _param = new QueryBinder().serialize();
     _lockArgs = false;
     _stats = { backendCpuTime: 0, backendTotalTime: 0, backendMemUsed: 0, backendRowsReturned: 0, totalTime: 0, retryCount: 0, prepareTime: 0 };
     _options = new QueryOptionsBuilder().getOptions();
-    _rowProxy = new Proxy(this, {
-        get: (target, key) => {
-            if (typeof key === "string") {
-                const idx = Number.parseInt(key, 10);
-                if (!Number.isNaN(idx)) {
-                    return target.getRowInternal()[idx];
-                }
-                const prop = target._props.findByNoCase(key);
-                if (prop) {
-                    return target.getRowInternal()[prop.index];
-                }
-                if (key === "getMetaData") {
-                    return () => target._props.properties;
-                }
-                if (key === "toRow") {
-                    return () => target.formatCurrentRow(true);
-                }
-                if (key === "toArray") {
-                    return () => this.getRowInternal();
-                }
-            }
-            return undefined;
-        },
-        has: (target, p) => {
-            return !target._props.findByNoCase(p);
-        },
-        ownKeys: (target) => {
-            const keys = [];
-            for (const prop of target._props) {
-                keys.push(prop.name);
-            }
-            return keys;
-        },
-    });
     /**
      * @internal
      */
     constructor(_executor, query, param, options) {
+        super(options?.rowFormat);
         this._executor = _executor;
         this.query = query;
         if (query.trim().length === 0) {
@@ -135,27 +55,21 @@ export class ECSqlReader {
         if (param) {
             this._param = param.serialize();
         }
+        // eslint-disable-next-line @typescript-eslint/no-deprecated
         this.reset(options);
     }
-    static replaceBase64WithUint8Array(row) {
-        for (const key of Object.keys(row)) {
-            const val = row[key];
-            if (typeof val === "string") {
-                if (Base64EncodedString.hasPrefix(val)) {
-                    row[key] = Base64EncodedString.toUint8Array(val);
-                }
-            }
-            else if (typeof val === "object" && val !== null) {
-                this.replaceBase64WithUint8Array(val);
-            }
-        }
-    }
+    /**
+     * @deprecated in 5.6. Will not be removed until 2027-02-18. Should not be used. Will be made private in a future release.
+     */
     setParams(param) {
         if (this._lockArgs) {
             throw new Error("call resetBindings() before setting or changing parameters");
         }
         this._param = param.serialize();
     }
+    /**
+     * @deprecated in 5.6. Will not be removed until 2027-02-18. Should not be used. Will be made private in a future release.
+     */
     reset(options) {
         if (options) {
             this._options = options;
@@ -167,6 +81,7 @@ export class ECSqlReader {
         this._globalCount = -1;
         if (typeof this._options.rowFormat === "undefined")
             this._options.rowFormat = QueryRowFormat.UseECSqlPropertyIndexes;
+        this._rowFormat = this._options.rowFormat;
         if (this._options.limit) {
             if (typeof this._options.limit.offset === "number" && this._options.limit.offset > 0)
                 this._globalOffset = this._options.limit.offset;
@@ -175,53 +90,14 @@ export class ECSqlReader {
         }
         this._done = false;
     }
-    /**
-     * 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.
+     * @deprecated in 5.6. Will not be removed until 2027-02-18. Should not be used. Will be made private in a future release.
      */
     resetBindings() {
         this._param = new QueryBinder().serialize();
         this._lockArgs = false;
     }
-    /**
-     * 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;
-    }
     /**
      * @internal
      */
@@ -303,26 +179,6 @@ export class ECSqlReader {
         updateStats(resp);
         return resp;
     }
-    /**
-     * @internal
-     */
-    formatCurrentRow(onlyReturnObject = false) {
-        if (!onlyReturnObject && this._options.rowFormat === QueryRowFormat.UseECSqlPropertyIndexes) {
-            return this.getRowInternal();
-        }
-        const formattedRow = {};
-        for (const prop of this._props) {
-            const propName = this._options.rowFormat === QueryRowFormat.UseJsPropertyNames ? prop.jsonName : prop.name;
-            const val = this.getRowInternal()[prop.index];
-            if (typeof val !== "undefined" && val !== null) {
-                Object.defineProperty(formattedRow, propName, {
-                    value: val,
-                    enumerable: true,
-                });
-            }
-        }
-        return formattedRow;
-    }
     /**
      * Get the metadata for each column in the query result.
      *

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,cAAc;AACd,MAAM,OAAO,mBAAmB;IAKK;IAJ3B,WAAW,GAAG,IAAI,GAAG,EAAkB,CAAC;IACxC,WAAW,GAAG,IAAI,GAAG,EAAkB,CAAC;IACxC,SAAS,GAAG,IAAI,GAAG,EAAkB,CAAC;IAE9C,YAAmC,UAAmC;QAAnC,eAAU,GAAV,UAAU,CAAyB;QACpE,KAAK,MAAM,QAAQ,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;YACvC,QAAQ,CAAC,UAAU,GAAG,QAAQ,CAAC,YAAY,KAAK,SAAS,CAAC,CAAC,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,CAAC,CAAG,uDAAuD;YACjJ,QAAQ,CAAC,YAAY,GAAG,QAAQ,CAAC,YAAY,KAAK,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,QAAQ,CAAC,YAAY,CAAC;YACzF,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;QACtE,CAAC;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,CAAC;YAC9B,OAAO,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;QAChC,CAAC;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,CAAC;YAC9B,OAAO,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;QAChC,CAAC;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,CAAC;YAC9B,OAAO,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;QAChC,CAAC;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;CACF;AAkFD;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,OAAO,WAAW;IAqDK;IAA+E;IApDlG,MAAM,CAAU,cAAc,GAAG,EAAE,CAAC;IAEpC,UAAU,GAAU,EAAE,CAAC;IACvB,YAAY,GAAW,CAAC,CAAC;IACzB,aAAa,GAAW,CAAC,CAAC,CAAC;IAC3B,YAAY,GAAW,CAAC,CAAC,CAAC;IAC1B,KAAK,GAAY,KAAK,CAAC;IACvB,WAAW,GAAY,KAAK,CAAC;IAC7B,MAAM,GAAG,IAAI,mBAAmB,CAAC,EAAE,CAAC,CAAC;IACrC,MAAM,GAAG,IAAI,WAAW,EAAE,CAAC,SAAS,EAAE,CAAC;IACvC,SAAS,GAAY,KAAK,CAAC;IAC3B,MAAM,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,WAAW,EAAE,CAAC,EAAE,CAAC;IAC5I,QAAQ,GAAiB,IAAI,mBAAmB,EAAE,CAAC,UAAU,EAAE,CAAC;IAEhE,SAAS,GAAG,IAAI,KAAK,CAAc,IAAI,EAAE;QAC/C,GAAG,EAAE,CAAC,MAAmB,EAAE,GAAoB,EAAE,EAAE;YACjD,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE,CAAC;gBAC5B,MAAM,GAAG,GAAG,MAAM,CAAC,QAAQ,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;gBACrC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC;oBACvB,OAAO,MAAM,CAAC,cAAc,EAAE,CAAC,GAAG,CAAC,CAAC;gBACtC,CAAC;gBACD,MAAM,IAAI,GAAG,MAAM,CAAC,MAAM,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC;gBAC7C,IAAI,IAAI,EAAE,CAAC;oBACT,OAAO,MAAM,CAAC,cAAc,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;gBAC7C,CAAC;gBACD,IAAI,GAAG,KAAK,aAAa,EAAE,CAAC;oBAC1B,OAAO,GAAG,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC;gBACxC,CAAC;gBACD,IAAI,GAAG,KAAK,OAAO,EAAE,CAAC;oBACpB,OAAO,GAAG,EAAE,CAAC,MAAM,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC;gBAC7C,CAAC;gBACD,IAAI,GAAG,KAAK,SAAS,EAAE,CAAC;oBACtB,OAAO,GAAG,EAAE,CAAC,IAAI,CAAC,cAAc,EAAE,CAAC;gBACrC,CAAC;YACH,CAAC;YACD,OAAO,SAAS,CAAC;QACnB,CAAC;QACD,GAAG,EAAE,CAAC,MAAmB,EAAE,CAAkB,EAAE,EAAE;YAC/C,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,YAAY,CAAC,CAAW,CAAC,CAAC;QAClD,CAAC;QACD,OAAO,EAAE,CAAC,MAAmB,EAAE,EAAE;YAC/B,MAAM,IAAI,GAAG,EAAE,CAAC;YAChB,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,MAAM,EAAE,CAAC;gBACjC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACvB,CAAC;YACD,OAAO,IAAI,CAAC;QACd,CAAC;KACF,CAAC,CAAC;IAEH;;OAEG;IACH,YAA2B,SAA6D,EAAkB,KAAa,EAAE,KAAmB,EAAE,OAAsB;QAAzI,cAAS,GAAT,SAAS,CAAoD;QAAkB,UAAK,GAAL,KAAK,CAAQ;QACrH,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC9B,MAAM,IAAI,KAAK,CAAC,qCAAqC,CAAC,CAAC;QACzD,CAAC;QACD,IAAI,KAAK,EAAE,CAAC;YACV,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC,SAAS,EAAE,CAAC;QAClC,CAAC;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,CAAC;YACnC,MAAM,GAAG,GAAG,GAAG,CAAC,GAAG,CAAC,CAAC;YACrB,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE,CAAC;gBAC5B,IAAI,mBAAmB,CAAC,SAAS,CAAC,GAAG,CAAC,EAAE,CAAC;oBACvC,GAAG,CAAC,GAAG,CAAC,GAAG,mBAAmB,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC;gBACnD,CAAC;YACH,CAAC;iBAAM,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,GAAG,KAAK,IAAI,EAAE,CAAC;gBACnD,IAAI,CAAC,2BAA2B,CAAC,GAAG,CAAC,CAAC;YACxC,CAAC;QACH,CAAC;IACH,CAAC;IAEM,SAAS,CAAC,KAAkB;QACjC,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;YACnB,MAAM,IAAI,KAAK,CAAC,4DAA4D,CAAC,CAAC;QAChF,CAAC;QACD,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC,SAAS,EAAE,CAAC;IAClC,CAAC;IAEM,KAAK,CAAC,OAAsB;QACjC,IAAI,OAAO,EAAE,CAAC;YACZ,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;QAC1B,CAAC;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,CAAC;YACxB,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;QAClD,CAAC;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,CAAC;YACrB,OAAO,EAAE,CAAC;QACZ,CAAC;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,CAAC;YAC5B,OAAO,EAAE,CAAC;QACZ,CAAC;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,CAAC;YACrD,IAAI,CAAC,MAAM,GAAG,IAAI,mBAAmB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACnD,CAAC;QACD,KAAK,MAAM,GAAG,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC;YAC5B,WAAW,CAAC,2BAA2B,CAAC,GAAG,CAAC,CAAC;QAC/C,CAAC;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,IAAI,EAAE,CAAC,MAAM,KAAK,gBAAgB,CAAC,YAAY,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,KAAK,SAAS,IAAI,EAAE,CAAC,IAAI,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC;QAC5Q,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,WAAW,IAAI,EAAE,CAAC,KAAK,CAAC,WAAW,CAAC;YAChD,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,CAAC;YACtC,IAAI,GAAG,MAAM,SAAS,CAAC,OAAO,CAAC,CAAC;YAChC,IAAI,CAAC,MAAM,CAAC,UAAU,IAAI,CAAC,CAAC;YAC5B,IAAI,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC;gBACpB,WAAW,CAAC,IAAI,CAAC,CAAC;YACpB,CAAC;QACH,CAAC;QACD,IAAI,KAAK,KAAK,CAAC,IAAI,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC;YACnC,MAAM,IAAI,KAAK,CAAC,iDAAiD,CAAC,CAAC;QACrE,CAAC;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,CAAC;YAC5F,OAAO,IAAI,CAAC,cAAc,EAAE,CAAC;QAC/B,CAAC;QACD,MAAM,YAAY,GAAG,EAAE,CAAC;QACxB,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YAC/B,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,CAAC;gBAC/C,MAAM,CAAC,cAAc,CAAC,YAAY,EAAE,QAAQ,EAAE;oBAC5C,KAAK,EAAE,GAAG;oBACV,UAAU,EAAE,IAAI;iBACjB,CAAC,CAAC;YACL,CAAC;QACH,CAAC;QACD,OAAO,YAAY,CAAC;IACtB,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,WAAW;QACtB,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC7B,MAAM,IAAI,CAAC,SAAS,EAAE,CAAC;QACzB,CAAC;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,CAAC;YACjC,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;QACpB,CAAC;IACH,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,IAAI;QACf,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;YACf,OAAO,KAAK,CAAC;QACf,CAAC;QACD,MAAM,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC;QAC1C,IAAI,IAAI,CAAC,YAAY,GAAG,UAAU,GAAG,CAAC,EAAE,CAAC;YACvC,EAAE,IAAI,CAAC,YAAY,CAAC;QACtB,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,CAAC,SAAS,EAAE,CAAC;YACvB,IAAI,CAAC,YAAY,GAAG,CAAC,CAAC;YACtB,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC;QACrB,CAAC;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,CAAC;YACzB,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,gBAAgB,EAAE,CAAC,CAAC;QACrC,CAAC;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,CAAC;YACtB,OAAO;gBACL,IAAI,EAAE,KAAK;gBACX,KAAK,EAAE,IAAI,CAAC,OAAO;aACpB,CAAC;QACJ,CAAC;aAAM,CAAC;YACN,OAAO;gBACL,IAAI,EAAE,IAAI;gBACV,KAAK,EAAE,IAAI,CAAC,OAAO;aACpB,CAAC;QACJ,CAAC;IACH,CAAC","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/** @public */\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      property.extendType = property.extendedType !== undefined ? property.extendedType : \"\";   // eslint-disable-line @typescript-eslint/no-deprecated\r\n      property.extendedType = property.extendedType === \"\" ? undefined : property.extendedType;\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 * @public\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 * @public\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 * @public\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  /** Total time in millisecond to prepare ECSQL or grabing it from cache and binding parameters */\r\n  prepareTime: 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 * @public\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, prepareTime: 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   * @internal\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.status === DbResponseStatus.ShuttingDown) && (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.prepareTime += rs.stats.prepareTime;\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   * @internal\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"]}
+{"version":3,"file":"ECSqlReader.js","sourceRoot":"","sources":["../../src/ECSqlReader.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AACH,OAAO,EACL,YAAY,EAAsD,aAAa,EAAE,gBAAgB,EAAE,aAAa,EAAE,WAAW,EAAgB,mBAAmB,EACzI,cAAc,GACtC,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAAE,eAAe,EAAE,mBAAmB,EAAiB,MAAM,mBAAmB,CAAC;AAuBxF;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,OAAO,WAAY,SAAQ,eAAe;IAgBnB;IAA+E;IAflG,MAAM,CAAU,cAAc,GAAG,EAAE,CAAC;IAEpC,UAAU,GAAU,EAAE,CAAC;IACvB,YAAY,GAAW,CAAC,CAAC;IACzB,aAAa,GAAW,CAAC,CAAC,CAAC;IAC3B,YAAY,GAAW,CAAC,CAAC,CAAC;IAC1B,WAAW,GAAY,KAAK,CAAC;IAC7B,MAAM,GAAG,IAAI,WAAW,EAAE,CAAC,SAAS,EAAE,CAAC;IACvC,SAAS,GAAY,KAAK,CAAC;IAC3B,MAAM,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,WAAW,EAAE,CAAC,EAAE,CAAC;IAC5I,QAAQ,GAAiB,IAAI,mBAAmB,EAAE,CAAC,UAAU,EAAE,CAAC;IAExE;;OAEG;IACH,YAA2B,SAA6D,EAAkB,KAAa,EAAE,KAAmB,EAAE,OAAsB;QAClK,KAAK,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;QADD,cAAS,GAAT,SAAS,CAAoD;QAAkB,UAAK,GAAL,KAAK,CAAQ;QAErH,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC9B,MAAM,IAAI,KAAK,CAAC,qCAAqC,CAAC,CAAC;QACzD,CAAC;QACD,IAAI,KAAK,EAAE,CAAC;YACV,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC,SAAS,EAAE,CAAC;QAClC,CAAC;QACD,4DAA4D;QAC5D,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IACtB,CAAC;IAED;;OAEG;IACI,SAAS,CAAC,KAAkB;QACjC,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;YACnB,MAAM,IAAI,KAAK,CAAC,4DAA4D,CAAC,CAAC;QAChF,CAAC;QACD,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC,SAAS,EAAE,CAAC;IAClC,CAAC;IACD;;OAEG;IACI,KAAK,CAAC,OAAsB;QACjC,IAAI,OAAO,EAAE,CAAC;YACZ,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;QAC1B,CAAC;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,CAAC,UAAU,GAAG,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC;QAC1C,IAAI,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC;YACxB,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;QAClD,CAAC;QACD,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;IACrB,CAAC;IAED;;;OAGG;IACI,aAAa;QAClB,IAAI,CAAC,MAAM,GAAG,IAAI,WAAW,EAAE,CAAC,SAAS,EAAE,CAAC;QAC5C,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC;IACzB,CAAC;IAED;;OAEG;IACa,cAAc;QAC5B,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,CAAC;YACrB,OAAO,EAAE,CAAC;QACZ,CAAC;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,CAAC;YAC5B,OAAO,EAAE,CAAC;QACZ,CAAC;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,CAAC;YACrD,IAAI,CAAC,MAAM,GAAG,IAAI,mBAAmB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACnD,CAAC;QACD,KAAK,MAAM,GAAG,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC;YAC5B,WAAW,CAAC,2BAA2B,CAAC,GAAG,CAAC,CAAC;QAC/C,CAAC;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,IAAI,EAAE,CAAC,MAAM,KAAK,gBAAgB,CAAC,YAAY,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,KAAK,SAAS,IAAI,EAAE,CAAC,IAAI,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC;QAC5Q,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,WAAW,IAAI,EAAE,CAAC,KAAK,CAAC,WAAW,CAAC;YAChD,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,CAAC;YACtC,IAAI,GAAG,MAAM,SAAS,CAAC,OAAO,CAAC,CAAC;YAChC,IAAI,CAAC,MAAM,CAAC,UAAU,IAAI,CAAC,CAAC;YAC5B,IAAI,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC;gBACpB,WAAW,CAAC,IAAI,CAAC,CAAC;YACpB,CAAC;QACH,CAAC;QACD,IAAI,KAAK,KAAK,CAAC,IAAI,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC;YACnC,MAAM,IAAI,KAAK,CAAC,iDAAiD,CAAC,CAAC;QACrE,CAAC;QACD,WAAW,CAAC,IAAI,CAAC,CAAC;QAClB,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,WAAW;QACtB,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC7B,MAAM,IAAI,CAAC,SAAS,EAAE,CAAC;QACzB,CAAC;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,CAAC;YACjC,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;QACpB,CAAC;IACH,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,IAAI;QACf,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;YACf,OAAO,KAAK,CAAC;QACf,CAAC;QACD,MAAM,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC;QAC1C,IAAI,IAAI,CAAC,YAAY,GAAG,UAAU,GAAG,CAAC,EAAE,CAAC;YACvC,EAAE,IAAI,CAAC,YAAY,CAAC;QACtB,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,CAAC,SAAS,EAAE,CAAC;YACvB,IAAI,CAAC,YAAY,GAAG,CAAC,CAAC;YACtB,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC;QACrB,CAAC;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,CAAC;YACzB,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,gBAAgB,EAAE,CAAC,CAAC;QACrC,CAAC;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,CAAC;YACtB,OAAO;gBACL,IAAI,EAAE,KAAK;gBACX,KAAK,EAAE,IAAI,CAAC,OAAO;aACpB,CAAC;QACJ,CAAC;aAAM,CAAC;YACN,OAAO;gBACL,IAAI,EAAE,IAAI;gBACV,KAAK,EAAE,IAAI,CAAC,OAAO;aACpB,CAAC;QACJ,CAAC;IACH,CAAC","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 {\r\n  DbQueryError, DbQueryRequest, DbQueryResponse, DbRequestExecutor, DbRequestKind, DbResponseStatus, DbValueFormat, QueryBinder, QueryOptions, QueryOptionsBuilder,\r\n  QueryPropertyMetaData, QueryRowFormat,\r\n} from \"./ConcurrentQuery\";\r\nimport { ECSqlReaderBase, PropertyMetaDataMap, QueryRowProxy } from \"./ECSqlReaderBase\";\r\n\r\n/**\r\n * Performance-related statistics for [[ECSqlReader]].\r\n * @public\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  /** Total time in millisecond to prepare ECSQL or grabing it from cache and binding parameters */\r\n  prepareTime: 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 * @public\r\n */\r\nexport class ECSqlReader extends ECSqlReaderBase 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 _globalDone: boolean = false;\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, prepareTime: 0 };\r\n  private _options: QueryOptions = new QueryOptionsBuilder().getOptions();\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    super(options?.rowFormat);\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    // eslint-disable-next-line @typescript-eslint/no-deprecated\r\n    this.reset(options);\r\n  }\r\n\r\n  /**\r\n   * @deprecated in 5.6. Will not be removed until 2027-02-18. Should not be used. Will be made private in a future release.\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   * @deprecated in 5.6. Will not be removed until 2027-02-18. Should not be used. Will be made private in a future release.\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    this._rowFormat = this._options.rowFormat;\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   * Clear all bindings.\r\n   * @deprecated in 5.6. Will not be removed until 2027-02-18. Should not be used. Will be made private in a future release.\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   * @internal\r\n   */\r\n  public override 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.status === DbResponseStatus.ShuttingDown) && (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.prepareTime += rs.stats.prepareTime;\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   * 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/ECSqlReaderBase.d.ts

@@ -0,0 +1,128 @@
+import { QueryPropertyMetaData, QueryRowFormat } from "./ConcurrentQuery";
+/** @public */
+export declare class PropertyMetaDataMap implements Iterable<QueryPropertyMetaData> {
+    readonly properties: QueryPropertyMetaData[];
+    private _byPropName;
+    private _byJsonName;
+    private _byNoCase;
+    constructor(properties: QueryPropertyMetaData[]);
+    get length(): number;
+    [Symbol.iterator](): Iterator<QueryPropertyMetaData, any, undefined>;
+    findByName(name: string): QueryPropertyMetaData | undefined;
+    findByJsonName(name: string): QueryPropertyMetaData | undefined;
+    findByNoCase(name: string): QueryPropertyMetaData | undefined;
+}
+/**
+ * The format for rows returned by [[ECSqlReader]].
+ * @public
+ */
+export type QueryValueType = any;
+/**
+ * Methods and ways of accessing values from rows returned by [[ECSqlReader]].
+ * @public
+ */
+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;
+}
+/**
+ * Abstract base class providing shared row-proxy access, row formatting, and
+ * Base64-to-Uint8Array conversion logic for both the asynchronous [[ECSqlReader]]
+ * and the synchronous ECSqlSyncReader.
+ *
+ * Subclasses must implement [[getRowInternal]] to supply the current row data.
+ * @public
+ */
+export declare abstract class ECSqlReaderBase {
+    /** @internal */
+    protected _done: boolean;
+    /** @internal */
+    protected _props: PropertyMetaDataMap;
+    /** @internal */
+    protected _rowFormat: QueryRowFormat;
+    private _rowProxy;
+    /**
+     * @internal
+     */
+    protected constructor(rowFormat?: QueryRowFormat);
+    /**
+     * 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.
+     *
+     * @see
+     * - [[QueryRowFormat]]
+     * - [ECSQL Row Formats]($docs/learning/ECSQLRowFormat)
+     *
+     * @note The current row is a [[QueryRowProxy]] object. To get the row as a basic JavaScript object, call
+     *       [[QueryRowProxy.toRow]] on it.
+     *
+     * @return The current row as a [[QueryRowProxy]].
+     */
+    get current(): QueryRowProxy;
+    /**
+     * 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;
+    /**
+     * Returns the raw current row data array. Subclasses implement this to return
+     * from their specific storage mechanism.
+     * @internal
+     */
+    protected abstract getRowInternal(): any[];
+    /**
+     * Converts Base64-encoded strings in a row object into Uint8Arrays in-place.
+     * @internal
+     */
+    protected static replaceBase64WithUint8Array(row: any): void;
+    /**
+     * Format the current row as a JavaScript object or array depending on the row format.
+     * @internal
+     */
+    protected formatCurrentRow(onlyReturnObject?: boolean): any[] | object;
+}
+//# sourceMappingURL=ECSqlReaderBase.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ECSqlReaderBase.d.ts","sourceRoot":"","sources":["../../src/ECSqlReaderBase.ts"],"names":[],"mappings":"AAQA,OAAO,EAAE,qBAAqB,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AAE1E,cAAc;AACd,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;IAWtE,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;;;;;;;GAOG;AACH,8BAAsB,eAAe;IACnC,gBAAgB;IAChB,SAAS,CAAC,KAAK,EAAE,OAAO,CAAS;IACjC,gBAAgB;IAChB,SAAS,CAAC,MAAM,sBAA+B;IAC/C,gBAAgB;IAChB,SAAS,CAAC,UAAU,EAAE,cAAc,CAAC;IAErC,OAAO,CAAC,SAAS,CAiCd;IAEH;;OAEG;IACH,SAAS,aAAa,SAAS,CAAC,EAAE,cAAc;IAIhD;;;;;;;;;;;;;;OAcG;IACH,IAAW,OAAO,IAAI,aAAa,CAElC;IAED;;;;;OAKG;IACH,IAAW,IAAI,IAAI,OAAO,CAEzB;IAED;;;;OAIG;IACH,SAAS,CAAC,QAAQ,CAAC,cAAc,IAAI,GAAG,EAAE;IAE1C;;;OAGG;IACH,SAAS,CAAC,MAAM,CAAC,2BAA2B,CAAC,GAAG,EAAE,GAAG,GAAG,IAAI;IAa5D;;;OAGG;IACH,SAAS,CAAC,gBAAgB,CAAC,gBAAgB,GAAE,OAAe,GAAG,GAAG,EAAE,GAAG,MAAM;CAiB9E"}

package/lib/esm/ECSqlReaderBase.js

@@ -0,0 +1,176 @@
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module iModels
+ */
+import { Base64EncodedString } from "./Base64EncodedString";
+import { QueryRowFormat } from "./ConcurrentQuery";
+/** @public */
+export class PropertyMetaDataMap {
+    properties;
+    _byPropName = new Map();
+    _byJsonName = new Map();
+    _byNoCase = new Map();
+    constructor(properties) {
+        this.properties = properties;
+        for (const property of this.properties) {
+            property.extendType = property.extendedType !== undefined ? property.extendedType : ""; // eslint-disable-line @typescript-eslint/no-deprecated
+            property.extendedType = property.extendedType === "" ? undefined : property.extendedType;
+            this._byPropName.set(property.name, property.index);
+            this._byJsonName.set(property.jsonName, property.index);
+            this._byNoCase.set(property.name.toLowerCase(), property.index);
+            this._byNoCase.set(property.jsonName.toLowerCase(), property.index);
+        }
+    }
+    get length() {
+        return this.properties.length;
+    }
+    [Symbol.iterator]() {
+        return this.properties[Symbol.iterator]();
+    }
+    findByName(name) {
+        const index = this._byPropName.get(name);
+        if (typeof index === "number") {
+            return this.properties[index];
+        }
+        return undefined;
+    }
+    findByJsonName(name) {
+        const index = this._byJsonName.get(name);
+        if (typeof index === "number") {
+            return this.properties[index];
+        }
+        return undefined;
+    }
+    findByNoCase(name) {
+        const index = this._byNoCase.get(name.toLowerCase());
+        if (typeof index === "number") {
+            return this.properties[index];
+        }
+        return undefined;
+    }
+}
+/**
+ * Abstract base class providing shared row-proxy access, row formatting, and
+ * Base64-to-Uint8Array conversion logic for both the asynchronous [[ECSqlReader]]
+ * and the synchronous ECSqlSyncReader.
+ *
+ * Subclasses must implement [[getRowInternal]] to supply the current row data.
+ * @public
+ */
+export class ECSqlReaderBase {
+    /** @internal */
+    _done = false;
+    /** @internal */
+    _props = new PropertyMetaDataMap([]);
+    /** @internal */
+    _rowFormat;
+    _rowProxy = new Proxy(this, {
+        get: (target, key) => {
+            if (typeof key === "string") {
+                const idx = Number.parseInt(key, 10);
+                if (!Number.isNaN(idx)) {
+                    return target.getRowInternal()[idx];
+                }
+                const prop = target._props.findByNoCase(key);
+                if (prop) {
+                    return target.getRowInternal()[prop.index];
+                }
+                if (key === "getMetaData") {
+                    return () => target._props.properties;
+                }
+                if (key === "toRow") {
+                    return () => target.formatCurrentRow(true);
+                }
+                if (key === "toArray") {
+                    return () => target.getRowInternal();
+                }
+            }
+            return undefined;
+        },
+        has: (target, p) => {
+            return !target._props.findByNoCase(p);
+        },
+        ownKeys: (target) => {
+            const keys = [];
+            for (const prop of target._props) {
+                keys.push(prop.name);
+            }
+            return keys;
+        },
+    });
+    /**
+     * @internal
+     */
+    constructor(rowFormat) {
+        this._rowFormat = rowFormat ?? QueryRowFormat.UseECSqlPropertyIndexes;
+    }
+    /**
+     * 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.
+     *
+     * @see
+     * - [[QueryRowFormat]]
+     * - [ECSQL Row Formats]($docs/learning/ECSQLRowFormat)
+     *
+     * @note The current row is a [[QueryRowProxy]] object. To get the row as a basic JavaScript object, call
+     *       [[QueryRowProxy.toRow]] on it.
+     *
+     * @return The current row as a [[QueryRowProxy]].
+     */
+    get current() {
+        return this._rowProxy;
+    }
+    /**
+     * 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;
+    }
+    /**
+     * Converts Base64-encoded strings in a row object into Uint8Arrays in-place.
+     * @internal
+     */
+    static replaceBase64WithUint8Array(row) {
+        for (const key of Object.keys(row)) {
+            const val = row[key];
+            if (typeof val === "string") {
+                if (Base64EncodedString.hasPrefix(val)) {
+                    row[key] = Base64EncodedString.toUint8Array(val);
+                }
+            }
+            else if (typeof val === "object" && val !== null) {
+                this.replaceBase64WithUint8Array(val);
+            }
+        }
+    }
+    /**
+     * Format the current row as a JavaScript object or array depending on the row format.
+     * @internal
+     */
+    formatCurrentRow(onlyReturnObject = false) {
+        if (!onlyReturnObject && this._rowFormat === QueryRowFormat.UseECSqlPropertyIndexes) {
+            return this.getRowInternal();
+        }
+        const formattedRow = {};
+        for (const prop of this._props) {
+            const propName = this._rowFormat === QueryRowFormat.UseJsPropertyNames ? prop.jsonName : prop.name;
+            const val = this.getRowInternal()[prop.index];
+            if (typeof val !== "undefined" && val !== null) {
+                Object.defineProperty(formattedRow, propName, {
+                    value: val,
+                    enumerable: true,
+                });
+            }
+        }
+        return formattedRow;
+    }
+}
+//# sourceMappingURL=ECSqlReaderBase.js.map