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

package/lib/esm/IModelDb.js

@@ -9,7 +9,7 @@ import * as fs from "fs";
 import { join } from "path";
 import * as touch from "touch";
 import { assert, BeEvent, BentleyStatus, ChangeSetStatus, DbChangeStage, DbConflictCause, DbConflictResolution, DbOpcode, DbResult, Guid, Id64, IModelStatus, JsonUtils, Logger, LogLevel, LRUMap, OpenMode } from "@itwin/core-bentley";
-import { Base64EncodedString, BriefcaseIdValue, Code, DomainOptions, ECJsNames, ECSqlReader, EditTxnError, EntityMetaData, FontMap, IModel, IModelError, IModelNotFoundResponse, ProfileOptions, QueryBinder, QueryRowFormat, resolveNavPropId, SchemaState, ViewStoreError, ViewStoreRpc } from "@itwin/core-common";
+import { Base64EncodedString, BriefcaseIdValue, Code, DomainOptions, ECJsNames, ECSqlReader, EditTxnError, EntityMetaData, FontMap, GeographicCRS, IModel, IModelError, IModelNotFoundResponse, ProfileOptions, QueryBinder, QueryRowFormat, resolveNavPropId, SchemaState, ViewStoreError, ViewStoreRpc } from "@itwin/core-common";
 import { Range2d, Range3d } from "@itwin/core-geometry";
 import { BackendLoggerCategory } from "./BackendLoggerCategory";
 import { BriefcaseManager } from "./BriefcaseManager";
@@ -48,7 +48,8 @@ import { createNoOpLockControl } from "./internal/NoLocks";
 import { createNoOpReservations } from "./internal/NoReservations";
 import { createIModelDbFonts } from "./internal/IModelDbFontsImpl";
 import { createSchemaSyncReservations } from "./internal/SchemaSyncReservations";
-import { _activeTxn, _cache, _close, _hubAccess, _implicitTxn, _instanceKeyCache, _nativeDb, _releaseAllLocks, _resetIModelDb } from "./internal/Symbols";
+import { _activeTxn, _cache, _close, _hubAccess, _implicitTxn, _instanceKeyCache, _nativeDb, _refreshGeographicCoordinateSystem, _refreshIModelProps, _releaseAllLocks, _resetIModelDb, _updateIModelProps, _verifyTxnWrite } from "./internal/Symbols";
+import { QueryMetadataCache } from "./internal/QueryMetadataCache";
 import { ECVersion, SchemaContext, SchemaJsonLocater, SchemaManifest, SchemaViewManager } from "@itwin/ecschema-metadata";
 import { SchemaMap } from "./Schema";
 import { ElementLRUCache, InstanceKeyLRUCache } from "./internal/ElementLRUCache";
@@ -75,6 +76,7 @@ class ImplicitWriteTxn extends EditTxn {
         throw new Error("ImplicitWriteTxn cannot be ended");
     }
     verifyWriteable() {
+        this.iModel[_verifyTxnWrite]();
         const enforcement = EditTxn.implicitWriteEnforcement;
         if (enforcement === "allow")
             return;
@@ -145,6 +147,7 @@ export var DataTransformationStrategy;
  */
 export class IModelDb extends 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
@@ -159,6 +162,7 @@ export class IModelDb extends IModel {
     // eslint-disable-next-line @typescript-eslint/no-deprecated
     _statementCache = new StatementCache();
     _sqliteStatementCache = new StatementCache();
+    _queryMetadataCache = new QueryMetadataCache();
     _codeSpecs;
     // eslint-disable-next-line @typescript-eslint/no-deprecated
     _classMetaDataRegistry;
@@ -402,8 +406,10 @@ export class IModelDb extends IModel {
     abandonSchemaChanges() {
         if (!this[_nativeDb].hasUnsavedChanges())
             return;
-        this.clearCaches({ instanceCachesOnly: true });
+        // Unsaved changes here can include schema changes, e.g. after a failed schema import.
+        this.clearCaches();
         this[_nativeDb].abandonChanges();
+        this[_refreshGeographicCoordinateSystem]();
     }
     /** Optimize this iModel by vacuuming, and analyzing.
      *
@@ -510,6 +516,7 @@ export class IModelDb extends IModel {
     /** @internal */
     initializeIModelDb(when) {
         const props = this[_nativeDb].getIModelProps(when);
+        this._lastUpdatedGeographicCoordinateSystem = props.geographicCoordinateSystem ? new GeographicCRS(props.geographicCoordinateSystem) : undefined;
         super.initialize(props.rootSubject.name, props);
         if (this._initialized)
             return;
@@ -524,6 +531,40 @@ export class IModelDb extends IModel {
         db.onEcefLocationChanged.addListener(() => IpcHost.notifyTxns(db, "notifyEcefLocationChanged", db.ecefLocation?.toJSON()));
         db.onGeographicCoordinateSystemChanged.addListener(() => 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
+     */
+    [_refreshIModelProps]() {
+        this.initializeIModelDb("pullMerge");
+    }
+    /** @internal */
+    [_refreshGeographicCoordinateSystem]() {
+        const wasRefreshing = this._isRefreshingGeographicCoordinateSystem;
+        this._isRefreshingGeographicCoordinateSystem = true;
+        try {
+            const props = this[_nativeDb].getIModelProps().geographicCoordinateSystem;
+            this._lastUpdatedGeographicCoordinateSystem = props ? new GeographicCRS(props) : undefined;
+            this.geographicCoordinateSystem = props ? new GeographicCRS(props) : undefined;
+        }
+        finally {
+            this._isRefreshingGeographicCoordinateSystem = wasRefreshing;
+        }
+    }
+    _isRefreshingGeographicCoordinateSystem = false;
+    /** @internal */
+    [_verifyTxnWrite]() {
+        if (this._isRefreshingGeographicCoordinateSystem)
+            throw new IModelError(IModelStatus.BadRequest, "Cannot write while restoring the geographic coordinate system");
+    }
+    /** @internal */
+    [_updateIModelProps]() {
+        const { geographicCoordinateSystem, ...props } = this.toJSON();
+        const gcs = geographicCoordinateSystem ? new GeographicCRS(geographicCoordinateSystem) : undefined;
+        const gcsChanged = gcs !== undefined && !this._lastUpdatedGeographicCoordinateSystem?.equals(gcs);
+        this[_nativeDb].updateIModelProps(gcsChanged ? { ...props, geographicCoordinateSystem } : props);
+        if (gcsChanged)
+            this._lastUpdatedGeographicCoordinateSystem = gcs;
+    }
     /** Returns true if this is a BriefcaseDb
      * @see [[BriefcaseDb.open]]
      */
@@ -634,7 +675,7 @@ export class IModelDb extends IModel {
             throw new IModelError(DbResult.BE_SQLITE_ERROR_NOTOPEN, "db not open");
         const executor = {
             execute: async (request) => {
-                return ConcurrentQuery.executeQueryRequest(this[_nativeDb], request);
+                return this._queryMetadataCache.executeCachedQueryRequest(request, async (req) => ConcurrentQuery.executeQueryRequest(this[_nativeDb], req));
             },
         };
         return new ECSqlReader(executor, ecsql, params, config);
@@ -836,6 +877,7 @@ export class IModelDb extends IModel {
     clearCaches(params) {
         if (!params?.instanceCachesOnly) {
             this._statementCache.clear();
+            this._queryMetadataCache.clear();
             this._sqliteStatementCache.clear();
             this._classMetaDataRegistry = undefined;
             this._jsClassMap = undefined;
@@ -1127,6 +1169,7 @@ export class IModelDb extends IModel {
                     const status = this[_nativeDb].cancelTo(txnBeforeAdopt, true);
                     if (IModelStatus.Success !== status)
                         Logger.logError(loggerCategory, `Failed to roll back the adopted schema rows after a failed import: ${IModelStatus[status] ?? status}`);
+                    this.clearCaches();
                 }
                 throw err;
             }
@@ -2189,8 +2232,6 @@ function processSchemaWriteStatus(status) {
             }
             else if (modelIdArg.code) {
                 const modelId = this._iModel.elements.getElementProps({ code: modelIdArg.code }).id;
-                if (!modelId)
-                    throw new IModelError(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 {
@@ -2216,7 +2257,7 @@ function processSchemaWriteStatus(status) {
          */
         getSubModel(modeledElementId, modelClass) {
             const modeledElementProps = this._iModel.elements.getElementProps(modeledElementId);
-            if (undefined === modeledElementProps.id || modeledElementProps.id === IModel.rootSubjectId)
+            if (modeledElementProps.id === IModel.rootSubjectId)
                 throw new IModelError(IModelStatus.NotFound, "Root subject does not have a sub-model");
             return this.getModel(modeledElementProps.id, modelClass);
         }
@@ -2229,7 +2270,7 @@ function processSchemaWriteStatus(status) {
          */
         tryGetSubModel(modeledElementId, modelClass) {
             const modeledElementProps = this._iModel.elements.tryGetElementProps(modeledElementId);
-            if (undefined === modeledElementProps?.id || (IModel.rootSubjectId === modeledElementProps.id))
+            if (undefined === modeledElementProps || IModel.rootSubjectId === modeledElementProps.id)
                 return undefined;
             return this.tryGetModel(modeledElementProps.id, modelClass);
         }
@@ -2526,14 +2567,15 @@ function processSchemaWriteStatus(status) {
             this._iModel[_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[_implicitTxn].deleteElements(ids, deleteOptions);
         }
@@ -3347,7 +3389,8 @@ export 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[_nativeDb].getCurrentChangeset();
             });
@@ -3602,7 +3645,7 @@ export class BriefcaseDb extends IModelDb {
         await this.executeWritable(async () => {
             await BriefcaseManager.pullAndApplyChangesets(this, arg ?? {});
             SchemaSync.updateDbSchema(this);
-            this.initializeIModelDb("pullMerge");
+            this[_refreshIModelProps]();
         });
         // If this pull enabled or disabled SchemaSync for this briefcase, its reservations must now be re-initialized
         if (this.reservations.isServerBased !== SchemaSync.isEnabled(this))
@@ -3779,7 +3822,6 @@ export class BriefcaseDb extends IModelDb {
         // pushing changes requires a writeable briefcase
         await this.executeWritable(async () => {
             await 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.isEnabled(this))