@itwin/core-backend 5.0.0-dev.10 → 5.0.0-dev.102

package/lib/cjs/ECDb.js

@@ -31,6 +31,10 @@ var ECDbOpenMode;
  * @public
  */
 class ECDb {
+    _nativeDb;
+    // eslint-disable-next-line @typescript-eslint/no-deprecated
+    _statementCache = new SqliteStatement_1.StatementCache();
+    _sqliteStatementCache = new SqliteStatement_1.StatementCache();
     /** only for tests
      * @internal
      */
@@ -39,20 +43,46 @@ class ECDb {
         this._sqliteStatementCache = new SqliteStatement_1.StatementCache(size);
     }
     constructor() {
-        this._statementCache = new SqliteStatement_1.StatementCache();
-        this._sqliteStatementCache = new SqliteStatement_1.StatementCache();
         this._nativeDb = new NativePlatform_1.IModelNative.platform.ECDb();
     }
     /** Call this function when finished with this ECDb object. This releases the native resources held by the
      *  ECDb object.
      */
-    dispose() {
+    [Symbol.dispose]() {
         if (!this._nativeDb)
             return;
         this.closeDb();
         this._nativeDb.dispose();
         this._nativeDb = undefined;
     }
+    /**
+     * Attach an iModel file to this connection and load and register its schemas.
+     * @note There are some reserve tablespace names that cannot be used. They are 'main', 'schema_sync_db', 'ecchange' & 'temp'
+     * @param fileName IModel file name
+     * @param alias identifier for the attached file. This identifer is used to access schema from the attached file. e.g. if alias is 'abc' then schema can be accessed using 'abc.MySchema.MyClass'
+     */
+    attachDb(fileName, alias) {
+        if (alias.toLowerCase() === "main" || alias.toLowerCase() === "schema_sync_db" || alias.toLowerCase() === "ecchange" || alias.toLowerCase() === "temp") {
+            throw new core_common_1.IModelError(core_bentley_1.DbResult.BE_SQLITE_ERROR, "Reserved tablespace name cannot be used");
+        }
+        this[Symbols_1._nativeDb].attachDb(fileName, alias);
+    }
+    /**
+     * Detach the attached file from this connection. The attached file is closed and its schemas are unregistered.
+     * @note There are some reserve tablespace names that cannot be used. They are 'main', 'schema_sync_db', 'ecchange' & 'temp'
+     * @param alias identifer that was used in the call to [[attachDb]]
+     */
+    detachDb(alias) {
+        if (alias.toLowerCase() === "main" || alias.toLowerCase() === "schema_sync_db" || alias.toLowerCase() === "ecchange" || alias.toLowerCase() === "temp") {
+            throw new core_common_1.IModelError(core_bentley_1.DbResult.BE_SQLITE_ERROR, "Reserved tablespace name cannot be used");
+        }
+        this.clearStatementCache();
+        this[Symbols_1._nativeDb].detachDb(alias);
+    }
+    /** @deprecated in 5.0 Use [Symbol.dispose] instead. */
+    dispose() {
+        this[Symbol.dispose]();
+    }
     /** Create an ECDb
      * @param pathName The path to the ECDb file to create.
      * @throws [IModelError]($common) if the operation failed.
@@ -131,6 +161,77 @@ class ECDb {
     getSchemaProps(name) {
         return this[Symbols_1._nativeDb].getSchemaProps(name);
     }
+    /**
+     * Use a prepared ECSQL statement, potentially from the statement cache. If the requested statement doesn't exist
+     * in the statement cache, a new statement is prepared. After the callback completes, the statement is reset and saved
+     * in the statement cache so it can be reused in the future. Use this method for ECSQL statements that will be
+     * reused often and are expensive to prepare. The statement cache holds the most recently used statements, discarding
+     * the oldest statements as it fills. For statements you don't intend to reuse, instead use [[withStatement]].
+     * @param sql The SQLite SQL statement to execute
+     * @param callback the callback to invoke on the prepared statement
+     * @param logErrors Determines if error will be logged if statement fail to prepare
+     * @returns the value returned by `callback`.
+     * @see [[withWriteStatement]]
+     * @beta
+     */
+    withCachedWriteStatement(ecsql, callback, logErrors = true) {
+        // eslint-disable-next-line @typescript-eslint/no-deprecated
+        const stmt = this._statementCache.findAndRemove(ecsql) ?? this.prepareStatement(ecsql, logErrors);
+        const release = () => this._statementCache.addOrDispose(stmt);
+        try {
+            const val = callback(new ECSqlStatement_1.ECSqlWriteStatement(stmt));
+            if (val instanceof Promise) {
+                val.then(release, release);
+            }
+            else {
+                release();
+            }
+            return val;
+        }
+        catch (err) {
+            release();
+            throw err;
+        }
+    }
+    /**
+     * Prepared and execute a callback on an ECSQL statement. After the callback completes the statement is disposed.
+     * Use this method for ECSQL statements are either not expected to be reused, or are not expensive to prepare.
+     * For statements that will be reused often, instead use [[withPreparedStatement]].
+     * @param sql The SQLite SQL statement to execute
+     * @param callback the callback to invoke on the prepared statement
+     * @param logErrors Determines if error will be logged if statement fail to prepare
+     * @returns the value returned by `callback`.
+     * @see [[withCachedWriteStatement]]
+     * @beta
+     */
+    withWriteStatement(ecsql, callback, logErrors = true) {
+        const stmt = this.prepareWriteStatement(ecsql, logErrors);
+        const release = () => { };
+        try {
+            const val = callback(stmt);
+            if (val instanceof Promise) {
+                val.then(release, release);
+            }
+            else {
+                release();
+            }
+            return val;
+        }
+        catch (err) {
+            release();
+            throw err;
+        }
+    }
+    /** Prepare an ECSQL statement.
+    * @param ecsql The ECSQL statement to prepare
+    * @param logErrors Determines if error will be logged if statement fail to prepare
+    * @throws [IModelError]($common) if there is a problem preparing the statement.
+    * @beta
+    */
+    prepareWriteStatement(ecsql, logErrors = true) {
+        // eslint-disable-next-line @typescript-eslint/no-deprecated
+        return new ECSqlStatement_1.ECSqlWriteStatement(this.prepareStatement(ecsql, logErrors));
+    }
     /**
      * Use a prepared ECSQL statement, potentially from the statement cache. If the requested statement doesn't exist
      * in the statement cache, a new statement is prepared. After the callback completes, the statement is reset and saved
@@ -143,8 +244,11 @@ class ECDb {
      * @returns the value returned by `callback`.
      * @see [[withStatement]]
      * @public
+     * @deprecated in 4.11.  Use [[createQueryReader]] for SELECT statements and [[withCachedWriteStatement]] for INSERT/UPDATE/DELETE instead.
      */
+    // eslint-disable-next-line @typescript-eslint/no-deprecated
     withPreparedStatement(ecsql, callback, logErrors = true) {
+        // eslint-disable-next-line @typescript-eslint/no-deprecated
         const stmt = this._statementCache.findAndRemove(ecsql) ?? this.prepareStatement(ecsql, logErrors);
         const release = () => this._statementCache.addOrDispose(stmt);
         try {
@@ -172,10 +276,13 @@ class ECDb {
      * @returns the value returned by `callback`.
      * @see [[withPreparedStatement]]
      * @public
+     * @deprecated in 4.11.  Use [[createQueryReader]] for SELECT statements and [[withWriteStatement]] for INSERT/UPDATE/DELETE instead.
      */
+    // eslint-disable-next-line @typescript-eslint/no-deprecated
     withStatement(ecsql, callback, logErrors = true) {
+        // eslint-disable-next-line @typescript-eslint/no-deprecated
         const stmt = this.prepareStatement(ecsql, logErrors);
-        const release = () => stmt.dispose();
+        const release = () => stmt[Symbol.dispose]();
         try {
             const val = callback(stmt);
             if (val instanceof Promise) {
@@ -195,8 +302,11 @@ class ECDb {
      * @param ecsql The ECSQL statement to prepare
      * @param logErrors Determines if error will be logged if statement fail to prepare
      * @throws [IModelError]($common) if there is a problem preparing the statement.
+     * @deprecated in 4.11.  Use [[prepareWriteStatement]] when preparing an INSERT/UPDATE/DELETE statement or [[createQueryReader]] to execute a SELECT statement.
      */
+    // eslint-disable-next-line @typescript-eslint/no-deprecated
     prepareStatement(ecsql, logErrors = true) {
+        // eslint-disable-next-line @typescript-eslint/no-deprecated
         const stmt = new ECSqlStatement_1.ECSqlStatement();
         stmt.prepare(this[Symbols_1._nativeDb], ecsql, logErrors);
         return stmt;
@@ -244,7 +354,7 @@ class ECDb {
      */
     withSqliteStatement(sql, callback, logErrors = true) {
         const stmt = this.prepareSqliteStatement(sql, logErrors);
-        const release = () => stmt.dispose();
+        const release = () => stmt[Symbol.dispose]();
         try {
             const val = callback(stmt);
             if (val instanceof Promise) {
@@ -271,10 +381,6 @@ class ECDb {
         stmt.prepare(this[Symbols_1._nativeDb], logErrors);
         return stmt;
     }
-    /** @internal
-     * @deprecated in 4.8. This internal API will be removed in 5.0. Use ECDb's public API instead.
-     */
-    get nativeDb() { return this[Symbols_1._nativeDb]; }
     /** @internal */
     get [Symbols_1._nativeDb]() {
         (0, core_bentley_1.assert)(undefined !== this._nativeDb);
@@ -303,70 +409,6 @@ class ECDb {
         };
         return new core_common_1.ECSqlReader(executor, ecsql, params, config);
     }
-    /** Execute a query and stream its results
-     * The result of the query is async iterator over the rows. The iterator will get next page automatically once rows in current page has been read.
-     * [ECSQL row]($docs/learning/ECSQLRowFormat).
-     *
-     * See also:
-     * - [ECSQL Overview]($docs/learning/backend/ExecutingECSQL)
-     * - [Code Examples]($docs/learning/backend/ECSQLCodeExamples)
-     *
-     * @param ecsql The ECSQL statement to execute
-     * @param params The values to bind to the parameters (if the ECSQL has any).
-     * @param options Allow to specify certain flags which control how query is executed.
-     * @returns Returns the query result as an *AsyncIterableIterator<any>*  which lazy load result as needed. The row format is determined by *rowFormat* parameter.
-     * See [ECSQL row format]($docs/learning/ECSQLRowFormat) for details about the format of the returned rows.
-     * @throws [IModelError]($common) If there was any error while submitting, preparing or stepping into query
-     * @deprecated in 3.7. Use [[createQueryReader]] instead; it accepts the same parameters.
-     */
-    async *query(ecsql, params, options) {
-        const builder = new core_common_1.QueryOptionsBuilder(options);
-        const reader = this.createQueryReader(ecsql, params, builder.getOptions());
-        while (await reader.step())
-            yield reader.formatCurrentRow();
-    }
-    /** Compute number of rows that would be returned by the ECSQL.
-     *
-     * See also:
-     * - [ECSQL Overview]($docs/learning/backend/ExecutingECSQL)
-     * - [Code Examples]($docs/learning/backend/ECSQLCodeExamples)
-     *
-     * @param ecsql The ECSQL statement to execute
-     * @param params The values to bind to the parameters (if the ECSQL has any).
-     * See "[iTwin.js Types used in ECSQL Parameter Bindings]($docs/learning/ECSQLParameterTypes)" for details.
-     * @returns Return row count.
-     * @throws [IModelError]($common) If the statement is invalid
-     * @deprecated in 3.7. Count the number of results using `count(*)` where the original query is a subquery instead. E.g., `SELECT count(*) FROM (<query-whose-rows-to-count>)`.
-     */
-    async queryRowCount(ecsql, params) {
-        for await (const row of this.createQueryReader(`SELECT count(*) FROM (${ecsql})`, params)) {
-            return row[0];
-        }
-        throw new core_common_1.IModelError(core_bentley_1.DbResult.BE_SQLITE_ERROR, "Failed to get row count");
-    }
-    /** Cancel any previous query with same token and run execute the current specified query.
-     * The result of the query is async iterator over the rows. The iterator will get next page automatically once rows in current page has been read.
-     * [ECSQL row]($docs/learning/ECSQLRowFormat).
-     *
-     * See also:
-     * - [ECSQL Overview]($docs/learning/backend/ExecutingECSQL)
-     * - [Code Examples]($docs/learning/backend/ECSQLCodeExamples)
-     *
-     * @param ecsql The ECSQL statement to execute
-     * @param token None empty restart token. The previous query with same token would be cancelled. This would cause
-     * exception which user code must handle.
-     * @param params The values to bind to the parameters (if the ECSQL has any).
-     * @param options Allow to specify certain flags which control how query is executed.
-     * @returns Returns the query result as an *AsyncIterableIterator<any>*  which lazy load result as needed. The row format is determined by *rowFormat* parameter.
-     * See [ECSQL row format]($docs/learning/ECSQLRowFormat) for details about the format of the returned rows.
-     * @throws [IModelError]($common) If there was any error while submitting, preparing or stepping into query
-     * @deprecated in 3.7. Use [[createQueryReader]] instead. Pass in the restart token as part of the `config` argument; e.g., `{ restartToken: myToken }` or `new QueryOptionsBuilder().setRestartToken(myToken).getOptions()`.
-     */
-    async *restartQuery(token, ecsql, params, options) {
-        for await (const row of this.createQueryReader(ecsql, params, new core_common_1.QueryOptionsBuilder(options).setRestartToken(token).getOptions())) {
-            yield row;
-        }
-    }
 }
 exports.ECDb = ECDb;
 //# sourceMappingURL=ECDb.js.map

package/lib/cjs/ECDb.js.map

@@ -1 +1 @@
-{"version":3,"file":"ECDb.js","sourceRoot":"","sources":["../../src/ECDb.ts"],"names":[],"mappings":";;;AAAA;;;+FAG+F;AAC/F;;GAEG;AACH,sDAAsF;AAEtF,oDAA6I;AAC7I,mEAAgE;AAChE,uDAAoD;AACpD,qDAAkD;AAClD,8DAAyD;AACzD,uDAAoE;AACpE,gDAA+C;AAE/C,MAAM,cAAc,GAAW,6CAAqB,CAAC,IAAI,CAAC;AAE1D;;GAEG;AACH,IAAY,YAKX;AALD,WAAY,YAAY;IACtB,uDAAQ,CAAA;IACR,yDAAS,CAAA;IACT,sGAAsG;IACtG,6DAAW,CAAA;AACb,CAAC,EALW,YAAY,4BAAZ,YAAY,QAKvB;AAED;;GAEG;AACH,MAAa,IAAI;IAKf;;OAEG;IACI,gBAAgB,CAAC,IAAY;QAClC,IAAI,CAAC,qBAAqB,CAAC,KAAK,EAAE,CAAC;QACnC,IAAI,CAAC,qBAAqB,GAAG,IAAI,gCAAc,CAAkB,IAAI,CAAC,CAAC;IACzE,CAAC;IAED;QAXiB,oBAAe,GAAG,IAAI,gCAAc,EAAkB,CAAC;QAChE,0BAAqB,GAAG,IAAI,gCAAc,EAAmB,CAAC;QAWpE,IAAI,CAAC,SAAS,GAAG,IAAI,6BAAY,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC;IACpD,CAAC;IACD;;OAEG;IACI,OAAO;QACZ,IAAI,CAAC,IAAI,CAAC,SAAS;YACjB,OAAO;QAET,IAAI,CAAC,OAAO,EAAE,CAAC;QACf,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,CAAC;QACzB,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;IAC7B,CAAC;IAED;;;OAGG;IACI,QAAQ,CAAC,QAAgB;QAC9B,MAAM,MAAM,GAAa,IAAI,CAAC,mBAAS,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;QAC5D,IAAI,MAAM,KAAK,uBAAQ,CAAC,YAAY;YAClC,MAAM,IAAI,yBAAW,CAAC,MAAM,EAAE,wBAAwB,CAAC,CAAC;IAC5D,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,QAAgB,EAAE,WAAyB,YAAY,CAAC,QAAQ;QAC5E,MAAM,cAAc,GAAa,QAAQ,KAAK,YAAY,CAAC,QAAQ,CAAC,CAAC,CAAC,uBAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC,uBAAQ,CAAC,SAAS,CAAC;QAC7G,MAAM,UAAU,GAAY,QAAQ,KAAK,YAAY,CAAC,WAAW,CAAC;QAClE,MAAM,MAAM,GAAa,IAAI,CAAC,mBAAS,CAAC,CAAC,MAAM,CAAC,QAAQ,EAAE,cAAc,EAAE,UAAU,CAAC,CAAC;QACtF,IAAI,MAAM,KAAK,uBAAQ,CAAC,YAAY;YAClC,MAAM,IAAI,yBAAW,CAAC,MAAM,EAAE,qBAAqB,CAAC,CAAC;IACzD,CAAC;IAED,uCAAuC;IACvC,IAAW,MAAM,KAAc,OAAO,IAAI,CAAC,mBAAS,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;IAEjE;;OAEG;IACI,OAAO;QACZ,IAAI,CAAC,eAAe,CAAC,KAAK,EAAE,CAAC;QAC7B,IAAI,CAAC,qBAAqB,CAAC,KAAK,EAAE,CAAC;QACnC,IAAI,CAAC,mBAAS,CAAC,CAAC,OAAO,EAAE,CAAC;IAC5B,CAAC;IAED,8CAA8C;IACvC,mBAAmB;QACxB,IAAI,CAAC,eAAe,CAAC,KAAK,EAAE,CAAC;IAC/B,CAAC;IAED,8CAA8C;IACvC,uBAAuB;QAC5B,OAAO,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC;IACnC,CAAC;IAED;;;OAGG;IACI,WAAW,CAAC,aAAsB;QACvC,MAAM,MAAM,GAAa,IAAI,CAAC,mBAAS,CAAC,CAAC,WAAW,CAAC,aAAa,CAAC,CAAC;QACpE,IAAI,MAAM,KAAK,uBAAQ,CAAC,YAAY;YAClC,MAAM,IAAI,yBAAW,CAAC,MAAM,EAAE,wBAAwB,CAAC,CAAC;IAC5D,CAAC;IAED;;OAEG;IACI,cAAc;QACnB,MAAM,MAAM,GAAa,IAAI,CAAC,mBAAS,CAAC,CAAC,cAAc,EAAE,CAAC;QAC1D,IAAI,MAAM,KAAK,uBAAQ,CAAC,YAAY;YAClC,MAAM,IAAI,yBAAW,CAAC,MAAM,EAAE,2BAA2B,CAAC,CAAC;IAC/D,CAAC;IAED;;;;;OAKG;IACI,YAAY,CAAC,QAAgB;QAClC,MAAM,MAAM,GAAa,IAAI,CAAC,mBAAS,CAAC,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;QAChE,IAAI,MAAM,KAAK,uBAAQ,CAAC,YAAY,EAAE,CAAC;YACrC,qBAAM,CAAC,QAAQ,CAAC,cAAc,EAAE,iCAAiC,QAAQ,IAAI,CAAC,CAAC;YAC/E,MAAM,IAAI,yBAAW,CAAC,MAAM,EAAE,iCAAiC,QAAQ,IAAI,CAAC,CAAC;QAC/E,CAAC;IACH,CAAC;IAED;;;;;OAKG;IACI,cAAc,CAAC,IAAY;QAChC,OAAO,IAAI,CAAC,mBAAS,CAAC,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;IAC9C,CAAC;IAED;;;;;;;;;;;;OAYG;IACI,qBAAqB,CAAI,KAAa,EAAE,QAAqC,EAAE,SAAS,GAAG,IAAI;QACpG,MAAM,IAAI,GAAG,IAAI,CAAC,eAAe,CAAC,aAAa,CAAC,KAAK,CAAC,IAAI,IAAI,CAAC,gBAAgB,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;QAClG,MAAM,OAAO,GAAG,GAAG,EAAE,CAAC,IAAI,CAAC,eAAe,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;QAC9D,IAAI,CAAC;YACH,MAAM,GAAG,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC;YAC3B,IAAI,GAAG,YAAY,OAAO,EAAE,CAAC;gBAC3B,GAAG,CAAC,IAAI,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;YAC7B,CAAC;iBAAM,CAAC;gBACN,OAAO,EAAE,CAAC;YACZ,CAAC;YACD,OAAO,GAAG,CAAC;QACb,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,OAAO,EAAE,CAAC;YACV,MAAM,GAAG,CAAC;QACZ,CAAC;IACH,CAAC;IAED;;;;;;;;;;OAUG;IACI,aAAa,CAAI,KAAa,EAAE,QAAqC,EAAE,SAAS,GAAG,IAAI;QAC5F,MAAM,IAAI,GAAG,IAAI,CAAC,gBAAgB,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;QACrD,MAAM,OAAO,GAAG,GAAG,EAAE,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC;QACrC,IAAI,CAAC;YACH,MAAM,GAAG,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC;YAC3B,IAAI,GAAG,YAAY,OAAO,EAAE,CAAC;gBAC3B,GAAG,CAAC,IAAI,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;YAC7B,CAAC;iBAAM,CAAC;gBACN,OAAO,EAAE,CAAC;YACZ,CAAC;YACD,OAAO,GAAG,CAAC;QACb,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,OAAO,EAAE,CAAC;YACV,MAAM,GAAG,CAAC;QACZ,CAAC;IACH,CAAC;IAED;;;;OAIG;IACI,gBAAgB,CAAC,KAAa,EAAE,SAAS,GAAG,IAAI;QACrD,MAAM,IAAI,GAAG,IAAI,+BAAc,EAAE,CAAC;QAClC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,mBAAS,CAAC,EAAE,KAAK,EAAE,SAAS,CAAC,CAAC;QAChD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;;OAYG;IACI,2BAA2B,CAAI,GAAW,EAAE,QAAsC,EAAE,SAAS,GAAG,IAAI;QACzG,MAAM,IAAI,GAAG,IAAI,CAAC,qBAAqB,CAAC,aAAa,CAAC,GAAG,CAAC,IAAI,IAAI,CAAC,sBAAsB,CAAC,GAAG,EAAE,SAAS,CAAC,CAAC;QAC1G,MAAM,OAAO,GAAG,GAAG,EAAE,CAAC,IAAI,CAAC,qBAAqB,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;QACpE,IAAI,CAAC;YACH,MAAM,GAAG,GAAM,QAAQ,CAAC,IAAI,CAAC,CAAC;YAC9B,IAAI,GAAG,YAAY,OAAO,EAAE,CAAC;gBAC3B,GAAG,CAAC,IAAI,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;YAC7B,CAAC;iBAAM,CAAC;gBACN,OAAO,EAAE,CAAC;YACZ,CAAC;YACD,OAAO,GAAG,CAAC;QACb,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,OAAO,EAAE,CAAC;YACV,MAAM,GAAG,CAAC;QACZ,CAAC;IACH,CAAC;IAED;;;;;;;;;OASG;IACI,mBAAmB,CAAI,GAAW,EAAE,QAAsC,EAAE,SAAS,GAAG,IAAI;QACjG,MAAM,IAAI,GAAG,IAAI,CAAC,sBAAsB,CAAC,GAAG,EAAE,SAAS,CAAC,CAAC;QACzD,MAAM,OAAO,GAAG,GAAG,EAAE,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC;QACrC,IAAI,CAAC;YACH,MAAM,GAAG,GAAM,QAAQ,CAAC,IAAI,CAAC,CAAC;YAC9B,IAAI,GAAG,YAAY,OAAO,EAAE,CAAC;gBAC3B,GAAG,CAAC,IAAI,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;YAC7B,CAAC;iBAAM,CAAC;gBACN,OAAO,EAAE,CAAC;YACZ,CAAC;YACD,OAAO,GAAG,CAAC;QACb,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,OAAO,EAAE,CAAC;YACV,MAAM,GAAG,CAAC;QACZ,CAAC;IACH,CAAC;IAED;;;;;OAKG;IACI,sBAAsB,CAAC,GAAW,EAAE,SAAS,GAAG,IAAI;QACzD,MAAM,IAAI,GAAG,IAAI,iCAAe,CAAC,GAAG,CAAC,CAAC;QACtC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,mBAAS,CAAC,EAAE,SAAS,CAAC,CAAC;QACzC,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACH,IAAW,QAAQ,KAA0B,OAAO,IAAI,CAAC,mBAAS,CAAC,CAAC,CAAC,CAAC;IAEtE,gBAAgB;IAChB,IAAW,CAAC,mBAAS,CAAC;QACpB,IAAA,qBAAM,EAAC,SAAS,KAAK,IAAI,CAAC,SAAS,CAAC,CAAC;QACrC,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;IAED;;;;;;;;;;;SAWK;IACE,iBAAiB,CAAC,KAAa,EAAE,MAAoB,EAAE,MAAqB;QACjF,IAAI,CAAC,IAAI,CAAC,SAAS,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,EAAE,CAAC;YAChD,MAAM,IAAI,yBAAW,CAAC,uBAAQ,CAAC,eAAe,EAAE,aAAa,CAAC,CAAC;QACjE,CAAC;QACD,MAAM,QAAQ,GAAG;YACf,OAAO,EAAE,KAAK,EAAE,OAAuB,EAAE,EAAE;gBACzC,OAAO,iCAAe,CAAC,mBAAmB,CAAC,IAAI,CAAC,mBAAS,CAAC,EAAE,OAAO,CAAC,CAAC;YACvE,CAAC;SACF,CAAC;QACF,OAAO,IAAI,yBAAW,CAAC,QAAQ,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;IAC1D,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACI,KAAK,CAAC,CAAE,KAAK,CAAC,KAAa,EAAE,MAAoB,EAAE,OAAsB;QAC9E,MAAM,OAAO,GAAG,IAAI,iCAAmB,CAAC,OAAO,CAAC,CAAC;QACjD,MAAM,MAAM,GAAG,IAAI,CAAC,iBAAiB,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,UAAU,EAAE,CAAC,CAAC;QAC3E,OAAO,MAAM,MAAM,CAAC,IAAI,EAAE;YACxB,MAAM,MAAM,CAAC,gBAAgB,EAAE,CAAC;IACpC,CAAC;IACD;;;;;;;;;;;;OAYG;IACI,KAAK,CAAC,aAAa,CAAC,KAAa,EAAE,MAAoB;QAC5D,IAAI,KAAK,EAAE,MAAM,GAAG,IAAI,IAAI,CAAC,iBAAiB,CAAC,yBAAyB,KAAK,GAAG,EAAE,MAAM,CAAC,EAAE,CAAC;YAC1F,OAAO,GAAG,CAAC,CAAC,CAAW,CAAC;QAC1B,CAAC;QACD,MAAM,IAAI,yBAAW,CAAC,uBAAQ,CAAC,eAAe,EAAE,yBAAyB,CAAC,CAAC;IAC7E,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACI,KAAK,CAAC,CAAE,YAAY,CAAC,KAAa,EAAE,KAAa,EAAE,MAAoB,EAAE,OAAsB;QACpG,IAAI,KAAK,EAAE,MAAM,GAAG,IAAI,IAAI,CAAC,iBAAiB,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,iCAAmB,CAAC,OAAO,CAAC,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC,UAAU,EAAE,CAAC,EAAE,CAAC;YACpI,MAAM,GAAG,CAAC;QACZ,CAAC;IACH,CAAC;CACF;AAlWD,oBAkWC","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 ECDb\r\n */\r\nimport { assert, DbResult, IDisposable, Logger, OpenMode } from \"@itwin/core-bentley\";\r\nimport { IModelJsNative } from \"@bentley/imodeljs-native\";\r\nimport { DbQueryRequest, ECSchemaProps, ECSqlReader, IModelError, QueryBinder, QueryOptions, QueryOptionsBuilder } from \"@itwin/core-common\";\r\nimport { BackendLoggerCategory } from \"./BackendLoggerCategory\";\r\nimport { ConcurrentQuery } from \"./ConcurrentQuery\";\r\nimport { ECSqlStatement } from \"./ECSqlStatement\";\r\nimport { IModelNative } from \"./internal/NativePlatform\";\r\nimport { SqliteStatement, StatementCache } from \"./SqliteStatement\";\r\nimport { _nativeDb } from \"./internal/Symbols\";\r\n\r\nconst loggerCategory: string = BackendLoggerCategory.ECDb;\r\n\r\n/** Modes for how to open [ECDb]($backend) files.\r\n * @public\r\n */\r\nexport enum ECDbOpenMode {\r\n  Readonly,\r\n  ReadWrite,\r\n  /** Opens the file read-write and upgrades the file if necessary to the latest file format version. */\r\n  FileUpgrade,\r\n}\r\n\r\n/** An ECDb file\r\n * @public\r\n */\r\nexport class ECDb implements IDisposable {\r\n  private _nativeDb?: IModelJsNative.ECDb;\r\n  private readonly _statementCache = new StatementCache<ECSqlStatement>();\r\n  private _sqliteStatementCache = new StatementCache<SqliteStatement>();\r\n\r\n  /** only for tests\r\n   * @internal\r\n   */\r\n  public resetSqliteCache(size: number) {\r\n    this._sqliteStatementCache.clear();\r\n    this._sqliteStatementCache = new StatementCache<SqliteStatement>(size);\r\n  }\r\n\r\n  constructor() {\r\n    this._nativeDb = new IModelNative.platform.ECDb();\r\n  }\r\n  /** Call this function when finished with this ECDb object. This releases the native resources held by the\r\n   *  ECDb object.\r\n   */\r\n  public dispose(): void {\r\n    if (!this._nativeDb)\r\n      return;\r\n\r\n    this.closeDb();\r\n    this._nativeDb.dispose();\r\n    this._nativeDb = undefined;\r\n  }\r\n\r\n  /** Create an ECDb\r\n   * @param pathName The path to the ECDb file to create.\r\n   * @throws [IModelError]($common) if the operation failed.\r\n   */\r\n  public createDb(pathName: string): void {\r\n    const status: DbResult = this[_nativeDb].createDb(pathName);\r\n    if (status !== DbResult.BE_SQLITE_OK)\r\n      throw new IModelError(status, \"Failed to created ECDb\");\r\n  }\r\n\r\n  /** Open the ECDb.\r\n   * @param pathName The path to the ECDb file to open\r\n   * @param openMode Open mode\r\n   * @throws [IModelError]($common) if the operation failed.\r\n   */\r\n  public openDb(pathName: string, openMode: ECDbOpenMode = ECDbOpenMode.Readonly): void {\r\n    const nativeOpenMode: OpenMode = openMode === ECDbOpenMode.Readonly ? OpenMode.Readonly : OpenMode.ReadWrite;\r\n    const tryUpgrade: boolean = openMode === ECDbOpenMode.FileUpgrade;\r\n    const status: DbResult = this[_nativeDb].openDb(pathName, nativeOpenMode, tryUpgrade);\r\n    if (status !== DbResult.BE_SQLITE_OK)\r\n      throw new IModelError(status, \"Failed to open ECDb\");\r\n  }\r\n\r\n  /** Returns true if the ECDb is open */\r\n  public get isOpen(): boolean { return this[_nativeDb].isOpen(); }\r\n\r\n  /** Close the Db after saving any uncommitted changes.\r\n   * @throws [IModelError]($common) if the database is not open.\r\n   */\r\n  public closeDb(): void {\r\n    this._statementCache.clear();\r\n    this._sqliteStatementCache.clear();\r\n    this[_nativeDb].closeDb();\r\n  }\r\n\r\n  /** @internal use to test statement caching */\r\n  public clearStatementCache() {\r\n    this._statementCache.clear();\r\n  }\r\n\r\n  /** @internal use to test statement caching */\r\n  public getCachedStatementCount() {\r\n    return this._statementCache.size;\r\n  }\r\n\r\n  /** Commit the outermost transaction, writing changes to the file. Then, restart the transaction.\r\n   * @param changesetName The name of the operation that generated these changes.\r\n   * @throws [IModelError]($common) if the database is not open or if the operation failed.\r\n   */\r\n  public saveChanges(changesetName?: string): void {\r\n    const status: DbResult = this[_nativeDb].saveChanges(changesetName);\r\n    if (status !== DbResult.BE_SQLITE_OK)\r\n      throw new IModelError(status, \"Failed to save changes\");\r\n  }\r\n\r\n  /** Abandon (cancel) the outermost transaction, discarding all changes since last save. Then, restart the transaction.\r\n   * @throws [IModelError]($common) if the database is not open or if the operation failed.\r\n   */\r\n  public abandonChanges(): void {\r\n    const status: DbResult = this[_nativeDb].abandonChanges();\r\n    if (status !== DbResult.BE_SQLITE_OK)\r\n      throw new IModelError(status, \"Failed to abandon changes\");\r\n  }\r\n\r\n  /** Import a schema.\r\n   *\r\n   * If the import was successful, the database is automatically saved to disk.\r\n   * @param pathName Path to ECSchema XML file to import.\r\n   * @throws [IModelError]($common) if the database is not open or if the operation failed.\r\n   */\r\n  public importSchema(pathName: string): void {\r\n    const status: DbResult = this[_nativeDb].importSchema(pathName);\r\n    if (status !== DbResult.BE_SQLITE_OK) {\r\n      Logger.logError(loggerCategory, `Failed to import schema from '${pathName}'.`);\r\n      throw new IModelError(status, `Failed to import schema from '${pathName}'.`);\r\n    }\r\n  }\r\n\r\n  /**\r\n   * Returns the full schema for the input name.\r\n   * @param name The name of the schema e.g. 'ECDbMeta'\r\n   * @returns The SchemaProps for the requested schema\r\n   * @throws if the schema can not be found or loaded.\r\n   */\r\n  public getSchemaProps(name: string): ECSchemaProps {\r\n    return this[_nativeDb].getSchemaProps(name);\r\n  }\r\n\r\n  /**\r\n   * Use a prepared ECSQL statement, potentially from the statement cache. If the requested statement doesn't exist\r\n   * in the statement cache, a new statement is prepared. After the callback completes, the statement is reset and saved\r\n   * in the statement cache so it can be reused in the future. Use this method for ECSQL statements that will be\r\n   * reused often and are expensive to prepare. The statement cache holds the most recently used statements, discarding\r\n   * the oldest statements as it fills. For statements you don't intend to reuse, instead use [[withStatement]].\r\n   * @param sql The SQLite SQL statement to execute\r\n   * @param callback the callback to invoke on the prepared statement\r\n   * @param logErrors Determines if error will be logged if statement fail to prepare\r\n   * @returns the value returned by `callback`.\r\n   * @see [[withStatement]]\r\n   * @public\r\n   */\r\n  public withPreparedStatement<T>(ecsql: string, callback: (stmt: ECSqlStatement) => T, logErrors = true): T {\r\n    const stmt = this._statementCache.findAndRemove(ecsql) ?? this.prepareStatement(ecsql, logErrors);\r\n    const release = () => this._statementCache.addOrDispose(stmt);\r\n    try {\r\n      const val = callback(stmt);\r\n      if (val instanceof Promise) {\r\n        val.then(release, release);\r\n      } else {\r\n        release();\r\n      }\r\n      return val;\r\n    } catch (err) {\r\n      release();\r\n      throw err;\r\n    }\r\n  }\r\n\r\n  /**\r\n   * Prepared and execute a callback on an ECSQL statement. After the callback completes the statement is disposed.\r\n   * Use this method for ECSQL statements are either not expected to be reused, or are not expensive to prepare.\r\n   * For statements that will be reused often, instead use [[withPreparedStatement]].\r\n   * @param sql The SQLite SQL statement to execute\r\n   * @param callback the callback to invoke on the prepared statement\r\n   * @param logErrors Determines if error will be logged if statement fail to prepare\r\n   * @returns the value returned by `callback`.\r\n   * @see [[withPreparedStatement]]\r\n   * @public\r\n   */\r\n  public withStatement<T>(ecsql: string, callback: (stmt: ECSqlStatement) => T, logErrors = true): T {\r\n    const stmt = this.prepareStatement(ecsql, logErrors);\r\n    const release = () => stmt.dispose();\r\n    try {\r\n      const val = callback(stmt);\r\n      if (val instanceof Promise) {\r\n        val.then(release, release);\r\n      } else {\r\n        release();\r\n      }\r\n      return val;\r\n    } catch (err) {\r\n      release();\r\n      throw err;\r\n    }\r\n  }\r\n\r\n  /** Prepare an ECSQL statement.\r\n   * @param ecsql The ECSQL statement to prepare\r\n   * @param logErrors Determines if error will be logged if statement fail to prepare\r\n   * @throws [IModelError]($common) if there is a problem preparing the statement.\r\n   */\r\n  public prepareStatement(ecsql: string, logErrors = true): ECSqlStatement {\r\n    const stmt = new ECSqlStatement();\r\n    stmt.prepare(this[_nativeDb], ecsql, logErrors);\r\n    return stmt;\r\n  }\r\n\r\n  /**\r\n   * Use a prepared SQL statement, potentially from the statement cache. If the requested statement doesn't exist\r\n   * in the statement cache, a new statement is prepared. After the callback completes, the statement is reset and saved\r\n   * in the statement cache so it can be reused in the future. Use this method for SQL statements that will be\r\n   * reused often and are expensive to prepare. The statement cache holds the most recently used statements, discarding\r\n   * the oldest statements as it fills. For statements you don't intend to reuse, instead use [[withSqliteStatement]].\r\n   * @param sql The SQLite SQL statement to execute\r\n   * @param callback the callback to invoke on the prepared statement\r\n   * @param logErrors Determines if error will be logged if statement fail to prepare\r\n   * @returns the value returned by `callback`.\r\n   * @see [[withPreparedStatement]]\r\n   * @public\r\n   */\r\n  public withPreparedSqliteStatement<T>(sql: string, callback: (stmt: SqliteStatement) => T, logErrors = true): T {\r\n    const stmt = this._sqliteStatementCache.findAndRemove(sql) ?? this.prepareSqliteStatement(sql, logErrors);\r\n    const release = () => this._sqliteStatementCache.addOrDispose(stmt);\r\n    try {\r\n      const val: T = callback(stmt);\r\n      if (val instanceof Promise) {\r\n        val.then(release, release);\r\n      } else {\r\n        release();\r\n      }\r\n      return val;\r\n    } catch (err) {\r\n      release();\r\n      throw err;\r\n    }\r\n  }\r\n\r\n  /**\r\n   * Prepared and execute a callback on a SQL statement. After the callback completes the statement is disposed.\r\n   * Use this method for SQL statements are either not expected to be reused, or are not expensive to prepare.\r\n   * For statements that will be reused often, instead use [[withPreparedSqliteStatement]].\r\n   * @param sql The SQLite SQL statement to execute\r\n   * @param callback the callback to invoke on the prepared statement\r\n   * @param logErrors Determines if error will be logged if statement fail to prepare\r\n   * @returns the value returned by `callback`.\r\n   * @public\r\n   */\r\n  public withSqliteStatement<T>(sql: string, callback: (stmt: SqliteStatement) => T, logErrors = true): T {\r\n    const stmt = this.prepareSqliteStatement(sql, logErrors);\r\n    const release = () => stmt.dispose();\r\n    try {\r\n      const val: T = callback(stmt);\r\n      if (val instanceof Promise) {\r\n        val.then(release, release);\r\n      } else {\r\n        release();\r\n      }\r\n      return val;\r\n    } catch (err) {\r\n      release();\r\n      throw err;\r\n    }\r\n  }\r\n\r\n  /** Prepare an SQL statement.\r\n   * @param sql The SQLite SQL statement to prepare\r\n   * @param logErrors Determines if error will be logged if statement fail to prepare\r\n   * @throws [IModelError]($common) if there is a problem preparing the statement.\r\n   * @internal\r\n   */\r\n  public prepareSqliteStatement(sql: string, logErrors = true): SqliteStatement {\r\n    const stmt = new SqliteStatement(sql);\r\n    stmt.prepare(this[_nativeDb], logErrors);\r\n    return stmt;\r\n  }\r\n\r\n  /** @internal\r\n   * @deprecated in 4.8. This internal API will be removed in 5.0. Use ECDb's public API instead.\r\n   */\r\n  public get nativeDb(): IModelJsNative.ECDb { return this[_nativeDb]; }\r\n\r\n  /** @internal */\r\n  public get [_nativeDb](): IModelJsNative.ECDb {\r\n    assert(undefined !== this._nativeDb);\r\n    return this._nativeDb;\r\n  }\r\n\r\n  /** Allow to execute query and read results along with meta data. The result are streamed.\r\n   *\r\n   * See also:\r\n   * - [ECSQL Overview]($docs/learning/backend/ExecutingECSQL)\r\n   * - [Code Examples]($docs/learning/backend/ECSQLCodeExamples)\r\n   * - [ECSQL Row Format]($docs/learning/ECSQLRowFormat)\r\n   *\r\n   * @param params The values to bind to the parameters (if the ECSQL has any).\r\n   * @param config Allow to specify certain flags which control how query is executed.\r\n   * @returns Returns an [ECSqlReader]($common) which helps iterate over the result set and also give access to metadata.\r\n   * @public\r\n   * */\r\n  public createQueryReader(ecsql: string, params?: QueryBinder, config?: QueryOptions): ECSqlReader {\r\n    if (!this._nativeDb || !this._nativeDb.isOpen()) {\r\n      throw new IModelError(DbResult.BE_SQLITE_ERROR, \"db not open\");\r\n    }\r\n    const executor = {\r\n      execute: async (request: DbQueryRequest) => {\r\n        return ConcurrentQuery.executeQueryRequest(this[_nativeDb], request);\r\n      },\r\n    };\r\n    return new ECSqlReader(executor, ecsql, params, config);\r\n  }\r\n\r\n  /** Execute a query and stream its results\r\n   * The result of the query is async iterator over the rows. The iterator will get next page automatically once rows in current page has been read.\r\n   * [ECSQL row]($docs/learning/ECSQLRowFormat).\r\n   *\r\n   * See also:\r\n   * - [ECSQL Overview]($docs/learning/backend/ExecutingECSQL)\r\n   * - [Code Examples]($docs/learning/backend/ECSQLCodeExamples)\r\n   *\r\n   * @param ecsql The ECSQL statement to execute\r\n   * @param params The values to bind to the parameters (if the ECSQL has any).\r\n   * @param options Allow to specify certain flags which control how query is executed.\r\n   * @returns Returns the query result as an *AsyncIterableIterator<any>*  which lazy load result as needed. The row format is determined by *rowFormat* parameter.\r\n   * See [ECSQL row format]($docs/learning/ECSQLRowFormat) for details about the format of the returned rows.\r\n   * @throws [IModelError]($common) If there was any error while submitting, preparing or stepping into query\r\n   * @deprecated in 3.7. Use [[createQueryReader]] instead; it accepts the same parameters.\r\n   */\r\n  public async * query(ecsql: string, params?: QueryBinder, options?: QueryOptions): AsyncIterableIterator<any> {\r\n    const builder = new QueryOptionsBuilder(options);\r\n    const reader = this.createQueryReader(ecsql, params, builder.getOptions());\r\n    while (await reader.step())\r\n      yield reader.formatCurrentRow();\r\n  }\r\n  /** Compute number of rows that would be returned by the ECSQL.\r\n   *\r\n   * See also:\r\n   * - [ECSQL Overview]($docs/learning/backend/ExecutingECSQL)\r\n   * - [Code Examples]($docs/learning/backend/ECSQLCodeExamples)\r\n   *\r\n   * @param ecsql The ECSQL statement to execute\r\n   * @param params The values to bind to the parameters (if the ECSQL has any).\r\n   * See \"[iTwin.js Types used in ECSQL Parameter Bindings]($docs/learning/ECSQLParameterTypes)\" for details.\r\n   * @returns Return row count.\r\n   * @throws [IModelError]($common) If the statement is invalid\r\n   * @deprecated in 3.7. Count the number of results using `count(*)` where the original query is a subquery instead. E.g., `SELECT count(*) FROM (<query-whose-rows-to-count>)`.\r\n   */\r\n  public async queryRowCount(ecsql: string, params?: QueryBinder): Promise<number> {\r\n    for await (const row of this.createQueryReader(`SELECT count(*) FROM (${ecsql})`, params)) {\r\n      return row[0] as number;\r\n    }\r\n    throw new IModelError(DbResult.BE_SQLITE_ERROR, \"Failed to get row count\");\r\n  }\r\n\r\n  /** Cancel any previous query with same token and run execute the current specified query.\r\n   * The result of the query is async iterator over the rows. The iterator will get next page automatically once rows in current page has been read.\r\n   * [ECSQL row]($docs/learning/ECSQLRowFormat).\r\n   *\r\n   * See also:\r\n   * - [ECSQL Overview]($docs/learning/backend/ExecutingECSQL)\r\n   * - [Code Examples]($docs/learning/backend/ECSQLCodeExamples)\r\n   *\r\n   * @param ecsql The ECSQL statement to execute\r\n   * @param token None empty restart token. The previous query with same token would be cancelled. This would cause\r\n   * exception which user code must handle.\r\n   * @param params The values to bind to the parameters (if the ECSQL has any).\r\n   * @param options Allow to specify certain flags which control how query is executed.\r\n   * @returns Returns the query result as an *AsyncIterableIterator<any>*  which lazy load result as needed. The row format is determined by *rowFormat* parameter.\r\n   * See [ECSQL row format]($docs/learning/ECSQLRowFormat) for details about the format of the returned rows.\r\n   * @throws [IModelError]($common) If there was any error while submitting, preparing or stepping into query\r\n   * @deprecated in 3.7. Use [[createQueryReader]] instead. Pass in the restart token as part of the `config` argument; e.g., `{ restartToken: myToken }` or `new QueryOptionsBuilder().setRestartToken(myToken).getOptions()`.\r\n   */\r\n  public async * restartQuery(token: string, ecsql: string, params?: QueryBinder, options?: QueryOptions): AsyncIterableIterator<any> {\r\n    for await (const row of this.createQueryReader(ecsql, params, new QueryOptionsBuilder(options).setRestartToken(token).getOptions())) {\r\n      yield row;\r\n    }\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"ECDb.js","sourceRoot":"","sources":["../../src/ECDb.ts"],"names":[],"mappings":";;;AAAA;;;+FAG+F;AAC/F;;GAEG;AACH,sDAAyE;AAEzE,oDAAwH;AACxH,mEAAgE;AAChE,uDAAoD;AACpD,qDAAuE;AACvE,8DAAyD;AACzD,uDAAoE;AACpE,gDAA+C;AAE/C,MAAM,cAAc,GAAW,6CAAqB,CAAC,IAAI,CAAC;AAE1D;;GAEG;AACH,IAAY,YAKX;AALD,WAAY,YAAY;IACtB,uDAAQ,CAAA;IACR,yDAAS,CAAA;IACT,sGAAsG;IACtG,6DAAW,CAAA;AACb,CAAC,EALW,YAAY,4BAAZ,YAAY,QAKvB;AAED;;GAEG;AACH,MAAa,IAAI;IACP,SAAS,CAAuB;IACxC,4DAA4D;IAC3C,eAAe,GAAG,IAAI,gCAAc,EAAkB,CAAC;IAChE,qBAAqB,GAAG,IAAI,gCAAc,EAAmB,CAAC;IAEtE;;OAEG;IACI,gBAAgB,CAAC,IAAY;QAClC,IAAI,CAAC,qBAAqB,CAAC,KAAK,EAAE,CAAC;QACnC,IAAI,CAAC,qBAAqB,GAAG,IAAI,gCAAc,CAAkB,IAAI,CAAC,CAAC;IACzE,CAAC;IAED;QACE,IAAI,CAAC,SAAS,GAAG,IAAI,6BAAY,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC;IACpD,CAAC;IACD;;OAEG;IACI,CAAC,MAAM,CAAC,OAAO,CAAC;QACrB,IAAI,CAAC,IAAI,CAAC,SAAS;YACjB,OAAO;QAET,IAAI,CAAC,OAAO,EAAE,CAAC;QACf,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,CAAC;QACzB,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;IAC7B,CAAC;IACD;;;;;OAKG;IACI,QAAQ,CAAC,QAAgB,EAAE,KAAa;QAC7C,IAAI,KAAK,CAAC,WAAW,EAAE,KAAK,MAAM,IAAI,KAAK,CAAC,WAAW,EAAE,KAAK,gBAAgB,IAAI,KAAK,CAAC,WAAW,EAAE,KAAK,UAAU,IAAI,KAAK,CAAC,WAAW,EAAE,KAAK,MAAM,EAAE,CAAC;YACvJ,MAAM,IAAI,yBAAW,CAAC,uBAAQ,CAAC,eAAe,EAAE,yCAAyC,CAAC,CAAC;QAC7F,CAAC;QACD,IAAI,CAAC,mBAAS,CAAC,CAAC,QAAQ,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;IAC5C,CAAC;IACD;;;;OAIG;IACI,QAAQ,CAAC,KAAa;QAC3B,IAAI,KAAK,CAAC,WAAW,EAAE,KAAK,MAAM,IAAI,KAAK,CAAC,WAAW,EAAE,KAAK,gBAAgB,IAAI,KAAK,CAAC,WAAW,EAAE,KAAK,UAAU,IAAI,KAAK,CAAC,WAAW,EAAE,KAAK,MAAM,EAAE,CAAC;YACvJ,MAAM,IAAI,yBAAW,CAAC,uBAAQ,CAAC,eAAe,EAAE,yCAAyC,CAAC,CAAC;QAC7F,CAAC;QACD,IAAI,CAAC,mBAAmB,EAAE,CAAC;QAC3B,IAAI,CAAC,mBAAS,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;IAClC,CAAC;IAED,uDAAuD;IAChD,OAAO;QACZ,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC;IACzB,CAAC;IAED;;;OAGG;IACI,QAAQ,CAAC,QAAgB;QAC9B,MAAM,MAAM,GAAa,IAAI,CAAC,mBAAS,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;QAC5D,IAAI,MAAM,KAAK,uBAAQ,CAAC,YAAY;YAClC,MAAM,IAAI,yBAAW,CAAC,MAAM,EAAE,wBAAwB,CAAC,CAAC;IAC5D,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,QAAgB,EAAE,WAAyB,YAAY,CAAC,QAAQ;QAC5E,MAAM,cAAc,GAAa,QAAQ,KAAK,YAAY,CAAC,QAAQ,CAAC,CAAC,CAAC,uBAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC,uBAAQ,CAAC,SAAS,CAAC;QAC7G,MAAM,UAAU,GAAY,QAAQ,KAAK,YAAY,CAAC,WAAW,CAAC;QAClE,MAAM,MAAM,GAAa,IAAI,CAAC,mBAAS,CAAC,CAAC,MAAM,CAAC,QAAQ,EAAE,cAAc,EAAE,UAAU,CAAC,CAAC;QACtF,IAAI,MAAM,KAAK,uBAAQ,CAAC,YAAY;YAClC,MAAM,IAAI,yBAAW,CAAC,MAAM,EAAE,qBAAqB,CAAC,CAAC;IACzD,CAAC;IAED,uCAAuC;IACvC,IAAW,MAAM,KAAc,OAAO,IAAI,CAAC,mBAAS,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;IAEjE;;OAEG;IACI,OAAO;QACZ,IAAI,CAAC,eAAe,CAAC,KAAK,EAAE,CAAC;QAC7B,IAAI,CAAC,qBAAqB,CAAC,KAAK,EAAE,CAAC;QACnC,IAAI,CAAC,mBAAS,CAAC,CAAC,OAAO,EAAE,CAAC;IAC5B,CAAC;IAED,8CAA8C;IACvC,mBAAmB;QACxB,IAAI,CAAC,eAAe,CAAC,KAAK,EAAE,CAAC;IAC/B,CAAC;IAED,8CAA8C;IACvC,uBAAuB;QAC5B,OAAO,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC;IACnC,CAAC;IAED;;;OAGG;IACI,WAAW,CAAC,aAAsB;QACvC,MAAM,MAAM,GAAa,IAAI,CAAC,mBAAS,CAAC,CAAC,WAAW,CAAC,aAAa,CAAC,CAAC;QACpE,IAAI,MAAM,KAAK,uBAAQ,CAAC,YAAY;YAClC,MAAM,IAAI,yBAAW,CAAC,MAAM,EAAE,wBAAwB,CAAC,CAAC;IAC5D,CAAC;IAED;;OAEG;IACI,cAAc;QACnB,MAAM,MAAM,GAAa,IAAI,CAAC,mBAAS,CAAC,CAAC,cAAc,EAAE,CAAC;QAC1D,IAAI,MAAM,KAAK,uBAAQ,CAAC,YAAY;YAClC,MAAM,IAAI,yBAAW,CAAC,MAAM,EAAE,2BAA2B,CAAC,CAAC;IAC/D,CAAC;IAED;;;;;OAKG;IACI,YAAY,CAAC,QAAgB;QAClC,MAAM,MAAM,GAAa,IAAI,CAAC,mBAAS,CAAC,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;QAChE,IAAI,MAAM,KAAK,uBAAQ,CAAC,YAAY,EAAE,CAAC;YACrC,qBAAM,CAAC,QAAQ,CAAC,cAAc,EAAE,iCAAiC,QAAQ,IAAI,CAAC,CAAC;YAC/E,MAAM,IAAI,yBAAW,CAAC,MAAM,EAAE,iCAAiC,QAAQ,IAAI,CAAC,CAAC;QAC/E,CAAC;IACH,CAAC;IAED;;;;;OAKG;IACI,cAAc,CAAC,IAAY;QAChC,OAAO,IAAI,CAAC,mBAAS,CAAC,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;IAC9C,CAAC;IAED;;;;;;;;;;;;OAYG;IACI,wBAAwB,CAAI,KAAa,EAAE,QAA0C,EAAE,SAAS,GAAG,IAAI;QAC5G,4DAA4D;QAC5D,MAAM,IAAI,GAAG,IAAI,CAAC,eAAe,CAAC,aAAa,CAAC,KAAK,CAAC,IAAI,IAAI,CAAC,gBAAgB,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;QAClG,MAAM,OAAO,GAAG,GAAG,EAAE,CAAC,IAAI,CAAC,eAAe,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;QAC9D,IAAI,CAAC;YACH,MAAM,GAAG,GAAG,QAAQ,CAAC,IAAI,oCAAmB,CAAC,IAAI,CAAC,CAAC,CAAC;YACpD,IAAI,GAAG,YAAY,OAAO,EAAE,CAAC;gBAC3B,GAAG,CAAC,IAAI,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;YAC7B,CAAC;iBAAM,CAAC;gBACN,OAAO,EAAE,CAAC;YACZ,CAAC;YACD,OAAO,GAAG,CAAC;QACb,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,OAAO,EAAE,CAAC;YACV,MAAM,GAAG,CAAC;QACZ,CAAC;IACH,CAAC;IAED;;;;;;;;;;OAUG;IACI,kBAAkB,CAAI,KAAa,EAAE,QAA0C,EAAE,SAAS,GAAG,IAAI;QACtG,MAAM,IAAI,GAAG,IAAI,CAAC,qBAAqB,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;QAC1D,MAAM,OAAO,GAAG,GAAG,EAAE,GAAG,CAAC,CAAC;QAC1B,IAAI,CAAC;YACH,MAAM,GAAG,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC;YAC3B,IAAI,GAAG,YAAY,OAAO,EAAE,CAAC;gBAC3B,GAAG,CAAC,IAAI,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;YAC7B,CAAC;iBAAM,CAAC;gBACN,OAAO,EAAE,CAAC;YACZ,CAAC;YACD,OAAO,GAAG,CAAC;QACb,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,OAAO,EAAE,CAAC;YACV,MAAM,GAAG,CAAC;QACZ,CAAC;IACH,CAAC;IAED;;;;;MAKE;IACK,qBAAqB,CAAC,KAAa,EAAE,SAAS,GAAG,IAAI;QAC1D,4DAA4D;QAC5D,OAAO,IAAI,oCAAmB,CAAC,IAAI,CAAC,gBAAgB,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC,CAAC;IAC1E,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,4DAA4D;IACrD,qBAAqB,CAAI,KAAa,EAAE,QAAqC,EAAE,SAAS,GAAG,IAAI;QACpG,4DAA4D;QAC5D,MAAM,IAAI,GAAG,IAAI,CAAC,eAAe,CAAC,aAAa,CAAC,KAAK,CAAC,IAAI,IAAI,CAAC,gBAAgB,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;QAClG,MAAM,OAAO,GAAG,GAAG,EAAE,CAAC,IAAI,CAAC,eAAe,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;QAC9D,IAAI,CAAC;YACH,MAAM,GAAG,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC;YAC3B,IAAI,GAAG,YAAY,OAAO,EAAE,CAAC;gBAC3B,GAAG,CAAC,IAAI,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;YAC7B,CAAC;iBAAM,CAAC;gBACN,OAAO,EAAE,CAAC;YACZ,CAAC;YACD,OAAO,GAAG,CAAC;QACb,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,OAAO,EAAE,CAAC;YACV,MAAM,GAAG,CAAC;QACZ,CAAC;IACH,CAAC;IAED;;;;;;;;;;;OAWG;IACH,4DAA4D;IACrD,aAAa,CAAI,KAAa,EAAE,QAAqC,EAAE,SAAS,GAAG,IAAI;QAC5F,4DAA4D;QAC5D,MAAM,IAAI,GAAG,IAAI,CAAC,gBAAgB,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;QACrD,MAAM,OAAO,GAAG,GAAG,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC;QAC7C,IAAI,CAAC;YACH,MAAM,GAAG,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC;YAC3B,IAAI,GAAG,YAAY,OAAO,EAAE,CAAC;gBAC3B,GAAG,CAAC,IAAI,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;YAC7B,CAAC;iBAAM,CAAC;gBACN,OAAO,EAAE,CAAC;YACZ,CAAC;YACD,OAAO,GAAG,CAAC;QACb,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,OAAO,EAAE,CAAC;YACV,MAAM,GAAG,CAAC;QACZ,CAAC;IACH,CAAC;IAED;;;;;OAKG;IACH,4DAA4D;IACrD,gBAAgB,CAAC,KAAa,EAAE,SAAS,GAAG,IAAI;QACrD,4DAA4D;QAC5D,MAAM,IAAI,GAAG,IAAI,+BAAc,EAAE,CAAC;QAClC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,mBAAS,CAAC,EAAE,KAAK,EAAE,SAAS,CAAC,CAAC;QAChD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;;OAYG;IACI,2BAA2B,CAAI,GAAW,EAAE,QAAsC,EAAE,SAAS,GAAG,IAAI;QACzG,MAAM,IAAI,GAAG,IAAI,CAAC,qBAAqB,CAAC,aAAa,CAAC,GAAG,CAAC,IAAI,IAAI,CAAC,sBAAsB,CAAC,GAAG,EAAE,SAAS,CAAC,CAAC;QAC1G,MAAM,OAAO,GAAG,GAAG,EAAE,CAAC,IAAI,CAAC,qBAAqB,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;QACpE,IAAI,CAAC;YACH,MAAM,GAAG,GAAM,QAAQ,CAAC,IAAI,CAAC,CAAC;YAC9B,IAAI,GAAG,YAAY,OAAO,EAAE,CAAC;gBAC3B,GAAG,CAAC,IAAI,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;YAC7B,CAAC;iBAAM,CAAC;gBACN,OAAO,EAAE,CAAC;YACZ,CAAC;YACD,OAAO,GAAG,CAAC;QACb,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,OAAO,EAAE,CAAC;YACV,MAAM,GAAG,CAAC;QACZ,CAAC;IACH,CAAC;IAED;;;;;;;;;OASG;IACI,mBAAmB,CAAI,GAAW,EAAE,QAAsC,EAAE,SAAS,GAAG,IAAI;QACjG,MAAM,IAAI,GAAG,IAAI,CAAC,sBAAsB,CAAC,GAAG,EAAE,SAAS,CAAC,CAAC;QACzD,MAAM,OAAO,GAAG,GAAG,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC;QAC7C,IAAI,CAAC;YACH,MAAM,GAAG,GAAM,QAAQ,CAAC,IAAI,CAAC,CAAC;YAC9B,IAAI,GAAG,YAAY,OAAO,EAAE,CAAC;gBAC3B,GAAG,CAAC,IAAI,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;YAC7B,CAAC;iBAAM,CAAC;gBACN,OAAO,EAAE,CAAC;YACZ,CAAC;YACD,OAAO,GAAG,CAAC;QACb,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,OAAO,EAAE,CAAC;YACV,MAAM,GAAG,CAAC;QACZ,CAAC;IACH,CAAC;IAED;;;;;OAKG;IACI,sBAAsB,CAAC,GAAW,EAAE,SAAS,GAAG,IAAI;QACzD,MAAM,IAAI,GAAG,IAAI,iCAAe,CAAC,GAAG,CAAC,CAAC;QACtC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,mBAAS,CAAC,EAAE,SAAS,CAAC,CAAC;QACzC,OAAO,IAAI,CAAC;IACd,CAAC;IAED,gBAAgB;IAChB,IAAW,CAAC,mBAAS,CAAC;QACpB,IAAA,qBAAM,EAAC,SAAS,KAAK,IAAI,CAAC,SAAS,CAAC,CAAC;QACrC,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;IAED;;;;;;;;;;;SAWK;IACE,iBAAiB,CAAC,KAAa,EAAE,MAAoB,EAAE,MAAqB;QACjF,IAAI,CAAC,IAAI,CAAC,SAAS,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,EAAE,CAAC;YAChD,MAAM,IAAI,yBAAW,CAAC,uBAAQ,CAAC,eAAe,EAAE,aAAa,CAAC,CAAC;QACjE,CAAC;QACD,MAAM,QAAQ,GAAG;YACf,OAAO,EAAE,KAAK,EAAE,OAAuB,EAAE,EAAE;gBACzC,OAAO,iCAAe,CAAC,mBAAmB,CAAC,IAAI,CAAC,mBAAS,CAAC,EAAE,OAAO,CAAC,CAAC;YACvE,CAAC;SACF,CAAC;QACF,OAAO,IAAI,yBAAW,CAAC,QAAQ,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;IAC1D,CAAC;CACF;AAxYD,oBAwYC","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 ECDb\r\n */\r\nimport { assert, DbResult, Logger, OpenMode } from \"@itwin/core-bentley\";\r\nimport { IModelJsNative } from \"@bentley/imodeljs-native\";\r\nimport { DbQueryRequest, ECSchemaProps, ECSqlReader, IModelError, QueryBinder, QueryOptions } from \"@itwin/core-common\";\r\nimport { BackendLoggerCategory } from \"./BackendLoggerCategory\";\r\nimport { ConcurrentQuery } from \"./ConcurrentQuery\";\r\nimport { ECSqlStatement, ECSqlWriteStatement } from \"./ECSqlStatement\";\r\nimport { IModelNative } from \"./internal/NativePlatform\";\r\nimport { SqliteStatement, StatementCache } from \"./SqliteStatement\";\r\nimport { _nativeDb } from \"./internal/Symbols\";\r\n\r\nconst loggerCategory: string = BackendLoggerCategory.ECDb;\r\n\r\n/** Modes for how to open [ECDb]($backend) files.\r\n * @public\r\n */\r\nexport enum ECDbOpenMode {\r\n  Readonly,\r\n  ReadWrite,\r\n  /** Opens the file read-write and upgrades the file if necessary to the latest file format version. */\r\n  FileUpgrade,\r\n}\r\n\r\n/** An ECDb file\r\n * @public\r\n */\r\nexport class ECDb implements Disposable {\r\n  private _nativeDb?: IModelJsNative.ECDb;\r\n  // eslint-disable-next-line @typescript-eslint/no-deprecated\r\n  private readonly _statementCache = new StatementCache<ECSqlStatement>();\r\n  private _sqliteStatementCache = new StatementCache<SqliteStatement>();\r\n\r\n  /** only for tests\r\n   * @internal\r\n   */\r\n  public resetSqliteCache(size: number) {\r\n    this._sqliteStatementCache.clear();\r\n    this._sqliteStatementCache = new StatementCache<SqliteStatement>(size);\r\n  }\r\n\r\n  constructor() {\r\n    this._nativeDb = new IModelNative.platform.ECDb();\r\n  }\r\n  /** Call this function when finished with this ECDb object. This releases the native resources held by the\r\n   *  ECDb object.\r\n   */\r\n  public [Symbol.dispose](): void {\r\n    if (!this._nativeDb)\r\n      return;\r\n\r\n    this.closeDb();\r\n    this._nativeDb.dispose();\r\n    this._nativeDb = undefined;\r\n  }\r\n  /**\r\n   * Attach an iModel file to this connection and load and register its schemas.\r\n   * @note There are some reserve tablespace names that cannot be used. They are 'main', 'schema_sync_db', 'ecchange' & 'temp'\r\n   * @param fileName IModel file name\r\n   * @param alias identifier for the attached file. This identifer is used to access schema from the attached file. e.g. if alias is 'abc' then schema can be accessed using 'abc.MySchema.MyClass'\r\n   */\r\n  public attachDb(fileName: string, alias: string): void {\r\n    if (alias.toLowerCase() === \"main\" || alias.toLowerCase() === \"schema_sync_db\" || alias.toLowerCase() === \"ecchange\" || alias.toLowerCase() === \"temp\") {\r\n      throw new IModelError(DbResult.BE_SQLITE_ERROR, \"Reserved tablespace name cannot be used\");\r\n    }\r\n    this[_nativeDb].attachDb(fileName, alias);\r\n  }\r\n  /**\r\n   * Detach the attached file from this connection. The attached file is closed and its schemas are unregistered.\r\n   * @note There are some reserve tablespace names that cannot be used. They are 'main', 'schema_sync_db', 'ecchange' & 'temp'\r\n   * @param alias identifer that was used in the call to [[attachDb]]\r\n   */\r\n  public detachDb(alias: string): void {\r\n    if (alias.toLowerCase() === \"main\" || alias.toLowerCase() === \"schema_sync_db\" || alias.toLowerCase() === \"ecchange\" || alias.toLowerCase() === \"temp\") {\r\n      throw new IModelError(DbResult.BE_SQLITE_ERROR, \"Reserved tablespace name cannot be used\");\r\n    }\r\n    this.clearStatementCache();\r\n    this[_nativeDb].detachDb(alias);\r\n  }\r\n\r\n  /** @deprecated in 5.0 Use [Symbol.dispose] instead. */\r\n  public dispose(): void {\r\n    this[Symbol.dispose]();\r\n  }\r\n\r\n  /** Create an ECDb\r\n   * @param pathName The path to the ECDb file to create.\r\n   * @throws [IModelError]($common) if the operation failed.\r\n   */\r\n  public createDb(pathName: string): void {\r\n    const status: DbResult = this[_nativeDb].createDb(pathName);\r\n    if (status !== DbResult.BE_SQLITE_OK)\r\n      throw new IModelError(status, \"Failed to created ECDb\");\r\n  }\r\n\r\n  /** Open the ECDb.\r\n   * @param pathName The path to the ECDb file to open\r\n   * @param openMode Open mode\r\n   * @throws [IModelError]($common) if the operation failed.\r\n   */\r\n  public openDb(pathName: string, openMode: ECDbOpenMode = ECDbOpenMode.Readonly): void {\r\n    const nativeOpenMode: OpenMode = openMode === ECDbOpenMode.Readonly ? OpenMode.Readonly : OpenMode.ReadWrite;\r\n    const tryUpgrade: boolean = openMode === ECDbOpenMode.FileUpgrade;\r\n    const status: DbResult = this[_nativeDb].openDb(pathName, nativeOpenMode, tryUpgrade);\r\n    if (status !== DbResult.BE_SQLITE_OK)\r\n      throw new IModelError(status, \"Failed to open ECDb\");\r\n  }\r\n\r\n  /** Returns true if the ECDb is open */\r\n  public get isOpen(): boolean { return this[_nativeDb].isOpen(); }\r\n\r\n  /** Close the Db after saving any uncommitted changes.\r\n   * @throws [IModelError]($common) if the database is not open.\r\n   */\r\n  public closeDb(): void {\r\n    this._statementCache.clear();\r\n    this._sqliteStatementCache.clear();\r\n    this[_nativeDb].closeDb();\r\n  }\r\n\r\n  /** @internal use to test statement caching */\r\n  public clearStatementCache() {\r\n    this._statementCache.clear();\r\n  }\r\n\r\n  /** @internal use to test statement caching */\r\n  public getCachedStatementCount() {\r\n    return this._statementCache.size;\r\n  }\r\n\r\n  /** Commit the outermost transaction, writing changes to the file. Then, restart the transaction.\r\n   * @param changesetName The name of the operation that generated these changes.\r\n   * @throws [IModelError]($common) if the database is not open or if the operation failed.\r\n   */\r\n  public saveChanges(changesetName?: string): void {\r\n    const status: DbResult = this[_nativeDb].saveChanges(changesetName);\r\n    if (status !== DbResult.BE_SQLITE_OK)\r\n      throw new IModelError(status, \"Failed to save changes\");\r\n  }\r\n\r\n  /** Abandon (cancel) the outermost transaction, discarding all changes since last save. Then, restart the transaction.\r\n   * @throws [IModelError]($common) if the database is not open or if the operation failed.\r\n   */\r\n  public abandonChanges(): void {\r\n    const status: DbResult = this[_nativeDb].abandonChanges();\r\n    if (status !== DbResult.BE_SQLITE_OK)\r\n      throw new IModelError(status, \"Failed to abandon changes\");\r\n  }\r\n\r\n  /** Import a schema.\r\n   *\r\n   * If the import was successful, the database is automatically saved to disk.\r\n   * @param pathName Path to ECSchema XML file to import.\r\n   * @throws [IModelError]($common) if the database is not open or if the operation failed.\r\n   */\r\n  public importSchema(pathName: string): void {\r\n    const status: DbResult = this[_nativeDb].importSchema(pathName);\r\n    if (status !== DbResult.BE_SQLITE_OK) {\r\n      Logger.logError(loggerCategory, `Failed to import schema from '${pathName}'.`);\r\n      throw new IModelError(status, `Failed to import schema from '${pathName}'.`);\r\n    }\r\n  }\r\n\r\n  /**\r\n   * Returns the full schema for the input name.\r\n   * @param name The name of the schema e.g. 'ECDbMeta'\r\n   * @returns The SchemaProps for the requested schema\r\n   * @throws if the schema can not be found or loaded.\r\n   */\r\n  public getSchemaProps(name: string): ECSchemaProps {\r\n    return this[_nativeDb].getSchemaProps(name);\r\n  }\r\n\r\n  /**\r\n   * Use a prepared ECSQL statement, potentially from the statement cache. If the requested statement doesn't exist\r\n   * in the statement cache, a new statement is prepared. After the callback completes, the statement is reset and saved\r\n   * in the statement cache so it can be reused in the future. Use this method for ECSQL statements that will be\r\n   * reused often and are expensive to prepare. The statement cache holds the most recently used statements, discarding\r\n   * the oldest statements as it fills. For statements you don't intend to reuse, instead use [[withStatement]].\r\n   * @param sql The SQLite SQL statement to execute\r\n   * @param callback the callback to invoke on the prepared statement\r\n   * @param logErrors Determines if error will be logged if statement fail to prepare\r\n   * @returns the value returned by `callback`.\r\n   * @see [[withWriteStatement]]\r\n   * @beta\r\n   */\r\n  public withCachedWriteStatement<T>(ecsql: string, callback: (stmt: ECSqlWriteStatement) => T, logErrors = true): T {\r\n    // eslint-disable-next-line @typescript-eslint/no-deprecated\r\n    const stmt = this._statementCache.findAndRemove(ecsql) ?? this.prepareStatement(ecsql, logErrors);\r\n    const release = () => this._statementCache.addOrDispose(stmt);\r\n    try {\r\n      const val = callback(new ECSqlWriteStatement(stmt));\r\n      if (val instanceof Promise) {\r\n        val.then(release, release);\r\n      } else {\r\n        release();\r\n      }\r\n      return val;\r\n    } catch (err) {\r\n      release();\r\n      throw err;\r\n    }\r\n  }\r\n\r\n  /**\r\n   * Prepared and execute a callback on an ECSQL statement. After the callback completes the statement is disposed.\r\n   * Use this method for ECSQL statements are either not expected to be reused, or are not expensive to prepare.\r\n   * For statements that will be reused often, instead use [[withPreparedStatement]].\r\n   * @param sql The SQLite SQL statement to execute\r\n   * @param callback the callback to invoke on the prepared statement\r\n   * @param logErrors Determines if error will be logged if statement fail to prepare\r\n   * @returns the value returned by `callback`.\r\n   * @see [[withCachedWriteStatement]]\r\n   * @beta\r\n   */\r\n  public withWriteStatement<T>(ecsql: string, callback: (stmt: ECSqlWriteStatement) => T, logErrors = true): T {\r\n    const stmt = this.prepareWriteStatement(ecsql, logErrors);\r\n    const release = () => { };\r\n    try {\r\n      const val = callback(stmt);\r\n      if (val instanceof Promise) {\r\n        val.then(release, release);\r\n      } else {\r\n        release();\r\n      }\r\n      return val;\r\n    } catch (err) {\r\n      release();\r\n      throw err;\r\n    }\r\n  }\r\n\r\n  /** Prepare an ECSQL statement.\r\n  * @param ecsql The ECSQL statement to prepare\r\n  * @param logErrors Determines if error will be logged if statement fail to prepare\r\n  * @throws [IModelError]($common) if there is a problem preparing the statement.\r\n  * @beta\r\n  */\r\n  public prepareWriteStatement(ecsql: string, logErrors = true): ECSqlWriteStatement {\r\n    // eslint-disable-next-line @typescript-eslint/no-deprecated\r\n    return new ECSqlWriteStatement(this.prepareStatement(ecsql, logErrors));\r\n  }\r\n\r\n  /**\r\n   * Use a prepared ECSQL statement, potentially from the statement cache. If the requested statement doesn't exist\r\n   * in the statement cache, a new statement is prepared. After the callback completes, the statement is reset and saved\r\n   * in the statement cache so it can be reused in the future. Use this method for ECSQL statements that will be\r\n   * reused often and are expensive to prepare. The statement cache holds the most recently used statements, discarding\r\n   * the oldest statements as it fills. For statements you don't intend to reuse, instead use [[withStatement]].\r\n   * @param sql The SQLite SQL statement to execute\r\n   * @param callback the callback to invoke on the prepared statement\r\n   * @param logErrors Determines if error will be logged if statement fail to prepare\r\n   * @returns the value returned by `callback`.\r\n   * @see [[withStatement]]\r\n   * @public\r\n   * @deprecated in 4.11.  Use [[createQueryReader]] for SELECT statements and [[withCachedWriteStatement]] for INSERT/UPDATE/DELETE instead.\r\n   */\r\n  // eslint-disable-next-line @typescript-eslint/no-deprecated\r\n  public withPreparedStatement<T>(ecsql: string, callback: (stmt: ECSqlStatement) => T, logErrors = true): T {\r\n    // eslint-disable-next-line @typescript-eslint/no-deprecated\r\n    const stmt = this._statementCache.findAndRemove(ecsql) ?? this.prepareStatement(ecsql, logErrors);\r\n    const release = () => this._statementCache.addOrDispose(stmt);\r\n    try {\r\n      const val = callback(stmt);\r\n      if (val instanceof Promise) {\r\n        val.then(release, release);\r\n      } else {\r\n        release();\r\n      }\r\n      return val;\r\n    } catch (err) {\r\n      release();\r\n      throw err;\r\n    }\r\n  }\r\n\r\n  /**\r\n   * Prepared and execute a callback on an ECSQL statement. After the callback completes the statement is disposed.\r\n   * Use this method for ECSQL statements are either not expected to be reused, or are not expensive to prepare.\r\n   * For statements that will be reused often, instead use [[withPreparedStatement]].\r\n   * @param sql The SQLite SQL statement to execute\r\n   * @param callback the callback to invoke on the prepared statement\r\n   * @param logErrors Determines if error will be logged if statement fail to prepare\r\n   * @returns the value returned by `callback`.\r\n   * @see [[withPreparedStatement]]\r\n   * @public\r\n   * @deprecated in 4.11.  Use [[createQueryReader]] for SELECT statements and [[withWriteStatement]] for INSERT/UPDATE/DELETE instead.\r\n   */\r\n  // eslint-disable-next-line @typescript-eslint/no-deprecated\r\n  public withStatement<T>(ecsql: string, callback: (stmt: ECSqlStatement) => T, logErrors = true): T {\r\n    // eslint-disable-next-line @typescript-eslint/no-deprecated\r\n    const stmt = this.prepareStatement(ecsql, logErrors);\r\n    const release = () => stmt[Symbol.dispose]();\r\n    try {\r\n      const val = callback(stmt);\r\n      if (val instanceof Promise) {\r\n        val.then(release, release);\r\n      } else {\r\n        release();\r\n      }\r\n      return val;\r\n    } catch (err) {\r\n      release();\r\n      throw err;\r\n    }\r\n  }\r\n\r\n  /** Prepare an ECSQL statement.\r\n   * @param ecsql The ECSQL statement to prepare\r\n   * @param logErrors Determines if error will be logged if statement fail to prepare\r\n   * @throws [IModelError]($common) if there is a problem preparing the statement.\r\n   * @deprecated in 4.11.  Use [[prepareWriteStatement]] when preparing an INSERT/UPDATE/DELETE statement or [[createQueryReader]] to execute a SELECT statement.\r\n   */\r\n  // eslint-disable-next-line @typescript-eslint/no-deprecated\r\n  public prepareStatement(ecsql: string, logErrors = true): ECSqlStatement {\r\n    // eslint-disable-next-line @typescript-eslint/no-deprecated\r\n    const stmt = new ECSqlStatement();\r\n    stmt.prepare(this[_nativeDb], ecsql, logErrors);\r\n    return stmt;\r\n  }\r\n\r\n  /**\r\n   * Use a prepared SQL statement, potentially from the statement cache. If the requested statement doesn't exist\r\n   * in the statement cache, a new statement is prepared. After the callback completes, the statement is reset and saved\r\n   * in the statement cache so it can be reused in the future. Use this method for SQL statements that will be\r\n   * reused often and are expensive to prepare. The statement cache holds the most recently used statements, discarding\r\n   * the oldest statements as it fills. For statements you don't intend to reuse, instead use [[withSqliteStatement]].\r\n   * @param sql The SQLite SQL statement to execute\r\n   * @param callback the callback to invoke on the prepared statement\r\n   * @param logErrors Determines if error will be logged if statement fail to prepare\r\n   * @returns the value returned by `callback`.\r\n   * @see [[withPreparedStatement]]\r\n   * @public\r\n   */\r\n  public withPreparedSqliteStatement<T>(sql: string, callback: (stmt: SqliteStatement) => T, logErrors = true): T {\r\n    const stmt = this._sqliteStatementCache.findAndRemove(sql) ?? this.prepareSqliteStatement(sql, logErrors);\r\n    const release = () => this._sqliteStatementCache.addOrDispose(stmt);\r\n    try {\r\n      const val: T = callback(stmt);\r\n      if (val instanceof Promise) {\r\n        val.then(release, release);\r\n      } else {\r\n        release();\r\n      }\r\n      return val;\r\n    } catch (err) {\r\n      release();\r\n      throw err;\r\n    }\r\n  }\r\n\r\n  /**\r\n   * Prepared and execute a callback on a SQL statement. After the callback completes the statement is disposed.\r\n   * Use this method for SQL statements are either not expected to be reused, or are not expensive to prepare.\r\n   * For statements that will be reused often, instead use [[withPreparedSqliteStatement]].\r\n   * @param sql The SQLite SQL statement to execute\r\n   * @param callback the callback to invoke on the prepared statement\r\n   * @param logErrors Determines if error will be logged if statement fail to prepare\r\n   * @returns the value returned by `callback`.\r\n   * @public\r\n   */\r\n  public withSqliteStatement<T>(sql: string, callback: (stmt: SqliteStatement) => T, logErrors = true): T {\r\n    const stmt = this.prepareSqliteStatement(sql, logErrors);\r\n    const release = () => stmt[Symbol.dispose]();\r\n    try {\r\n      const val: T = callback(stmt);\r\n      if (val instanceof Promise) {\r\n        val.then(release, release);\r\n      } else {\r\n        release();\r\n      }\r\n      return val;\r\n    } catch (err) {\r\n      release();\r\n      throw err;\r\n    }\r\n  }\r\n\r\n  /** Prepare an SQL statement.\r\n   * @param sql The SQLite SQL statement to prepare\r\n   * @param logErrors Determines if error will be logged if statement fail to prepare\r\n   * @throws [IModelError]($common) if there is a problem preparing the statement.\r\n   * @internal\r\n   */\r\n  public prepareSqliteStatement(sql: string, logErrors = true): SqliteStatement {\r\n    const stmt = new SqliteStatement(sql);\r\n    stmt.prepare(this[_nativeDb], logErrors);\r\n    return stmt;\r\n  }\r\n\r\n  /** @internal */\r\n  public get [_nativeDb](): IModelJsNative.ECDb {\r\n    assert(undefined !== this._nativeDb);\r\n    return this._nativeDb;\r\n  }\r\n\r\n  /** Allow to execute query and read results along with meta data. The result are streamed.\r\n   *\r\n   * See also:\r\n   * - [ECSQL Overview]($docs/learning/backend/ExecutingECSQL)\r\n   * - [Code Examples]($docs/learning/backend/ECSQLCodeExamples)\r\n   * - [ECSQL Row Format]($docs/learning/ECSQLRowFormat)\r\n   *\r\n   * @param params The values to bind to the parameters (if the ECSQL has any).\r\n   * @param config Allow to specify certain flags which control how query is executed.\r\n   * @returns Returns an [ECSqlReader]($common) which helps iterate over the result set and also give access to metadata.\r\n   * @public\r\n   * */\r\n  public createQueryReader(ecsql: string, params?: QueryBinder, config?: QueryOptions): ECSqlReader {\r\n    if (!this._nativeDb || !this._nativeDb.isOpen()) {\r\n      throw new IModelError(DbResult.BE_SQLITE_ERROR, \"db not open\");\r\n    }\r\n    const executor = {\r\n      execute: async (request: DbQueryRequest) => {\r\n        return ConcurrentQuery.executeQueryRequest(this[_nativeDb], request);\r\n      },\r\n    };\r\n    return new ECSqlReader(executor, ecsql, params, config);\r\n  }\r\n}\r\n"]}

package/lib/cjs/ECSchemaXmlContext.js

@@ -20,6 +20,7 @@ const NativePlatform_1 = require("./internal/NativePlatform");
  * @beta
  */
 class ECSchemaXmlContext {
+    _nativeContext;
     /** Construct a context with an empty list of search paths. */
     constructor() {
         this._nativeContext = new NativePlatform_1.IModelNative.platform.ECSchemaXmlContext();

package/lib/cjs/ECSchemaXmlContext.js.map

@@ -1 +1 @@
-{"version":3,"file":"ECSchemaXmlContext.js","sourceRoot":"","sources":["../../src/ECSchemaXmlContext.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAA6C;AAC7C,oDAAiD;AAEjD,8DAAyD;AAQzD;;;;;;;GAOG;AACH,MAAa,kBAAkB;IAG7B,8DAA8D;IAC9D;QACE,IAAI,CAAC,cAAc,GAAG,IAAI,6BAAY,CAAC,QAAQ,CAAC,kBAAkB,EAAE,CAAC;IACvE,CAAC;IAED,gBAAgB;IAChB,IAAW,aAAa;QACtB,IAAA,qBAAM,EAAC,SAAS,KAAK,IAAI,CAAC,cAAc,CAAC,CAAC;QAC1C,OAAO,IAAI,CAAC,cAAc,CAAC;IAC7B,CAAC;IAED;;;OAGG;IACI,aAAa,CAAC,UAAkB;QACrC,IAAI,CAAC,aAAa,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC;IAC/C,CAAC;IAED;;;OAGG;IACI,gBAAgB,CAAC,OAAgE;QACtF,IAAI,CAAC,aAAa,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IAC/C,CAAC;IAED;;;;OAIG;IACI,qBAAqB,CAAC,OAAgE;QAC3F,IAAI,CAAC,aAAa,CAAC,qBAAqB,CAAC,OAAO,CAAC,CAAC;IACpD,CAAC;IAED;;;;OAIG;IACI,qBAAqB,CAAC,QAAgB;QAC3C,MAAM,QAAQ,GAAG,IAAI,CAAC,aAAa,CAAC,qBAAqB,CAAC,QAAQ,CAAC,CAAC;QACpE,IAAI,QAAQ,CAAC,KAAK,EAAE,CAAC;YACnB,MAAM,IAAI,yBAAW,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,EAAE,QAAQ,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QACvE,CAAC;QAED,IAAA,qBAAM,EAAC,SAAS,KAAK,QAAQ,CAAC,MAAM,CAAC,CAAC;QACtC,OAAO,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;IACrC,CAAC;CACF;AArDD,gDAqDC","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 Schema\r\n */\r\n\r\nimport { assert } from \"@itwin/core-bentley\";\r\nimport { IModelError } from \"@itwin/core-common\";\r\nimport { IModelJsNative } from \"@bentley/imodeljs-native\";\r\nimport { IModelNative } from \"./internal/NativePlatform\";\r\n\r\n/** @internal */\r\nexport type SchemaKey = IModelJsNative.ECSchemaXmlContext.SchemaKey;\r\n\r\n/** @internal */\r\nexport type SchemaMatchType = IModelJsNative.ECSchemaXmlContext.SchemaMatchType;\r\n\r\n/** Context used when deserializing a [Schema]($ecschema-metadata) from an XML file.\r\n * A schema may contain references to other schemas, which may reside elsewhere on the local disk than the referencing schema.\r\n * The context maintains a list of directories (\"search paths\") to search for referenced schemas. Directories can be appended to the list via [[addSchemaPath]].\r\n * When a referenced schema needs to be located, the list of directories is searched in the order in which each was added.\r\n * Once located, the schema is cached to avoid performing repeated lookups in the file system.\r\n * @see [[readSchemaFromXmlFile]] to deserialize a schema.\r\n * @beta\r\n */\r\nexport class ECSchemaXmlContext {\r\n  private _nativeContext: IModelJsNative.ECSchemaXmlContext | undefined;\r\n\r\n  /** Construct a context with an empty list of search paths. */\r\n  constructor() {\r\n    this._nativeContext = new IModelNative.platform.ECSchemaXmlContext();\r\n  }\r\n\r\n  /** @internal */\r\n  public get nativeContext(): IModelJsNative.ECSchemaXmlContext {\r\n    assert(undefined !== this._nativeContext);\r\n    return this._nativeContext;\r\n  }\r\n\r\n  /** Append a directory to the list of directories that will be searched to locate referenced schemas.\r\n   * The directories are searched in the order in which they were added to the list.\r\n   * @param searchPath The absolute path to the directory to search.\r\n   */\r\n  public addSchemaPath(searchPath: string): void {\r\n    this.nativeContext.addSchemaPath(searchPath);\r\n  }\r\n\r\n  /** Set the last locater to be used when trying to find a schema\r\n   * @param locater Locater that should be used as the last locater when trying to find a schema\r\n   * @internal\r\n   */\r\n  public setSchemaLocater(locater: IModelJsNative.ECSchemaXmlContext.SchemaLocaterCallback): void {\r\n    this.nativeContext.setSchemaLocater(locater);\r\n  }\r\n\r\n  /** Adds a schema locator to the beginning of the list of locators used to search for schemas.\r\n   * This schema locator will be prioritized over other locators when searching for schemas in the current context.\r\n   * @param locater Locater to add to the current context\r\n   * @internal\r\n   */\r\n  public setFirstSchemaLocater(locater: IModelJsNative.ECSchemaXmlContext.SchemaLocaterCallback): void {\r\n    this.nativeContext.setFirstSchemaLocater(locater);\r\n  }\r\n\r\n  /** Deserialize a [Schema]($ecschema-metadata) from an ECSchemaXML-formatted file.\r\n   * @param filePath The absolute path of the XML file.\r\n   * @returns The JSON representation of the schema, as a [SchemaProps]($ecschema-metadata).\r\n   * @throws [[IModelError]] if there is a problem reading schema from the XML file\r\n   */\r\n  public readSchemaFromXmlFile(filePath: string): any {\r\n    const response = this.nativeContext.readSchemaFromXmlFile(filePath);\r\n    if (response.error) {\r\n      throw new IModelError(response.error.status, response.error.message);\r\n    }\r\n\r\n    assert(undefined !== response.result);\r\n    return JSON.parse(response.result);\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"ECSchemaXmlContext.js","sourceRoot":"","sources":["../../src/ECSchemaXmlContext.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAA6C;AAC7C,oDAAiD;AAEjD,8DAAyD;AAQzD;;;;;;;GAOG;AACH,MAAa,kBAAkB;IACrB,cAAc,CAAgD;IAEtE,8DAA8D;IAC9D;QACE,IAAI,CAAC,cAAc,GAAG,IAAI,6BAAY,CAAC,QAAQ,CAAC,kBAAkB,EAAE,CAAC;IACvE,CAAC;IAED,gBAAgB;IAChB,IAAW,aAAa;QACtB,IAAA,qBAAM,EAAC,SAAS,KAAK,IAAI,CAAC,cAAc,CAAC,CAAC;QAC1C,OAAO,IAAI,CAAC,cAAc,CAAC;IAC7B,CAAC;IAED;;;OAGG;IACI,aAAa,CAAC,UAAkB;QACrC,IAAI,CAAC,aAAa,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC;IAC/C,CAAC;IAED;;;OAGG;IACI,gBAAgB,CAAC,OAAgE;QACtF,IAAI,CAAC,aAAa,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IAC/C,CAAC;IAED;;;;OAIG;IACI,qBAAqB,CAAC,OAAgE;QAC3F,IAAI,CAAC,aAAa,CAAC,qBAAqB,CAAC,OAAO,CAAC,CAAC;IACpD,CAAC;IAED;;;;OAIG;IACI,qBAAqB,CAAC,QAAgB;QAC3C,MAAM,QAAQ,GAAG,IAAI,CAAC,aAAa,CAAC,qBAAqB,CAAC,QAAQ,CAAC,CAAC;QACpE,IAAI,QAAQ,CAAC,KAAK,EAAE,CAAC;YACnB,MAAM,IAAI,yBAAW,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,EAAE,QAAQ,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QACvE,CAAC;QAED,IAAA,qBAAM,EAAC,SAAS,KAAK,QAAQ,CAAC,MAAM,CAAC,CAAC;QACtC,OAAO,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;IACrC,CAAC;CACF;AArDD,gDAqDC","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 Schema\r\n */\r\n\r\nimport { assert } from \"@itwin/core-bentley\";\r\nimport { IModelError } from \"@itwin/core-common\";\r\nimport { IModelJsNative } from \"@bentley/imodeljs-native\";\r\nimport { IModelNative } from \"./internal/NativePlatform\";\r\n\r\n/** @internal */\r\nexport type SchemaKey = IModelJsNative.ECSchemaXmlContext.SchemaKey;\r\n\r\n/** @internal */\r\nexport type SchemaMatchType = IModelJsNative.ECSchemaXmlContext.SchemaMatchType;\r\n\r\n/** Context used when deserializing a [Schema]($ecschema-metadata) from an XML file.\r\n * A schema may contain references to other schemas, which may reside elsewhere on the local disk than the referencing schema.\r\n * The context maintains a list of directories (\"search paths\") to search for referenced schemas. Directories can be appended to the list via [[addSchemaPath]].\r\n * When a referenced schema needs to be located, the list of directories is searched in the order in which each was added.\r\n * Once located, the schema is cached to avoid performing repeated lookups in the file system.\r\n * @see [[readSchemaFromXmlFile]] to deserialize a schema.\r\n * @beta\r\n */\r\nexport class ECSchemaXmlContext {\r\n  private _nativeContext: IModelJsNative.ECSchemaXmlContext | undefined;\r\n\r\n  /** Construct a context with an empty list of search paths. */\r\n  constructor() {\r\n    this._nativeContext = new IModelNative.platform.ECSchemaXmlContext();\r\n  }\r\n\r\n  /** @internal */\r\n  public get nativeContext(): IModelJsNative.ECSchemaXmlContext {\r\n    assert(undefined !== this._nativeContext);\r\n    return this._nativeContext;\r\n  }\r\n\r\n  /** Append a directory to the list of directories that will be searched to locate referenced schemas.\r\n   * The directories are searched in the order in which they were added to the list.\r\n   * @param searchPath The absolute path to the directory to search.\r\n   */\r\n  public addSchemaPath(searchPath: string): void {\r\n    this.nativeContext.addSchemaPath(searchPath);\r\n  }\r\n\r\n  /** Set the last locater to be used when trying to find a schema\r\n   * @param locater Locater that should be used as the last locater when trying to find a schema\r\n   * @internal\r\n   */\r\n  public setSchemaLocater(locater: IModelJsNative.ECSchemaXmlContext.SchemaLocaterCallback): void {\r\n    this.nativeContext.setSchemaLocater(locater);\r\n  }\r\n\r\n  /** Adds a schema locator to the beginning of the list of locators used to search for schemas.\r\n   * This schema locator will be prioritized over other locators when searching for schemas in the current context.\r\n   * @param locater Locater to add to the current context\r\n   * @internal\r\n   */\r\n  public setFirstSchemaLocater(locater: IModelJsNative.ECSchemaXmlContext.SchemaLocaterCallback): void {\r\n    this.nativeContext.setFirstSchemaLocater(locater);\r\n  }\r\n\r\n  /** Deserialize a [Schema]($ecschema-metadata) from an ECSchemaXML-formatted file.\r\n   * @param filePath The absolute path of the XML file.\r\n   * @returns The JSON representation of the schema, as a [SchemaProps]($ecschema-metadata).\r\n   * @throws [[IModelError]] if there is a problem reading schema from the XML file\r\n   */\r\n  public readSchemaFromXmlFile(filePath: string): any {\r\n    const response = this.nativeContext.readSchemaFromXmlFile(filePath);\r\n    if (response.error) {\r\n      throw new IModelError(response.error.status, response.error.message);\r\n    }\r\n\r\n    assert(undefined !== response.result);\r\n    return JSON.parse(response.result);\r\n  }\r\n}\r\n"]}