@itwin/core-backend 5.6.0-dev.7 → 5.7.0-dev.1

package/lib/esm/IModelDb.js

@@ -277,11 +277,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 +296,40 @@ 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();
+    }
     /** @internal */
     async refreshContainerForRpc(_userAccessToken) { }
     /** Event called when the iModel is about to be closed. */
@@ -3259,11 +3297,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();
     }
 }