@itwin/core-backend 5.1.0-dev.5 → 5.1.0-dev.52

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, DbResult, Guid, Id64, IModelStatus, JsonUtils, Logger, LogLevel, LRUMap, OpenMode } from "@itwin/core-bentley";
-import { BriefcaseIdValue, Code, DomainOptions, ECJsNames, ECSqlReader, EntityMetaData, FontMap, IModel, IModelError, IModelNotFoundResponse, ProfileOptions, QueryRowFormat, SchemaState, ViewStoreRpc } from "@itwin/core-common";
+import { BriefcaseIdValue, Code, DomainOptions, ECJsNames, ECSqlReader, EntityMetaData, FontMap, IModel, IModelError, IModelNotFoundResponse, ProfileOptions, QueryRowFormat, SchemaState, ViewStoreError, ViewStoreRpc } from "@itwin/core-common";
 import { Range2d, Range3d } from "@itwin/core-geometry";
 import { BackendLoggerCategory } from "./BackendLoggerCategory";
 import { BriefcaseManager } from "./BriefcaseManager";
@@ -44,10 +44,10 @@ import { SettingsImpl } from "./internal/workspace/SettingsImpl";
 import { IModelNative } from "./internal/NativePlatform";
 import { createNoOpLockControl } from "./internal/NoLocks";
 import { createIModelDbFonts } from "./internal/IModelDbFontsImpl";
-import { _cache, _close, _hubAccess, _nativeDb, _releaseAllLocks } from "./internal/Symbols";
+import { _cache, _close, _hubAccess, _instanceKeyCache, _nativeDb, _releaseAllLocks } from "./internal/Symbols";
 import { SchemaContext, SchemaJsonLocater } from "@itwin/ecschema-metadata";
 import { SchemaMap } from "./Schema";
-import { ElementLRUCache } from "./internal/ElementLRUCache";
+import { ElementLRUCache, InstanceKeyLRUCache } from "./internal/ElementLRUCache";
 // spell:ignore fontid fontmap
 const loggerCategory = BackendLoggerCategory.IModelDb;
 /** @internal */
@@ -107,7 +107,7 @@ export class IModelDb extends IModel {
     _jsClassMap;
     _schemaMap;
     _schemaContext;
-    /** @deprecated in 5.0.0. Use [[fonts]]. */
+    /** @deprecated in 5.0.0 - will not be removed until after 2026-06-13. Use [[fonts]]. */
     _fontMap; // eslint-disable-line @typescript-eslint/no-deprecated
     _fonts = createIModelDbFonts(this);
     _workspace;
@@ -163,7 +163,7 @@ export class IModelDb extends IModel {
     restartDefaultTxn() {
         this[_nativeDb].restartDefaultTxn();
     }
-    /** @deprecated in 5.0.0. Use [[fonts]]. */
+    /** @deprecated in 5.0.0 - will not be removed until after 2026-06-13. Use [[fonts]]. */
     get fontMap() {
         return this._fontMap ?? (this._fontMap = new FontMap(this[_nativeDb].readFontMap())); // eslint-disable-line @typescript-eslint/no-deprecated
     }
@@ -340,7 +340,7 @@ export class IModelDb extends IModel {
      * @returns the value returned by `callback`.
      * @see [[withStatement]]
      * @public
-     * @deprecated in 4.11.  Use [[createQueryReader]] instead.
+     * @deprecated in 4.11 - will not be removed until after 2026-06-13.  Use [[createQueryReader]] instead.
      */
     // eslint-disable-next-line @typescript-eslint/no-deprecated
     withPreparedStatement(ecsql, callback, logErrors = true) {
@@ -372,7 +372,7 @@ export class IModelDb extends IModel {
      * @returns the value returned by `callback`.
      * @see [[withPreparedStatement]]
      * @public
-     * @deprecated in 4.11.  Use [[createQueryReader]] instead.
+     * @deprecated in 4.11 - will not be removed until after 2026-06-13.  Use [[createQueryReader]] instead.
      */
     // eslint-disable-next-line @typescript-eslint/no-deprecated
     withStatement(ecsql, callback, logErrors = true) {
@@ -579,6 +579,8 @@ export class IModelDb extends IModel {
         this._schemaContext = undefined;
         this.elements[_cache].clear();
         this.models[_cache].clear();
+        this.elements[_instanceKeyCache].clear();
+        this.models[_instanceKeyCache].clear();
     }
     /** Update the project extents for this iModel.
      * <p><em>Example:</em>
@@ -634,6 +636,7 @@ export class IModelDb extends IModel {
      * @note This will not delete Txns that have already been saved, even if they have not yet been pushed.
     */
     abandonChanges() {
+        this.clearCaches();
         this[_nativeDb].abandonChanges();
     }
     /**
@@ -647,11 +650,14 @@ export class IModelDb extends IModel {
     performCheckpoint() {
         if (!this.isReadonly) {
             this.saveChanges();
+            this.clearCaches();
+            this[_nativeDb].concurrentQueryShutdown();
+            this[_nativeDb].clearECDbCache();
             this[_nativeDb].performCheckpoint();
         }
     }
     /** @internal
-     * @deprecated in 4.8. Use `txns.reverseTxns`.
+     * @deprecated in 4.8 - will not be removed until after 2026-06-13. Use `txns.reverseTxns`.
      */
     reverseTxns(numOperations) {
         return this[_nativeDb].reverseTxns(numOperations);
@@ -877,7 +883,7 @@ export class IModelDb extends IModel {
     }
     /** The registry of entity metadata for this iModel.
      * @internal
-     * @deprecated in 5.0. Please use `schemaContext` from the `iModel` instead.
+     * @deprecated in 5.0 - will not be removed until after 2026-06-13. Please use `schemaContext` from the `iModel` instead.
      *
      * @example
      * ```typescript
@@ -937,7 +943,7 @@ export class IModelDb extends IModel {
      * @param sql The ECSQL statement to prepare
      * @param logErrors Determines if error will be logged if statement fail to prepare
      * @throws [[IModelError]] if there is a problem preparing the statement.
-     * @deprecated in 4.11.  Use [IModelDb.createQueryReader]($backend) or [ECDb.createQueryReader]($backend) to query.
+     * @deprecated in 4.11 - will not be removed until after 2026-06-13.  Use [IModelDb.createQueryReader]($backend) or [ECDb.createQueryReader]($backend) to query.
      */
     // eslint-disable-next-line @typescript-eslint/no-deprecated
     prepareStatement(sql, logErrors = true) {
@@ -949,7 +955,7 @@ export class IModelDb extends IModel {
     /** Prepare an ECSQL statement.
      * @param sql The ECSQL statement to prepare
      * @returns `undefined` if there is a problem preparing the statement.
-     * @deprecated in 4.11.  Use [IModelDb.createQueryReader]($backend) or [ECDb.createQueryReader]($backend) to query.
+     * @deprecated in 4.11 - will not be removed until after 2026-06-13.  Use [IModelDb.createQueryReader]($backend) or [ECDb.createQueryReader]($backend) to query.
      */
     // eslint-disable-next-line @typescript-eslint/no-deprecated
     tryPrepareStatement(sql) {
@@ -999,7 +1005,7 @@ export class IModelDb extends IModel {
     }
     /** Get metadata for a class. This method will load the metadata from the iModel into the cache as a side-effect, if necessary.
      * @throws [[IModelError]] if the metadata cannot be found nor loaded.
-     * @deprecated in 5.0. Please use `getSchemaItem` from `SchemaContext` class instead.
+     * @deprecated in 5.0 - will not be removed until after 2026-06-13. Please use `getSchemaItem` from `SchemaContext` class instead.
      *
      * @example
      *  * ```typescript
@@ -1025,7 +1031,7 @@ export class IModelDb extends IModel {
         return metadata;
     }
     /** Identical to [[getMetaData]], except it returns `undefined` instead of throwing an error if the metadata cannot be found nor loaded.
-     * @deprecated in 5.0. Please use `getSchemaItem` from `SchemaContext` class instead.
+     * @deprecated in 5.0 - will not be removed until after 2026-06-13. Please use `getSchemaItem` from `SchemaContext` class instead.
      *
      * @example
      *  * ```typescript
@@ -1053,7 +1059,7 @@ export class IModelDb extends IModel {
      * @param func The callback to be invoked on each property
      * @param includeCustom If true (default), include custom-handled properties in the iteration. Otherwise, skip custom-handled properties.
      * @note Custom-handled properties are core properties that have behavior enforced by C++ handlers.
-     * @deprecated in 5.0. Please use `forEachProperty` instead.
+     * @deprecated in 5.0 - will not be removed until after 2026-06-13. Please use `forEachProperty` instead.
      *
      * @example
      * ```typescript
@@ -1079,7 +1085,7 @@ export class IModelDb extends IModel {
      * @param func The callback to be invoked on each property
      * @param includeCustom If true (default), include custom-handled properties in the iteration. Otherwise, skip custom-handled properties.
      * @note Custom-handled properties are core properties that have behavior enforced by C++ handlers.
-     * @deprecated in 5.0. Use `forEachProperty` from `SchemaContext` class instead.
+     * @deprecated in 5.0 - will not be removed until after 2026-06-13. Use `forEachProperty` from `SchemaContext` class instead.
      *
      * @example
      * ```typescript
@@ -1109,7 +1115,7 @@ export class IModelDb extends IModel {
     }
     /**
      * @internal
-     * @deprecated in 5.0. Please use `schemaContext` from `iModel` instead to get metadata.
+     * @deprecated in 5.0 - will not be removed until after 2026-06-13. Please use `schemaContext` from `iModel` instead to get metadata.
      */
     loadMetaData(classFullName) {
         // eslint-disable-next-line @typescript-eslint/no-deprecated
@@ -1240,11 +1246,21 @@ export class IModelDb extends IModel {
     }
     /** Get the IModel coordinate corresponding to each GeoCoordinate point in the input */
     async getIModelCoordinatesFromGeoCoordinates(props) {
-        return this[_nativeDb].getIModelCoordinatesFromGeoCoordinates(props);
+        const response = this[_nativeDb].getIModelCoordinatesFromGeoCoordinates(props);
+        // fromCache is only meaningful on the front-end; provide it for compatibility with return type.
+        response.fromCache = 0;
+        // Native omits the array if the input was empty.
+        response.iModelCoords = response.iModelCoords ?? [];
+        return response;
     }
     /** Get the GeoCoordinate (longitude, latitude, elevation) corresponding to each IModel Coordinate point in the input */
     async getGeoCoordinatesFromIModelCoordinates(props) {
-        return this[_nativeDb].getGeoCoordinatesFromIModelCoordinates(props);
+        const response = this[_nativeDb].getGeoCoordinatesFromIModelCoordinates(props);
+        // fromCache is only meaningful on the front-end; provide it for compatibility with return type.
+        response.fromCache = 0;
+        // Native omits the array if the input was empty.
+        response.geoCoords = response.geoCoords ?? [];
+        return response;
     }
     /** Export meshes suitable for graphics APIs from arbitrary geometry in elements in this IModelDb.
      *  * Requests can be slow when processing many elements so it is expected that this function be used on a dedicated backend,
@@ -1474,12 +1490,15 @@ function processSchemaWriteStatus(status) {
 /** @public */
 (function (IModelDb) {
     /** The collection of models in an [[IModelDb]].
-     * @public
+     * @public @preview
      */
     class Models {
         _iModel;
+        _modelCacheSize = 10;
+        /** @internal */
+        [_cache] = new LRUMap(this._modelCacheSize);
         /** @internal */
-        [_cache] = new LRUMap(500);
+        [_instanceKeyCache] = new InstanceKeyLRUCache(this._modelCacheSize);
         /** @internal */
         constructor(_iModel) {
             this._iModel = _iModel;
@@ -1583,7 +1602,16 @@ function processSchemaWriteStatus(status) {
             else {
                 throw new IModelError(IModelStatus.InvalidId, `Invalid model identifier: ${JSON.stringify(modelIdArg)}`);
             }
-            return this._iModel[_nativeDb].resolveInstanceKey(args);
+            // Check the cache to avoid unnecessary native calls
+            const cachedResult = this[_instanceKeyCache].get(args);
+            if (cachedResult) {
+                return cachedResult;
+            }
+            else {
+                const instanceKey = this._iModel[_nativeDb].resolveInstanceKey(args);
+                this[_instanceKeyCache].set(args, instanceKey);
+                return instanceKey;
+            }
         }
         /** Get the sub-model of the specified Element.
          * See [[IModelDb.Elements.queryElementIdByCode]] for more on how to find an element by Code.
@@ -1627,7 +1655,9 @@ function processSchemaWriteStatus(status) {
                 return props.id = this._iModel[_nativeDb].insertModel(props);
             }
             catch (err) {
-                throw new IModelError(err.errorNumber, `Error inserting model [${err.message}], class=${props.classFullName}`);
+                const error = new IModelError(err.errorNumber, `Error inserting model [${err.message}], class=${props.classFullName}`);
+                error.cause = err;
+                throw error;
             }
         }
         /** Update an existing model.
@@ -1641,7 +1671,9 @@ function processSchemaWriteStatus(status) {
                 this._iModel[_nativeDb].updateModel(props);
             }
             catch (err) {
-                throw new IModelError(err.errorNumber, `error updating model [${err.message}] id=${props.id}`);
+                const error = new IModelError(err.errorNumber, `Error updating model [${err.message}], id: ${props.id}`);
+                error.cause = err;
+                throw error;
             }
         }
         /** Mark the geometry of [[GeometricModel]] as having changed, by recording an indirect change to its GeometryGuid property.
@@ -1657,7 +1689,7 @@ function processSchemaWriteStatus(status) {
             this._iModel.models[_cache].delete(modelId);
             const error = this._iModel[_nativeDb].updateModelGeometryGuid(modelId);
             if (error !== IModelStatus.Success)
-                throw new IModelError(error, `updating geometry guid for model ${modelId}`);
+                throw new IModelError(error, `Error updating geometry guid for model ${modelId}`);
         }
         /** Delete one or more existing models.
          * @param ids The Ids of the models to be deleted
@@ -1667,10 +1699,13 @@ function processSchemaWriteStatus(status) {
             Id64.toIdSet(ids).forEach((id) => {
                 try {
                     this[_cache].delete(id);
+                    this[_instanceKeyCache].deleteById(id);
                     this._iModel[_nativeDb].deleteModel(id);
                 }
                 catch (err) {
-                    throw new IModelError(err.errorNumber, `error deleting model [${err.message}] id ${id}`);
+                    const error = new IModelError(err.errorNumber, `Error deleting model [${err.message}], id: ${id}`);
+                    error.cause = err;
+                    throw error;
                 }
             });
         }
@@ -1700,12 +1735,15 @@ function processSchemaWriteStatus(status) {
     }
     IModelDb.Models = Models;
     /** The collection of elements in an [[IModelDb]].
-     * @public
+     * @public @preview
      */
     class Elements {
         _iModel;
+        _elementCacheSize = 50;
+        /** @internal */
+        [_cache] = new ElementLRUCache(this._elementCacheSize);
         /** @internal */
-        [_cache] = new ElementLRUCache();
+        [_instanceKeyCache] = new InstanceKeyLRUCache(this._elementCacheSize);
         /** @internal */
         constructor(_iModel) {
             this._iModel = _iModel;
@@ -1755,7 +1793,16 @@ function processSchemaWriteStatus(status) {
                     throw new IModelError(IModelStatus.InvalidId, "Element Id or FederationGuid or Code is required");
                 }
             }
-            return this._iModel[_nativeDb].resolveInstanceKey(args);
+            // Check the cache to avoid unnecessary native calls
+            const cachedResult = this[_instanceKeyCache].get(args);
+            if (cachedResult) {
+                return cachedResult;
+            }
+            else {
+                const instanceKey = this._iModel[_nativeDb].resolveInstanceKey(args);
+                this[_instanceKeyCache].set(args, instanceKey);
+                return instanceKey;
+            }
         }
         /** Get properties of an Element by Id, FederationGuid, or Code
          * @returns The properties of the element or `undefined` if the element is not found.
@@ -1845,15 +1892,16 @@ function processSchemaWriteStatus(status) {
                 throw new IModelError(IModelStatus.InvalidCodeSpec, "Invalid CodeSpec");
             if (code.value === undefined)
                 throw new IModelError(IModelStatus.InvalidCode, "Invalid Code");
-            // eslint-disable-next-line @typescript-eslint/no-deprecated
-            return this._iModel.withPreparedStatement("SELECT ECInstanceId FROM BisCore:Element WHERE CodeSpec.Id=? AND CodeScope.Id=? AND CodeValue=?", (stmt) => {
-                stmt.bindId(1, code.spec);
-                stmt.bindId(2, Id64.fromString(code.scope));
-                stmt.bindString(3, code.value);
-                if (DbResult.BE_SQLITE_ROW !== stmt.step())
+            const codeToQuery = new Code(code);
+            try {
+                const elementKey = this.resolveElementKey(codeToQuery);
+                return Id64.fromString(elementKey.id);
+            }
+            catch (err) {
+                if (err.errorNumber === IModelStatus.NotFound)
                     return undefined;
-                return stmt.getValue(0).getId();
-            });
+                throw err;
+            }
         }
         /** Query for an [[Element]]'s last modified time.
          * @param elementId The Id of the element.
@@ -1877,7 +1925,7 @@ function processSchemaWriteStatus(status) {
         /** Insert a new element into the iModel.
          * @param elProps The properties of the new element.
          * @returns The newly inserted element's Id.
-         * @throws [[IModelError]] if unable to insert the element.
+         * @throws [[ITwinError]] if unable to insert the element.
          * @note For convenience, the value of `elProps.id` is updated to reflect the resultant element's id.
          * However when `elProps.federationGuid` is not present or undefined, a new Guid will be generated and stored on the resultant element. But
          * the value of `elProps.federationGuid` is *not* updated. Generally, it is best to re-read the element after inserting (e.g. via [[getElementProps]])
@@ -1907,7 +1955,7 @@ function processSchemaWriteStatus(status) {
          * @param elProps the properties of the element to update.
          * @note The values of `classFullName` and `model` *may not be changed* by this method. Further, it will permute the `elProps` object by adding or
          * overwriting their values to the correct values.
-         * @throws [[IModelError]] if unable to update the element.
+         * @throws [[ITwinError]] if unable to update the element.
          */
         updateElement(elProps) {
             try {
@@ -1926,7 +1974,7 @@ function processSchemaWriteStatus(status) {
         }
         /** Delete one or more elements from this iModel.
          * @param ids The set of Ids of the element(s) to be deleted
-         * @throws [[IModelError]]
+         * @throws [[ITwinError]]
          * @see deleteDefinitionElements
          */
         deleteElement(ids) {
@@ -1934,6 +1982,7 @@ function processSchemaWriteStatus(status) {
             Id64.toIdSet(ids).forEach((id) => {
                 try {
                     this[_cache].delete({ id });
+                    this[_instanceKeyCache].deleteById(id);
                     iModel[_nativeDb].deleteElement(id);
                 }
                 catch (err) {
@@ -2213,7 +2262,9 @@ function processSchemaWriteStatus(status) {
                 return this._iModel[_nativeDb].insertElementAspect(aspectProps);
             }
             catch (err) {
-                throw new IModelError(err.errorNumber, `Error inserting ElementAspect [${err.message}], class: ${aspectProps.classFullName}`);
+                const error = new IModelError(err.errorNumber, `Error inserting ElementAspect [${err.message}], class: ${aspectProps.classFullName}`, aspectProps);
+                error.cause = err;
+                throw error;
             }
         }
         /** Update an exist ElementAspect within the iModel.
@@ -2225,7 +2276,9 @@ function processSchemaWriteStatus(status) {
                 this._iModel[_nativeDb].updateElementAspect(aspectProps);
             }
             catch (err) {
-                throw new IModelError(err.errorNumber, `Error updating ElementAspect [${err.message}], id: ${aspectProps.id}`);
+                const error = new IModelError(err.errorNumber, `Error updating ElementAspect [${err.message}], id: ${aspectProps.id}`, aspectProps);
+                error.cause = err;
+                throw error;
             }
         }
         /** Delete one or more ElementAspects from this iModel.
@@ -2239,14 +2292,16 @@ function processSchemaWriteStatus(status) {
                     iModel[_nativeDb].deleteElementAspect(aspectInstanceId);
                 }
                 catch (err) {
-                    throw new IModelError(err.errorNumber, `Error deleting ElementAspect [${err.message}], id: ${aspectInstanceId}`);
+                    const error = new IModelError(err.errorNumber, `Error deleting ElementAspect [${err.message}], id: ${aspectInstanceId}`);
+                    error.cause = err;
+                    throw error;
                 }
             });
         }
     }
     IModelDb.Elements = Elements;
     /** The collection of views in an [[IModelDb]].
-     * @public
+     * @public @preview
      */
     class Views {
         _iModel;
@@ -2272,7 +2327,7 @@ function processSchemaWriteStatus(status) {
             if (undefined === props) {
                 const propsString = this._iModel.queryFilePropertyString(Views.viewStoreProperty);
                 if (!propsString)
-                    throw new Error("iModel does not have a default ViewStore");
+                    ViewStoreError.throwError("no-viewstore", { message: "iModel does not have a default ViewStore" });
                 props = JSON.parse(propsString);
             }
             const accessToken = await CloudSqlite.requestToken({
@@ -2393,7 +2448,7 @@ function processSchemaWriteStatus(status) {
         }
         getViewThumbnailArg(viewDefinitionId) {
             if (!Id64.isValid(viewDefinitionId))
-                throw new Error("illegal thumbnail id");
+                throw new IModelError(IModelStatus.BadArg, "illegal thumbnail id");
             return { namespace: "dgn_View", name: "Thumbnail", id: viewDefinitionId };
         }
         /** Get the thumbnail for a view.
@@ -2422,7 +2477,7 @@ function processSchemaWriteStatus(status) {
         }
         /** Set the default view property the iModel.
          * @param viewId The Id of the ViewDefinition to use as the default
-         * @deprecated in 4.2.x. Avoid setting this property - it is not practical for one single view to serve the needs of the many applications
+         * @deprecated in 4.2.x - will not be removed until after 2026-06-13. Avoid setting this property - it is not practical for one single view to serve the needs of the many applications
          * that might wish to view the contents of the iModel.
          */
         setDefaultViewId(viewId) {
@@ -3100,6 +3155,10 @@ export class SnapshotDb extends IModelDb {
         snapshotDb.channels.addAllowedChannel(ChannelControl.sharedChannelName);
         if (options.createClassViews)
             snapshotDb._createClassViewsOnClose = true; // save flag that will be checked when close() is called
+        if (options.geographicCoordinateSystem)
+            snapshotDb.setGeographicCoordinateSystem(options.geographicCoordinateSystem);
+        if (options.ecefLocation)
+            snapshotDb.setEcefLocation(options.ecefLocation);
         return snapshotDb;
     }
     /** Create a local [Snapshot]($docs/learning/backend/AccessingIModels.md#snapshot-imodels) iModel file, using this iModel as a *seed* or starting point.
@@ -3254,6 +3313,10 @@ export class StandaloneDb extends BriefcaseDb {
         nativeDb.resetBriefcaseId(BriefcaseIdValue.Unassigned);
         nativeDb.saveChanges();
         const db = new this({ nativeDb, key: Guid.createValue(), briefcaseId: BriefcaseIdValue.Unassigned, openMode: OpenMode.ReadWrite });
+        if (args.geographicCoordinateSystem)
+            db.setGeographicCoordinateSystem(args.geographicCoordinateSystem);
+        if (args.ecefLocation)
+            db.setEcefLocation(args.ecefLocation);
         db.channels.addAllowedChannel(ChannelControl.sharedChannelName);
         return db;
     }