@itwin/core-common 4.0.0-dev.10 → 4.0.0-dev.101

package/lib/esm/ECSqlReader.js

@@ -1,276 +1,294 @@
-/*---------------------------------------------------------------------------------------------
-* 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 { DbQueryError, DbRequestKind, DbResponseStatus, DbValueFormat, QueryBinder, QueryOptionsBuilder, QueryRowFormat, } from "./ConcurrentQuery";
-/** @beta */
-export class PropertyMetaDataMap {
-    constructor(properties) {
-        this.properties = properties;
-        this._byPropName = new Map();
-        this._byJsonName = new Map();
-        this._byNoCase = new Map();
-        for (const property of this.properties) {
-            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;
-    }
-}
-/** @beta */
-export class ECSqlReader {
-    /** @internal */
-    constructor(_executor, query, param, options) {
-        this._executor = _executor;
-        this.query = query;
-        this._localRows = [];
-        this._localOffset = 0;
-        this._globalOffset = -1;
-        this._globalCount = -1;
-        this._done = false;
-        this._globalDone = false;
-        this._props = new PropertyMetaDataMap([]);
-        this._param = new QueryBinder().serialize();
-        this._lockArgs = false;
-        this._stats = { backendCpuTime: 0, backendTotalTime: 0, backendMemUsed: 0, backendRowsReturned: 0, totalTime: 0, retryCount: 0 };
-        this._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 === "getArray" || key === "toJSON") {
-                        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;
-            },
-        });
-        this._options = new QueryOptionsBuilder().getOptions();
-        if (query.trim().length === 0) {
-            throw new Error("expecting non-empty ecsql statement");
-        }
-        if (param) {
-            this._param = param.serialize();
-        }
-        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);
-            }
-        }
-    }
-    setParams(param) {
-        if (this._lockArgs) {
-            throw new Error("call resetBindings() before setting or changing parameters");
-        }
-        this._param = param.serialize();
-    }
-    reset(options) {
-        if (options) {
-            this._options = options;
-        }
-        this._props = new PropertyMetaDataMap([]);
-        this._localRows = [];
-        this._globalDone = false;
-        this._globalOffset = 0;
-        this._globalCount = -1;
-        if (typeof this._options.rowFormat === "undefined")
-            this._options.rowFormat = QueryRowFormat.UseECSqlPropertyIndexes;
-        if (this._options.limit) {
-            if (typeof this._options.limit.offset === "number" && this._options.limit.offset > 0)
-                this._globalOffset = this._options.limit.offset;
-            if (typeof this._options.limit.count === "number" && this._options.limit.count > 0)
-                this._globalCount = this._options.limit.count;
-        }
-        this._done = false;
-    }
-    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; }
-    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; }
-    async readRows() {
-        if (this._globalDone) {
-            return [];
-        }
-        this._lockArgs = true;
-        this._globalOffset += this._localRows.length;
-        this._globalCount -= this._localRows.length;
-        if (this._globalCount === 0) {
-            return [];
-        }
-        const valueFormat = this._options.rowFormat === QueryRowFormat.UseJsPropertyNames ? DbValueFormat.JsNames : DbValueFormat.ECSqlNames;
-        const request = {
-            ...this._options,
-            kind: DbRequestKind.ECSql,
-            valueFormat,
-            query: this.query,
-            args: this._param,
-        };
-        request.includeMetaData = this._props.length > 0 ? false : true;
-        request.limit = { offset: this._globalOffset, count: this._globalCount < 1 ? -1 : this._globalCount };
-        const resp = await this.runWithRetry(request);
-        this._globalDone = resp.status === DbResponseStatus.Done;
-        if (this._props.length === 0 && resp.meta.length > 0) {
-            this._props = new PropertyMetaDataMap(resp.meta);
-        }
-        for (const row of resp.data) {
-            ECSqlReader.replaceBase64WithUint8Array(row);
-        }
-        return resp.data;
-    }
-    async runWithRetry(request) {
-        const needRetry = (rs) => (rs.status === DbResponseStatus.Partial || rs.status === DbResponseStatus.QueueFull || rs.status === DbResponseStatus.Timeout) && (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;
-        };
-        const execQuery = async (req) => {
-            const startTime = Date.now();
-            const rs = await this._executor.execute(req);
-            this.stats.totalTime += (Date.now() - startTime);
-            return rs;
-        };
-        let retry = ECSqlReader._maxRetryCount;
-        let resp = await execQuery(request);
-        DbQueryError.throwIfError(resp, request);
-        while (--retry > 0 && needRetry(resp)) {
-            resp = await execQuery(request);
-            this._stats.retryCount += 1;
-            if (needRetry(resp)) {
-                updateStats(resp);
-            }
-        }
-        if (retry === 0 && needRetry(resp)) {
-            throw new Error("query too long to execute or server is too busy");
-        }
-        updateStats(resp);
-        return resp;
-    }
-    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;
-    }
-    async getMetaData() {
-        if (this._props.length === 0) {
-            await this.fetchRows();
-        }
-        return this._props.properties;
-    }
-    async fetchRows() {
-        this._localOffset = -1;
-        this._localRows = await this.readRows();
-        if (this._localRows.length === 0) {
-            this._done = true;
-        }
-    }
-    async step() {
-        if (this._done) {
-            return false;
-        }
-        const cachedRows = this._localRows.length;
-        if (this._localOffset < cachedRows - 1) {
-            ++this._localOffset;
-        }
-        else {
-            await this.fetchRows();
-            this._localOffset = 0;
-            return !this._done;
-        }
-        return true;
-    }
-    async toArray() {
-        const rows = [];
-        while (await this.step()) {
-            rows.push(this.formatCurrentRow());
-        }
-        return rows;
-    }
-}
-ECSqlReader._maxRetryCount = 10;
+/*---------------------------------------------------------------------------------------------
+* 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 { DbQueryError, DbRequestKind, DbResponseStatus, DbValueFormat, QueryBinder, QueryOptionsBuilder, QueryRowFormat, } from "./ConcurrentQuery";
+/** @beta */
+export class PropertyMetaDataMap {
+    constructor(properties) {
+        this.properties = properties;
+        this._byPropName = new Map();
+        this._byJsonName = new Map();
+        this._byNoCase = new Map();
+        for (const property of this.properties) {
+            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;
+    }
+}
+/** @beta */
+class ECSqlReader {
+    /** @internal */
+    constructor(_executor, query, param, options) {
+        this._executor = _executor;
+        this.query = query;
+        this._localRows = [];
+        this._localOffset = 0;
+        this._globalOffset = -1;
+        this._globalCount = -1;
+        this._done = false;
+        this._globalDone = false;
+        this._props = new PropertyMetaDataMap([]);
+        this._param = new QueryBinder().serialize();
+        this._lockArgs = false;
+        this._stats = { backendCpuTime: 0, backendTotalTime: 0, backendMemUsed: 0, backendRowsReturned: 0, totalTime: 0, retryCount: 0 };
+        this._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;
+            },
+        });
+        this._options = new QueryOptionsBuilder().getOptions();
+        if (query.trim().length === 0) {
+            throw new Error("expecting non-empty ecsql statement");
+        }
+        if (param) {
+            this._param = param.serialize();
+        }
+        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);
+            }
+        }
+    }
+    setParams(param) {
+        if (this._lockArgs) {
+            throw new Error("call resetBindings() before setting or changing parameters");
+        }
+        this._param = param.serialize();
+    }
+    reset(options) {
+        if (options) {
+            this._options = options;
+        }
+        this._props = new PropertyMetaDataMap([]);
+        this._localRows = [];
+        this._globalDone = false;
+        this._globalOffset = 0;
+        this._globalCount = -1;
+        if (typeof this._options.rowFormat === "undefined")
+            this._options.rowFormat = QueryRowFormat.UseECSqlPropertyIndexes;
+        if (this._options.limit) {
+            if (typeof this._options.limit.offset === "number" && this._options.limit.offset > 0)
+                this._globalOffset = this._options.limit.offset;
+            if (typeof this._options.limit.count === "number" && this._options.limit.count > 0)
+                this._globalCount = this._options.limit.count;
+        }
+        this._done = false;
+    }
+    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; }
+    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; }
+    async readRows() {
+        if (this._globalDone) {
+            return [];
+        }
+        this._lockArgs = true;
+        this._globalOffset += this._localRows.length;
+        this._globalCount -= this._localRows.length;
+        if (this._globalCount === 0) {
+            return [];
+        }
+        const valueFormat = this._options.rowFormat === QueryRowFormat.UseJsPropertyNames ? DbValueFormat.JsNames : DbValueFormat.ECSqlNames;
+        const request = {
+            ...this._options,
+            kind: DbRequestKind.ECSql,
+            valueFormat,
+            query: this.query,
+            args: this._param,
+        };
+        request.includeMetaData = this._props.length > 0 ? false : true;
+        request.limit = { offset: this._globalOffset, count: this._globalCount < 1 ? -1 : this._globalCount };
+        const resp = await this.runWithRetry(request);
+        this._globalDone = resp.status === DbResponseStatus.Done;
+        if (this._props.length === 0 && resp.meta.length > 0) {
+            this._props = new PropertyMetaDataMap(resp.meta);
+        }
+        for (const row of resp.data) {
+            ECSqlReader.replaceBase64WithUint8Array(row);
+        }
+        return resp.data;
+    }
+    async runWithRetry(request) {
+        const needRetry = (rs) => (rs.status === DbResponseStatus.Partial || rs.status === DbResponseStatus.QueueFull || rs.status === DbResponseStatus.Timeout) && (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;
+        };
+        const execQuery = async (req) => {
+            const startTime = Date.now();
+            const rs = await this._executor.execute(req);
+            this.stats.totalTime += (Date.now() - startTime);
+            return rs;
+        };
+        let retry = ECSqlReader._maxRetryCount;
+        let resp = await execQuery(request);
+        DbQueryError.throwIfError(resp, request);
+        while (--retry > 0 && needRetry(resp)) {
+            resp = await execQuery(request);
+            this._stats.retryCount += 1;
+            if (needRetry(resp)) {
+                updateStats(resp);
+            }
+        }
+        if (retry === 0 && needRetry(resp)) {
+            throw new Error("query too long to execute or server is too busy");
+        }
+        updateStats(resp);
+        return resp;
+    }
+    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;
+    }
+    async getMetaData() {
+        if (this._props.length === 0) {
+            await this.fetchRows();
+        }
+        return this._props.properties;
+    }
+    async fetchRows() {
+        this._localOffset = -1;
+        this._localRows = await this.readRows();
+        if (this._localRows.length === 0) {
+            this._done = true;
+        }
+    }
+    async step() {
+        if (this._done) {
+            return false;
+        }
+        const cachedRows = this._localRows.length;
+        if (this._localOffset < cachedRows - 1) {
+            ++this._localOffset;
+        }
+        else {
+            await this.fetchRows();
+            this._localOffset = 0;
+            return !this._done;
+        }
+        return true;
+    }
+    async toArray() {
+        const rows = [];
+        while (await this.step()) {
+            rows.push(this.formatCurrentRow());
+        }
+        return rows;
+    }
+    [Symbol.asyncIterator]() {
+        return this;
+    }
+    async next() {
+        if (await this.step()) {
+            return {
+                done: false,
+                value: this.current,
+            };
+        }
+        else {
+            return {
+                done: true,
+                value: this.current,
+            };
+        }
+    }
+}
+ECSqlReader._maxRetryCount = 10;
+export { ECSqlReader };
 //# sourceMappingURL=ECSqlReader.js.map