@itwin/core-backend 5.6.0-dev.8 → 5.6.1

package/lib/esm/IModelDb.js

@@ -49,6 +49,7 @@ import { ECVersion, SchemaContext, SchemaJsonLocater } from "@itwin/ecschema-met
 import { SchemaMap } from "./Schema";
 import { ElementLRUCache, InstanceKeyLRUCache } from "./internal/ElementLRUCache";
 import { IModelIncrementalSchemaLocater } from "./IModelIncrementalSchemaLocater";
+import { integrityCheckTypeMap, performQuickIntegrityCheck, performSpecificIntegrityCheck } from "./internal/IntegrityCheck";
 // spell:ignore fontid fontmap
 const loggerCategory = BackendLoggerCategory.IModelDb;
 /** @internal */
@@ -277,11 +278,15 @@ export class IModelDb extends IModel {
         this.clearCaches();
         this[_nativeDb].detachDb(alias);
     }
-    /** Close this IModel, if it is currently open, and save changes if it was opened in ReadWrite mode. */
-    close() {
+    /** Close this IModel, if it is currently open, and save changes if it was opened in ReadWrite mode.
+     * @param options Options for closing the iModel.
+     */
+    close(options) {
         if (!this.isOpen)
             return; // don't continue if already closed
         this.beforeClose();
+        if (options?.optimize)
+            this.optimize();
         IModelDb._openDbs.delete(this._fileKey);
         this._workspace?.close();
         this.locks[_close]();
@@ -292,6 +297,90 @@ export class IModelDb extends IModel {
             this.saveChanges();
         this[_nativeDb].closeFile();
     }
+    /** Optimize this iModel by vacuuming, and analyzing.
+     *
+     * @note This operation requires exclusive access to the database and may take some time on large files.
+     * @beta
+     */
+    optimize() {
+        // Vacuum to reclaim space and defragment
+        this.vacuum();
+        // Analyze to update statistics for query optimizer
+        this.analyze();
+    }
+    /**
+     * Vacuum the model to reclaim space and defragment.
+     * @throws [[IModelError]] if the iModel is not open or is read-only.
+     * @beta
+     */
+    vacuum() {
+        if (!this.isOpen || this.isReadonly)
+            throw new IModelError(IModelStatus.BadRequest, "IModel is not open or is read-only");
+        this[_nativeDb].clearECDbCache();
+        this[_nativeDb].vacuum();
+    }
+    /**
+     * Update SQLite query optimizer statistics for this iModel.
+     * This helps SQLite choose better query plans.
+     *
+     * @throws [[IModelError]] if the iModel is not open or is read-only.
+     * @beta
+     */
+    analyze() {
+        if (!this.isOpen || this.isReadonly)
+            throw new IModelError(IModelStatus.BadRequest, "IModel is not open or is read-only");
+        this[_nativeDb].analyze();
+    }
+    /**
+     * Performs integrity checks on this iModel.
+     * Types of integrity checks that can be performed are:
+     *
+     * Default Check:
+     * - Quick Check: Runs all integrity checks below and returns whether each check passed or failed, without detailed results.
+     *
+     * Specific Checks:
+     * - Data Columns Check: Checks if all the required columns exist in data tables. Issues are returned as a list of those tables/columns.
+     * - EC Profile Check: Checks if the profile table, indexes, and triggers are present. Does not check be_* tables. Issues are returned as a list of tables/indexes/triggers which were not found or have different DDL.
+     * - Navigation Class Ids Check: Checks if RelClassId of a Navigation property is a valid ECClassId. It does not check the value to match the relationship class.
+     * - Navigation Ids Check: Checks if Id of a Navigation property matches a valid row primary class.
+     * - Linktable Foreign Key Class Ids Check: Checks if SourceECClassId or TargetECClassId of a link table matches a valid ECClassId.
+     * - Linktable Foreign Key Ids Check: Checks if SourceECInstanceId or TargetECInstanceId of a link table matches a valid row in primary class.
+     * - Class Ids Check: Checks persisted ECClassId in all data tables and makes sure they are valid.
+     * - Data Schema Check: Checks if all the required data tables and indexes exist for mapped classes. Issues are returned as a list of tables/columns which were not found or have different DDL.
+     * - Schema Load Check: Checks if all schemas can be loaded into memory.
+     * - Missing Child Rows Check: Checks if all child rows have a corresponding parent row.
+     *
+     * @param options Options specifying which integrity checks to perform. If no options are provided or all options are false, a quick check will be performed by default.
+     * @returns An array of integrity check results.
+     * @throws [[IModelError]] if the iModel is not open.
+     * @beta
+     */
+    async integrityCheck(options) {
+        if (!this.isOpen)
+            throw new IModelError(IModelStatus.BadRequest, "IModel is not open");
+        // Default to quick check if no options provided at all, or if not explicitly set and no specific checks are enabled
+        if (!options || (!options.quickCheck && (!options.specificChecks || !Object.values(options.specificChecks).some(Boolean)))) {
+            options = { ...options, quickCheck: true };
+        }
+        const integrityCheckResults = [];
+        // Perform a quick check if requested
+        if (options.quickCheck) {
+            const results = await performQuickIntegrityCheck(this);
+            const passed = results.every((result) => result.passed);
+            integrityCheckResults.push({ check: "Quick Check", passed, results });
+        }
+        // Perform all specific checks requested
+        if (options.specificChecks) {
+            for (const [checkKey, checkParams] of Object.entries(integrityCheckTypeMap)) {
+                if (options.specificChecks[checkKey]) {
+                    const results = await performSpecificIntegrityCheck(this, checkKey);
+                    const passed = results.length === 0;
+                    integrityCheckResults.push({ check: checkParams.name, passed, results });
+                }
+            }
+        }
+        return integrityCheckResults;
+    }
     /** @internal */
     async refreshContainerForRpc(_userAccessToken) { }
     /** Event called when the iModel is about to be closed. */
@@ -3259,11 +3348,11 @@ export class BriefcaseDb extends IModelDb {
         });
         this.txns._onChangesPushed(this.changeset);
     }
-    close() {
+    close(options) {
         if (this.isBriefcase && this.isOpen && !this.isReadonly && this.txns.rebaser.inProgress()) {
             this.abandonChanges();
         }
-        super.close();
+        super.close(options);
         this.onClosed.raiseEvent();
     }
 }