@itwin/core-backend 5.15.0-dev.2 → 5.15.0-dev.20

package/lib/cjs/IModelDb.js

@@ -52,6 +52,7 @@ const NoReservations_1 = require("./internal/NoReservations");
 const IModelDbFontsImpl_1 = require("./internal/IModelDbFontsImpl");
 const SchemaSyncReservations_1 = require("./internal/SchemaSyncReservations");
 const Symbols_1 = require("./internal/Symbols");
+const QueryMetadataCache_1 = require("./internal/QueryMetadataCache");
 const ecschema_metadata_1 = require("@itwin/ecschema-metadata");
 const Schema_1 = require("./Schema");
 const ElementLRUCache_1 = require("./internal/ElementLRUCache");
@@ -78,6 +79,7 @@ class ImplicitWriteTxn extends EditTxn_1.EditTxn {
         throw new Error("ImplicitWriteTxn cannot be ended");
     }
     verifyWriteable() {
+        this.iModel[Symbols_1._verifyTxnWrite]();
         const enforcement = EditTxn_1.EditTxn.implicitWriteEnforcement;
         if (enforcement === "allow")
             return;
@@ -148,6 +150,7 @@ var DataTransformationStrategy;
  */
 class IModelDb extends core_common_1.IModel {
     _initialized = false;
+    _lastUpdatedGeographicCoordinateSystem;
     /** Keep track of open imodels to support `tryFind` for RPC purposes */
     static _openDbs = new Map();
     static defaultLimit = 1000; // default limit for batching queries
@@ -162,6 +165,7 @@ class IModelDb extends core_common_1.IModel {
     // eslint-disable-next-line @typescript-eslint/no-deprecated
     _statementCache = new SqliteStatement_1.StatementCache();
     _sqliteStatementCache = new SqliteStatement_1.StatementCache();
+    _queryMetadataCache = new QueryMetadataCache_1.QueryMetadataCache();
     _codeSpecs;
     // eslint-disable-next-line @typescript-eslint/no-deprecated
     _classMetaDataRegistry;
@@ -405,8 +409,10 @@ class IModelDb extends core_common_1.IModel {
     abandonSchemaChanges() {
         if (!this[Symbols_1._nativeDb].hasUnsavedChanges())
             return;
-        this.clearCaches({ instanceCachesOnly: true });
+        // Unsaved changes here can include schema changes, e.g. after a failed schema import.
+        this.clearCaches();
         this[Symbols_1._nativeDb].abandonChanges();
+        this[Symbols_1._refreshGeographicCoordinateSystem]();
     }
     /** Optimize this iModel by vacuuming, and analyzing.
      *
@@ -513,6 +519,7 @@ class IModelDb extends core_common_1.IModel {
     /** @internal */
     initializeIModelDb(when) {
         const props = this[Symbols_1._nativeDb].getIModelProps(when);
+        this._lastUpdatedGeographicCoordinateSystem = props.geographicCoordinateSystem ? new core_common_1.GeographicCRS(props.geographicCoordinateSystem) : undefined;
         super.initialize(props.rootSubject.name, props);
         if (this._initialized)
             return;
@@ -527,6 +534,40 @@ class IModelDb extends core_common_1.IModel {
         db.onEcefLocationChanged.addListener(() => IpcHost_1.IpcHost.notifyTxns(db, "notifyEcefLocationChanged", db.ecefLocation?.toJSON()));
         db.onGeographicCoordinateSystemChanged.addListener(() => IpcHost_1.IpcHost.notifyTxns(db, "notifyGeographicCoordinateSystemChanged", db.geographicCoordinateSystem?.toJSON()));
     }
+    /** Reload the cached iModel properties (extents, geolocation, name, etc.) from the database, e.g. after changesets were merged.
+     * @internal
+     */
+    [Symbols_1._refreshIModelProps]() {
+        this.initializeIModelDb("pullMerge");
+    }
+    /** @internal */
+    [Symbols_1._refreshGeographicCoordinateSystem]() {
+        const wasRefreshing = this._isRefreshingGeographicCoordinateSystem;
+        this._isRefreshingGeographicCoordinateSystem = true;
+        try {
+            const props = this[Symbols_1._nativeDb].getIModelProps().geographicCoordinateSystem;
+            this._lastUpdatedGeographicCoordinateSystem = props ? new core_common_1.GeographicCRS(props) : undefined;
+            this.geographicCoordinateSystem = props ? new core_common_1.GeographicCRS(props) : undefined;
+        }
+        finally {
+            this._isRefreshingGeographicCoordinateSystem = wasRefreshing;
+        }
+    }
+    _isRefreshingGeographicCoordinateSystem = false;
+    /** @internal */
+    [Symbols_1._verifyTxnWrite]() {
+        if (this._isRefreshingGeographicCoordinateSystem)
+            throw new core_common_1.IModelError(core_bentley_1.IModelStatus.BadRequest, "Cannot write while restoring the geographic coordinate system");
+    }
+    /** @internal */
+    [Symbols_1._updateIModelProps]() {
+        const { geographicCoordinateSystem, ...props } = this.toJSON();
+        const gcs = geographicCoordinateSystem ? new core_common_1.GeographicCRS(geographicCoordinateSystem) : undefined;
+        const gcsChanged = gcs !== undefined && !this._lastUpdatedGeographicCoordinateSystem?.equals(gcs);
+        this[Symbols_1._nativeDb].updateIModelProps(gcsChanged ? { ...props, geographicCoordinateSystem } : props);
+        if (gcsChanged)
+            this._lastUpdatedGeographicCoordinateSystem = gcs;
+    }
     /** Returns true if this is a BriefcaseDb
      * @see [[BriefcaseDb.open]]
      */
@@ -637,7 +678,7 @@ class IModelDb extends core_common_1.IModel {
             throw new core_common_1.IModelError(core_bentley_1.DbResult.BE_SQLITE_ERROR_NOTOPEN, "db not open");
         const executor = {
             execute: async (request) => {
-                return ConcurrentQuery_1.ConcurrentQuery.executeQueryRequest(this[Symbols_1._nativeDb], request);
+                return this._queryMetadataCache.executeCachedQueryRequest(request, async (req) => ConcurrentQuery_1.ConcurrentQuery.executeQueryRequest(this[Symbols_1._nativeDb], req));
             },
         };
         return new core_common_1.ECSqlReader(executor, ecsql, params, config);
@@ -839,6 +880,7 @@ class IModelDb extends core_common_1.IModel {
     clearCaches(params) {
         if (!params?.instanceCachesOnly) {
             this._statementCache.clear();
+            this._queryMetadataCache.clear();
             this._sqliteStatementCache.clear();
             this._classMetaDataRegistry = undefined;
             this._jsClassMap = undefined;
@@ -1130,6 +1172,7 @@ class IModelDb extends core_common_1.IModel {
                     const status = this[Symbols_1._nativeDb].cancelTo(txnBeforeAdopt, true);
                     if (core_bentley_1.IModelStatus.Success !== status)
                         core_bentley_1.Logger.logError(loggerCategory, `Failed to roll back the adopted schema rows after a failed import: ${core_bentley_1.IModelStatus[status] ?? status}`);
+                    this.clearCaches();
                 }
                 throw err;
             }
@@ -2193,8 +2236,6 @@ function processSchemaWriteStatus(status) {
             }
             else if (modelIdArg.code) {
                 const modelId = this._iModel.elements.getElementProps({ code: modelIdArg.code }).id;
-                if (!modelId)
-                    throw new core_common_1.IModelError(core_bentley_1.IModelStatus.NotFound, `Model not found with code: [spec:${modelIdArg.code.spec}, scope:${modelIdArg.code.scope}, value:${modelIdArg.code.value}])`);
                 args = { partialKey: { id: modelId, baseClassName } };
             }
             else {
@@ -2220,7 +2261,7 @@ function processSchemaWriteStatus(status) {
          */
         getSubModel(modeledElementId, modelClass) {
             const modeledElementProps = this._iModel.elements.getElementProps(modeledElementId);
-            if (undefined === modeledElementProps.id || modeledElementProps.id === core_common_1.IModel.rootSubjectId)
+            if (modeledElementProps.id === core_common_1.IModel.rootSubjectId)
                 throw new core_common_1.IModelError(core_bentley_1.IModelStatus.NotFound, "Root subject does not have a sub-model");
             return this.getModel(modeledElementProps.id, modelClass);
         }
@@ -2233,7 +2274,7 @@ function processSchemaWriteStatus(status) {
          */
         tryGetSubModel(modeledElementId, modelClass) {
             const modeledElementProps = this._iModel.elements.tryGetElementProps(modeledElementId);
-            if (undefined === modeledElementProps?.id || (core_common_1.IModel.rootSubjectId === modeledElementProps.id))
+            if (undefined === modeledElementProps || core_common_1.IModel.rootSubjectId === modeledElementProps.id)
                 return undefined;
             return this.tryGetModel(modeledElementProps.id, modelClass);
         }
@@ -2530,14 +2571,15 @@ function processSchemaWriteStatus(status) {
             this._iModel[Symbols_1._implicitTxn].deleteElement(ids);
         }
         /**
-         * Delete multiple elements from the iModel.
+         * Delete multiple elements from the iModel in a single bulk operation. See [[EditTxn.deleteElements]].
          * @param ids The ids of the elements to delete. All ids must be well-formed and valid [[Id64String]]s.
-         * @param deleteOptions Options for the delete operation.
-         * @returns A result object containing information about the deletion operation success and the element ids that failed to delete (if any).
+         * @param deleteOptions Deprecated and ignored; kept for backward compatibility of the signature.
+         * @returns A result object describing the outcome of the operation and the elements that block it (if any).
          * @throws [[ITwinError]] if any of the supplied ids are not well-formed/valid [[Id64String]]s.
          * @deprecated in 5.1.9 - might be removed in next major version. Use EditTxn.deleteElements instead, within an explicit EditTxn scope (or via withEditTxn). See EditTxn documentation for migration help.
          * @beta
          */
+        // eslint-disable-next-line @typescript-eslint/no-deprecated
         deleteElements(ids, deleteOptions) {
             return this._iModel[Symbols_1._implicitTxn].deleteElements(ids, deleteOptions);
         }
@@ -3351,7 +3393,8 @@ class BriefcaseDb extends IModelDb {
             touch.sync(briefcaseDb.watchFilePathName);
             // Restart default txn to trigger events when watch file is changed by some other process.
             const watcher = fs.watch(briefcaseDb.watchFilePathName, { persistent: false }, () => {
-                nativeDb.clearECDbCache();
+                // The other connection may have changed the schema, so drop everything prepared against the old one.
+                briefcaseDb.clearCaches();
                 nativeDb.restartDefaultTxn();
                 briefcaseDb.changeset = briefcaseDb[Symbols_1._nativeDb].getCurrentChangeset();
             });
@@ -3606,7 +3649,7 @@ class BriefcaseDb extends IModelDb {
         await this.executeWritable(async () => {
             await BriefcaseManager_1.BriefcaseManager.pullAndApplyChangesets(this, arg ?? {});
             SchemaSync_1.SchemaSync.updateDbSchema(this);
-            this.initializeIModelDb("pullMerge");
+            this[Symbols_1._refreshIModelProps]();
         });
         // If this pull enabled or disabled SchemaSync for this briefcase, its reservations must now be re-initialized
         if (this.reservations.isServerBased !== SchemaSync_1.SchemaSync.isEnabled(this))
@@ -3783,7 +3826,6 @@ class BriefcaseDb extends IModelDb {
         // pushing changes requires a writeable briefcase
         await this.executeWritable(async () => {
             await BriefcaseManager_1.BriefcaseManager.pullMergePush(this, arg);
-            this.initializeIModelDb("pullMerge");
         });
         // If this pull enabled or disabled SchemaSync for this briefcase, its reservations must now be re-initialized
         if (this.reservations.isServerBased !== SchemaSync_1.SchemaSync.isEnabled(this))