@itwin/core-backend 3.4.0-dev.8 → 3.5.0-dev.4

package/lib/cjs/SQLiteDb.js

@@ -1,212 +1,215 @@
-"use strict";
-/*---------------------------------------------------------------------------------------------
-* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
-* See LICENSE.md in the project root for license terms and full copyright notice.
-*--------------------------------------------------------------------------------------------*/
-/** @packageDocumentation
- * @module SQLiteDb
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.SQLiteDb = void 0;
-const imodeljs_native_1 = require("@bentley/imodeljs-native");
-const core_bentley_1 = require("@itwin/core-bentley");
-const IModelHost_1 = require("./IModelHost");
-const SqliteStatement_1 = require("./SqliteStatement");
-/* eslint-disable @typescript-eslint/unified-signatures */
-/** A SQLiteDb file
- * @public
- */
-class SQLiteDb {
-    constructor() {
-        /** @internal */
-        this.nativeDb = new IModelHost_1.IModelHost.platform.SQLiteDb();
-        this._sqliteStatementCache = new SqliteStatement_1.StatementCache();
-    }
-    /** @internal */
-    static createCloudContainer(args) {
-        return new IModelHost_1.IModelHost.platform.CloudContainer(args);
-    }
-    /** @internal */
-    static createCloudCache(args) {
-        return new IModelHost_1.IModelHost.platform.CloudCache(args);
-    }
-    /** @internal */
-    static startCloudPrefetch(container, dbName, args) {
-        return new IModelHost_1.IModelHost.platform.CloudPrefetch(container, dbName, args);
-    }
-    /** @internal */
-    static createBlobIO() {
-        return new IModelHost_1.IModelHost.platform.BlobIO();
-    }
-    /** alias for closeDb. */
-    dispose() {
-        this.closeDb();
-    }
-    /** Create a SQLiteDb
-     * @param dbName The path to the SQLiteDb file to create.
-     */
-    createDb(dbName, container, params) {
-        this.nativeDb.createDb(dbName, container, params);
-    }
-    /** @internal */
-    openDb(dbName, openMode, container) {
-        this.nativeDb.openDb(dbName, openMode, container);
-    }
-    /** Close SQLiteDb.
-     * @param saveChanges if true, call `saveChanges` before closing db.
-     */
-    closeDb(saveChanges) {
-        if (saveChanges && this.isOpen)
-            this.saveChanges();
-        this._sqliteStatementCache.clear();
-        this.nativeDb.closeDb();
-    }
-    /** Returns true if the SQLiteDb is open */
-    get isOpen() { return this.nativeDb.isOpen(); }
-    /**
-     * 1. open a database
-     * 2. call a function supplying the open SQliteDb as argument. If it is async, await its return.
-     * 3. close the database (even if exceptions are thrown)
-     */
-    static withOpenDb(args, operation) {
-        var _a;
-        const db = new SQLiteDb();
-        db.openDb(args.dbName, (_a = args.openMode) !== null && _a !== void 0 ? _a : core_bentley_1.OpenMode.Readonly, args.container);
-        let fromPromise = false;
-        try {
-            const result = operation(db);
-            if (result instanceof Promise) {
-                fromPromise = true;
-                const doClose = () => db.closeDb();
-                result.then(doClose, doClose);
-            }
-            return result;
-        }
-        finally {
-            if (!fromPromise)
-                db.closeDb();
-        }
-    }
-    /**
-     * 1. acquire the write lock on a CloudContainer
-     * 2. open a ReadWrite database in the container
-     * 3. call a function with the opened database as an argument
-     * 4. close the database
-     * 5. release the write lock and upload changes.
-     * @internal
-     */
-    static async withLockedContainer(args, 
-    /** an asynchronous operation performed on the database with the write lock held. */
-    operation) {
-        const fn = async () => SQLiteDb.withOpenDb({ ...args, openMode: core_bentley_1.OpenMode.ReadWrite }, operation);
-        await imodeljs_native_1.CloudSqlite.withWriteLock(args.user, args.container, fn, args.busyHandler);
-    }
-    /** vacuum this database
-     * @see https://www.sqlite.org/lang_vacuum.html
-     */
-    vacuum(args) {
-        this.nativeDb.vacuum(args);
-    }
-    /** Commit the outermost transaction, writing changes to the file. Then, restart the transaction. */
-    saveChanges() {
-        this.nativeDb.saveChanges();
-    }
-    /** Abandon (cancel) the outermost transaction, discarding all changes since last save. Then, restart the transaction. */
-    abandonChanges() {
-        this.nativeDb.abandonChanges();
-    }
-    /**
-     * Use a prepared SQL statement, potentially from the statement cache. If the requested statement doesn't exist
-     * in the statement cache, a new statement is prepared. After the callback completes, the statement is reset and saved
-     * in the statement cache so it can be reused in the future. Use this method for SQL statements that will be
-     * reused often and are expensive to prepare. The statement cache holds the most recently used statements, discarding
-     * the oldest statements as it fills. For statements you don't intend to reuse, instead use [[withSqliteStatement]].
-     * @param sql The SQLite SQL statement to execute
-     * @param callback the callback to invoke on the prepared statement
-     * @returns the value returned by `callback`.
-     */
-    withPreparedSqliteStatement(sql, callback) {
-        var _a;
-        const stmt = (_a = this._sqliteStatementCache.findAndRemove(sql)) !== null && _a !== void 0 ? _a : this.prepareSqliteStatement(sql);
-        const release = () => this._sqliteStatementCache.addOrDispose(stmt);
-        try {
-            const val = callback(stmt);
-            if (val instanceof Promise) {
-                val.then(release, release);
-            }
-            else {
-                release();
-            }
-            return val;
-        }
-        catch (err) {
-            release();
-            throw err;
-        }
-    }
-    /**
-     * Prepared and execute a callback on a SQL statement. After the callback completes the statement is disposed.
-     * Use this method for SQL statements are either not expected to be reused, or are not expensive to prepare.
-     * For statements that will be reused often, instead use [[withPreparedSqliteStatement]].
-     * @param sql The SQLite SQL statement to execute
-     * @param callback the callback to invoke on the prepared statement
-     * @returns the value returned by `callback`.
-     */
-    withSqliteStatement(sql, callback) {
-        const stmt = this.prepareSqliteStatement(sql);
-        const release = () => stmt.dispose();
-        try {
-            const val = callback(stmt);
-            if (val instanceof Promise) {
-                val.then(release, release);
-            }
-            else {
-                release();
-            }
-            return val;
-        }
-        catch (err) {
-            release();
-            throw err;
-        }
-    }
-    /** Prepare an SQL statement.
-       * @param sql The SQLite SQL statement to prepare
-       * @param logErrors Determine if errors are logged or not
-       * @internal
-       */
-    prepareSqliteStatement(sql, logErrors = true) {
-        const stmt = new SqliteStatement_1.SqliteStatement(sql);
-        stmt.prepare(this.nativeDb, logErrors);
-        return stmt;
-    }
-    /** execute an SQL statement */
-    executeSQL(sql) {
-        const stmt = this.prepareSqliteStatement(sql);
-        try {
-            return stmt.step();
-        }
-        finally {
-            stmt.dispose();
-        }
-    }
-}
-exports.SQLiteDb = SQLiteDb;
-/** @public */
-(function (SQLiteDb) {
-    /** Default transaction mode for SQLiteDbs.
-       * @see https://www.sqlite.org/lang_transaction.html
-      */
-    let DefaultTxnMode;
-    (function (DefaultTxnMode) {
-        /** no default transaction is started. You must use BEGIN/COMMIT or SQLite will use implicit transactions */
-        DefaultTxnMode[DefaultTxnMode["None"] = 0] = "None";
-        /** A deferred transaction is started when the file is first opened. This is the default. */
-        DefaultTxnMode[DefaultTxnMode["Deferred"] = 1] = "Deferred";
-        /** An immediate transaction is started when the file is first opened. */
-        DefaultTxnMode[DefaultTxnMode["Immediate"] = 2] = "Immediate";
-        /** An exclusive transaction is started when the file is first opened. */
-        DefaultTxnMode[DefaultTxnMode["Exclusive"] = 3] = "Exclusive";
-    })(DefaultTxnMode = SQLiteDb.DefaultTxnMode || (SQLiteDb.DefaultTxnMode = {}));
-})(SQLiteDb = exports.SQLiteDb || (exports.SQLiteDb = {}));
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module SQLiteDb
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SQLiteDb = void 0;
+const core_bentley_1 = require("@itwin/core-bentley");
+const CloudSqlite_1 = require("./CloudSqlite");
+const IModelHost_1 = require("./IModelHost");
+const SqliteStatement_1 = require("./SqliteStatement");
+// cspell:ignore savepoint
+/* eslint-disable @typescript-eslint/unified-signatures */
+/** A SQLiteDb file
+ * @public
+ */
+class SQLiteDb {
+    constructor() {
+        /** @internal */
+        this.nativeDb = new IModelHost_1.IModelHost.platform.SQLiteDb();
+        this._sqliteStatementCache = new SqliteStatement_1.StatementCache();
+    }
+    /** @internal */
+    static createBlobIO() {
+        return new IModelHost_1.IModelHost.platform.BlobIO();
+    }
+    /** alias for closeDb. */
+    dispose() {
+        this.closeDb();
+    }
+    /** @internal */
+    createDb(dbName, container, params) {
+        this.nativeDb.createDb(dbName, container, params);
+    }
+    /** @internal */
+    openDb(dbName, openMode, container) {
+        this.nativeDb.openDb(dbName, openMode, container);
+    }
+    /** Close SQLiteDb.
+     * @param saveChanges if true, call `saveChanges` before closing db. Otherwise unsaved changes are abandoned.
+     */
+    closeDb(saveChanges) {
+        if (saveChanges && this.isOpen)
+            this.saveChanges();
+        this._sqliteStatementCache.clear();
+        this.nativeDb.closeDb();
+    }
+    /** Returns true if this SQLiteDb is open */
+    get isOpen() { return this.nativeDb.isOpen(); }
+    /** Returns true if this SQLiteDb is open readonly */
+    get isReadonly() { return this.nativeDb.isReadonly(); }
+    /**
+     * Open a database, perform an operation, then close the database.
+     *
+     * Details:
+     * - if database is open, throw an error
+     * - open a database
+     * - call a function with the database opened. If it is async, await its return.
+     * - if function throws, abandon all changes, close database, and rethrow
+     * - save all changes
+     * - close the database
+     * @return value from operation
+     */
+    withOpenDb(args, operation) {
+        var _a;
+        if (this.isOpen)
+            throw new Error("database is already open");
+        const save = () => this.closeDb(true), abandon = () => this.closeDb(false);
+        this.openDb(args.dbName, (_a = args.openMode) !== null && _a !== void 0 ? _a : core_bentley_1.OpenMode.Readonly, args.container);
+        try {
+            const result = operation();
+            result instanceof Promise ? result.then(save, abandon) : save();
+            return result;
+        }
+        catch (e) {
+            abandon();
+            throw e;
+        }
+    }
+    /**
+     * Perform an operation on a database in a CloudContainer with the write lock held.
+     *
+     * Details:
+     * - acquire the write lock on a CloudContainer
+     * - call `withOpenDb` with openMode `ReadWrite`
+     * - upload changes
+     * - release the write lock
+     * @param args arguments to lock the container and open the database
+     * @param operation an operation performed on the database with the write lock held.
+     * @return value from operation
+     * @internal
+     */
+    async withLockedContainer(args, operation) {
+        return CloudSqlite_1.CloudSqlite.withWriteLock(args.user, args.container, () => this.withOpenDb({ ...args, openMode: core_bentley_1.OpenMode.ReadWrite }, operation), args.busyHandler);
+    }
+    /** vacuum this database
+     * @see https://www.sqlite.org/lang_vacuum.html
+     */
+    vacuum(args) {
+        this.nativeDb.vacuum(args);
+    }
+    /** Commit the outermost transaction, writing changes to the file. Then, restart the transaction. */
+    saveChanges() {
+        this.nativeDb.saveChanges();
+    }
+    /** Abandon (cancel) the outermost transaction, discarding all changes since last save. Then, restart the transaction. */
+    abandonChanges() {
+        this.nativeDb.abandonChanges();
+    }
+    /**
+     * Use a prepared SQL statement, potentially from the statement cache. If the requested statement doesn't exist
+     * in the statement cache, a new statement is prepared. After the callback completes, the statement is reset and saved
+     * in the statement cache so it can be reused in the future. Use this method for SQL statements that will be
+     * reused often and are expensive to prepare. The statement cache holds the most recently used statements, discarding
+     * the oldest statements as it fills. For statements you don't intend to reuse, instead use [[withSqliteStatement]].
+     * @param sql The SQLite SQL statement to execute
+     * @param callback the callback to invoke on the prepared statement
+     * @returns the value returned by `callback`.
+     */
+    withPreparedSqliteStatement(sql, callback) {
+        var _a;
+        const stmt = (_a = this._sqliteStatementCache.findAndRemove(sql)) !== null && _a !== void 0 ? _a : this.prepareSqliteStatement(sql);
+        const release = () => this._sqliteStatementCache.addOrDispose(stmt);
+        try {
+            const val = callback(stmt);
+            val instanceof Promise ? val.then(release, release) : release();
+            return val;
+        }
+        catch (err) {
+            release();
+            throw err;
+        }
+    }
+    /**
+     * Prepared and execute a callback on a SQL statement. After the callback completes the statement is disposed.
+     * Use this method for SQL statements are either not expected to be reused, or are not expensive to prepare.
+     * For statements that will be reused often, instead use [[withPreparedSqliteStatement]].
+     * @param sql The SQLite SQL statement to execute
+     * @param callback the callback to invoke on the prepared statement
+     * @returns the value returned by `callback`.
+     */
+    withSqliteStatement(sql, callback) {
+        const stmt = this.prepareSqliteStatement(sql);
+        const release = () => stmt.dispose();
+        try {
+            const val = callback(stmt);
+            val instanceof Promise ? val.then(release, release) : release();
+            return val;
+        }
+        catch (err) {
+            release();
+            throw err;
+        }
+    }
+    /**
+     * Perform an operation on this database within a [savepoint](https://www.sqlite.org/lang_savepoint.html). If the operation completes successfully, the
+     * changes remain in the current transaction. If the operation throws an exception, the savepoint is rolled back
+     * and all changes to the database from this method are reversed, leaving the transaction exactly as it was before this method.
+     */
+    withSavePoint(savePointName, operation) {
+        if (this.isReadonly)
+            throw new Error("database is readonly");
+        this.executeSQL(`SAVEPOINT ${savePointName}`);
+        try {
+            operation();
+            this.executeSQL(`RELEASE ${savePointName}`);
+        }
+        catch (e) {
+            this.executeSQL(`ROLLBACK TO ${savePointName}`);
+            throw e;
+        }
+    }
+    /** Prepare an SQL statement.
+       * @param sql The SQLite SQL statement to prepare
+       * @param logErrors Determine if errors are logged or not
+       * @internal
+       */
+    prepareSqliteStatement(sql, logErrors = true) {
+        const stmt = new SqliteStatement_1.SqliteStatement(sql);
+        stmt.prepare(this.nativeDb, logErrors);
+        return stmt;
+    }
+    /** execute an SQL statement */
+    executeSQL(sql) {
+        const stmt = this.prepareSqliteStatement(sql);
+        try {
+            return stmt.step();
+        }
+        finally {
+            stmt.dispose();
+        }
+    }
+}
+exports.SQLiteDb = SQLiteDb;
+/** @public */
+(function (SQLiteDb) {
+    /** Default transaction mode for SQLiteDbs.
+     * @see https://www.sqlite.org/lang_transaction.html
+     */
+    let DefaultTxnMode;
+    (function (DefaultTxnMode) {
+        /** no default transaction is started. You must use BEGIN/COMMIT or SQLite will use implicit transactions */
+        DefaultTxnMode[DefaultTxnMode["None"] = 0] = "None";
+        /** A deferred transaction is started when the file is first opened. This is the default. */
+        DefaultTxnMode[DefaultTxnMode["Deferred"] = 1] = "Deferred";
+        /** An immediate transaction is started when the file is first opened. */
+        DefaultTxnMode[DefaultTxnMode["Immediate"] = 2] = "Immediate";
+        /** An exclusive transaction is started when the file is first opened. */
+        DefaultTxnMode[DefaultTxnMode["Exclusive"] = 3] = "Exclusive";
+    })(DefaultTxnMode = SQLiteDb.DefaultTxnMode || (SQLiteDb.DefaultTxnMode = {}));
+})(SQLiteDb = exports.SQLiteDb || (exports.SQLiteDb = {}));
 //# sourceMappingURL=SQLiteDb.js.map

package/lib/cjs/SQLiteDb.js.map

@@ -1 +1 @@
-{"version":3,"file":"SQLiteDb.js","sourceRoot":"","sources":["../../src/SQLiteDb.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,8DAAuE;AACvE,sDAAsE;AAEtE,6CAA0C;AAC1C,uDAAoE;AAEpE,0DAA0D;AAE1D;;GAEG;AACH,MAAa,QAAQ;IAArB;QACE,gBAAgB;QACA,aAAQ,GAAG,IAAI,uBAAU,CAAC,QAAQ,CAAC,QAAQ,EAAE,CAAC;QACtD,0BAAqB,GAAG,IAAI,gCAAc,EAAmB,CAAC;IAmNxE,CAAC;IAjNC,gBAAgB;IACT,MAAM,CAAC,oBAAoB,CAAC,IAAsC;QACvE,OAAO,IAAI,uBAAU,CAAC,QAAQ,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;IACtD,CAAC;IACD,gBAAgB;IACT,MAAM,CAAC,gBAAgB,CAAC,IAA4B;QACzD,OAAO,IAAI,uBAAU,CAAC,QAAQ,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;IAClD,CAAC;IACD,gBAAgB;IACT,MAAM,CAAC,kBAAkB,CAAC,SAAkC,EAAE,MAAc,EAAE,IAAgC;QACnH,OAAO,IAAI,uBAAU,CAAC,QAAQ,CAAC,aAAa,CAAC,SAAS,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC;IACxE,CAAC;IACD,gBAAgB;IACT,MAAM,CAAC,YAAY;QACxB,OAAO,IAAI,uBAAU,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC;IAC1C,CAAC;IAED,yBAAyB;IAClB,OAAO;QACZ,IAAI,CAAC,OAAO,EAAE,CAAC;IACjB,CAAC;IAED;;OAEG;IACI,QAAQ,CAAC,MAAc,EAAE,SAAmC,EAAE,MAA8B;QACjG,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,MAAM,EAAE,SAAS,EAAE,MAAM,CAAC,CAAC;IACpD,CAAC;IAYD,gBAAgB;IACT,MAAM,CAAC,MAAc,EAAE,QAAwC,EAAE,SAAmC;QACzG,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,QAAQ,EAAE,SAAS,CAAC,CAAC;IACpD,CAAC;IAED;;OAEG;IACI,OAAO,CAAC,WAAqB;QAClC,IAAI,WAAW,IAAI,IAAI,CAAC,MAAM;YAC5B,IAAI,CAAC,WAAW,EAAE,CAAC;QACrB,IAAI,CAAC,qBAAqB,CAAC,KAAK,EAAE,CAAC;QACnC,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE,CAAC;IAC1B,CAAC;IAED,2CAA2C;IAC3C,IAAW,MAAM,KAAc,OAAO,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;IAE/D;;;;OAIG;IACI,MAAM,CAAC,UAAU,CAAI,IAO3B,EAAE,SAA8B;;QAC/B,MAAM,EAAE,GAAG,IAAI,QAAQ,EAAE,CAAC;QAC1B,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,EAAE,MAAA,IAAI,CAAC,QAAQ,mCAAI,uBAAQ,CAAC,QAAQ,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;QAC3E,IAAI,WAAW,GAAG,KAAK,CAAC;QAExB,IAAI;YACF,MAAM,MAAM,GAAG,SAAS,CAAC,EAAE,CAAC,CAAC;YAC7B,IAAI,MAAM,YAAY,OAAO,EAAE;gBAC7B,WAAW,GAAG,IAAI,CAAC;gBACnB,MAAM,OAAO,GAAG,GAAG,EAAE,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC;gBACnC,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;aAC/B;YACD,OAAO,MAAM,CAAC;SACf;gBAAS;YACR,IAAI,CAAC,WAAW;gBACd,EAAE,CAAC,OAAO,EAAE,CAAC;SAChB;IACH,CAAC;IAED;;;;;;;OAOG;IACI,MAAM,CAAC,KAAK,CAAC,mBAAmB,CACrC,IASC;IACD,oFAAoF;IACpF,SAA0C;QAC1C,MAAM,EAAE,GAAG,KAAK,IAAI,EAAE,CAAC,QAAQ,CAAC,UAAU,CAAC,EAAE,GAAG,IAAI,EAAE,QAAQ,EAAE,uBAAQ,CAAC,SAAS,EAAE,EAAE,SAAS,CAAC,CAAC;QACjG,MAAM,6BAAW,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,SAAS,EAAE,EAAE,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;IACnF,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,IAOb;QACC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IAC7B,CAAC;IAED,oGAAoG;IAC7F,WAAW;QAChB,IAAI,CAAC,QAAQ,CAAC,WAAW,EAAE,CAAC;IAC9B,CAAC;IAED,yHAAyH;IAClH,cAAc;QACnB,IAAI,CAAC,QAAQ,CAAC,cAAc,EAAE,CAAC;IACjC,CAAC;IAED;;;;;;;;;OASG;IACI,2BAA2B,CAAI,GAAW,EAAE,QAAsC;;QACvF,MAAM,IAAI,GAAG,MAAA,IAAI,CAAC,qBAAqB,CAAC,aAAa,CAAC,GAAG,CAAC,mCAAI,IAAI,CAAC,sBAAsB,CAAC,GAAG,CAAC,CAAC;QAC/F,MAAM,OAAO,GAAG,GAAG,EAAE,CAAC,IAAI,CAAC,qBAAqB,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;QACpE,IAAI;YACF,MAAM,GAAG,GAAM,QAAQ,CAAC,IAAI,CAAC,CAAC;YAC9B,IAAI,GAAG,YAAY,OAAO,EAAE;gBAC1B,GAAG,CAAC,IAAI,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;aAC5B;iBAAM;gBACL,OAAO,EAAE,CAAC;aACX;YACD,OAAO,GAAG,CAAC;SACZ;QAAC,OAAO,GAAG,EAAE;YACZ,OAAO,EAAE,CAAC;YACV,MAAM,GAAG,CAAC;SACX;IACH,CAAC;IAED;;;;;;;OAOG;IACI,mBAAmB,CAAI,GAAW,EAAE,QAAsC;QAC/E,MAAM,IAAI,GAAG,IAAI,CAAC,sBAAsB,CAAC,GAAG,CAAC,CAAC;QAC9C,MAAM,OAAO,GAAG,GAAG,EAAE,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC;QACrC,IAAI;YACF,MAAM,GAAG,GAAM,QAAQ,CAAC,IAAI,CAAC,CAAC;YAC9B,IAAI,GAAG,YAAY,OAAO,EAAE;gBAC1B,GAAG,CAAC,IAAI,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;aAC5B;iBAAM;gBACL,OAAO,EAAE,CAAC;aACX;YACD,OAAO,GAAG,CAAC;SACZ;QAAC,OAAO,GAAG,EAAE;YACZ,OAAO,EAAE,CAAC;YACV,MAAM,GAAG,CAAC;SACX;IACH,CAAC;IAED;;;;SAIK;IACE,sBAAsB,CAAC,GAAW,EAAE,SAAS,GAAG,IAAI;QACzD,MAAM,IAAI,GAAG,IAAI,iCAAe,CAAC,GAAG,CAAC,CAAC;QACtC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC;QACvC,OAAO,IAAI,CAAC;IACd,CAAC;IAED,+BAA+B;IACxB,UAAU,CAAC,GAAW;QAC3B,MAAM,IAAI,GAAG,IAAI,CAAC,sBAAsB,CAAC,GAAG,CAAC,CAAC;QAC9C,IAAI;YACF,OAAO,IAAI,CAAC,IAAI,EAAE,CAAC;SACpB;gBAAS;YACR,IAAI,CAAC,OAAO,EAAE,CAAC;SAChB;IACH,CAAC;CACF;AAtND,4BAsNC;AAED,cAAc;AACd,WAAiB,QAAQ;IAcvB;;QAEI;IACJ,IAAY,cASX;IATD,WAAY,cAAc;QACxB,4GAA4G;QAC5G,mDAAQ,CAAA;QACR,4FAA4F;QAC5F,2DAAY,CAAA;QACZ,yEAAyE;QACzE,6DAAa,CAAA;QACb,yEAAyE;QACzE,6DAAa,CAAA;IACf,CAAC,EATW,cAAc,GAAd,uBAAc,KAAd,uBAAc,QASzB;AA8BH,CAAC,EAxDgB,QAAQ,GAAR,gBAAQ,KAAR,gBAAQ,QAwDxB","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module SQLiteDb\r\n */\r\n\r\nimport { CloudSqlite, IModelJsNative } from \"@bentley/imodeljs-native\";\r\nimport { DbResult, IDisposable, OpenMode } from \"@itwin/core-bentley\";\r\nimport { LocalFileName } from \"@itwin/core-common\";\r\nimport { IModelHost } from \"./IModelHost\";\r\nimport { SqliteStatement, StatementCache } from \"./SqliteStatement\";\r\n\r\n/* eslint-disable @typescript-eslint/unified-signatures */\r\n\r\n/** A SQLiteDb file\r\n * @public\r\n */\r\nexport class SQLiteDb implements IDisposable {\r\n  /** @internal */\r\n  public readonly nativeDb = new IModelHost.platform.SQLiteDb();\r\n  private _sqliteStatementCache = new StatementCache<SqliteStatement>();\r\n\r\n  /** @internal */\r\n  public static createCloudContainer(args: CloudSqlite.ContainerAccessProps): SQLiteDb.CloudContainer {\r\n    return new IModelHost.platform.CloudContainer(args);\r\n  }\r\n  /** @internal */\r\n  public static createCloudCache(args: CloudSqlite.CacheProps): SQLiteDb.CloudCache {\r\n    return new IModelHost.platform.CloudCache(args);\r\n  }\r\n  /** @internal */\r\n  public static startCloudPrefetch(container: SQLiteDb.CloudContainer, dbName: string, args?: CloudSqlite.PrefetchProps): SQLiteDb.CloudPrefetch {\r\n    return new IModelHost.platform.CloudPrefetch(container, dbName, args);\r\n  }\r\n  /** @internal */\r\n  public static createBlobIO(): SQLiteDb.BlobIO {\r\n    return new IModelHost.platform.BlobIO();\r\n  }\r\n\r\n  /** alias for closeDb. */\r\n  public dispose(): void {\r\n    this.closeDb();\r\n  }\r\n\r\n  /** Create a SQLiteDb\r\n   * @param dbName The path to the SQLiteDb file to create.\r\n   */\r\n  public createDb(dbName: string, container?: SQLiteDb.CloudContainer, params?: SQLiteDb.CreateParams): void {\r\n    this.nativeDb.createDb(dbName, container, params);\r\n  }\r\n\r\n  /** Open a SQLiteDb.\r\n   * @param dbName The path to the SQLiteDb file to open\r\n   */\r\n  public openDb(dbName: string, openMode: OpenMode | SQLiteDb.OpenParams): void;\r\n  /**\r\n   * @param container optional CloudContainer holding database\r\n   * @internal\r\n   */\r\n  public openDb(dbName: string, openMode: OpenMode | SQLiteDb.OpenParams, container?: SQLiteDb.CloudContainer): void;\r\n\r\n  /** @internal */\r\n  public openDb(dbName: string, openMode: OpenMode | SQLiteDb.OpenParams, container?: SQLiteDb.CloudContainer): void {\r\n    this.nativeDb.openDb(dbName, openMode, container);\r\n  }\r\n\r\n  /** Close SQLiteDb.\r\n   * @param saveChanges if true, call `saveChanges` before closing db.\r\n   */\r\n  public closeDb(saveChanges?: boolean): void {\r\n    if (saveChanges && this.isOpen)\r\n      this.saveChanges();\r\n    this._sqliteStatementCache.clear();\r\n    this.nativeDb.closeDb();\r\n  }\r\n\r\n  /** Returns true if the SQLiteDb is open */\r\n  public get isOpen(): boolean { return this.nativeDb.isOpen(); }\r\n\r\n  /**\r\n   * 1. open a database\r\n   * 2. call a function supplying the open SQliteDb as argument. If it is async, await its return.\r\n   * 3. close the database (even if exceptions are thrown)\r\n   */\r\n  public static withOpenDb<T>(args: {\r\n    /** The name of the database to open */\r\n    dbName: string;\r\n    /** either an object with the open parameters or just OpenMode value. */\r\n    openMode?: OpenMode | SQLiteDb.OpenParams;\r\n    /** @internal */\r\n    container?: SQLiteDb.CloudContainer;\r\n  }, operation: (db: SQLiteDb) => T): T {\r\n    const db = new SQLiteDb();\r\n    db.openDb(args.dbName, args.openMode ?? OpenMode.Readonly, args.container);\r\n    let fromPromise = false;\r\n\r\n    try {\r\n      const result = operation(db);\r\n      if (result instanceof Promise) {\r\n        fromPromise = true;\r\n        const doClose = () => db.closeDb();\r\n        result.then(doClose, doClose);\r\n      }\r\n      return result;\r\n    } finally {\r\n      if (!fromPromise)\r\n        db.closeDb();\r\n    }\r\n  }\r\n\r\n  /**\r\n   * 1. acquire the write lock on a CloudContainer\r\n   * 2. open a ReadWrite database in the container\r\n   * 3. call a function with the opened database as an argument\r\n   * 4. close the database\r\n   * 5. release the write lock and upload changes.\r\n   * @internal\r\n   */\r\n  public static async withLockedContainer(\r\n    args: {\r\n      /** the name to be displayed in the event of lock collisions */\r\n      user: string;\r\n      /** the name of the database within the container */\r\n      dbName: string;\r\n      /** the CloudContainer on which the operation will be performed */\r\n      container: SQLiteDb.CloudContainer;\r\n      /** if present, function called when the write lock is currently held by another user. */\r\n      busyHandler?: CloudSqlite.WriteLockBusyHandler;\r\n    },\r\n    /** an asynchronous operation performed on the database with the write lock held. */\r\n    operation: (db: SQLiteDb) => Promise<void>) {\r\n    const fn = async () => SQLiteDb.withOpenDb({ ...args, openMode: OpenMode.ReadWrite }, operation);\r\n    await CloudSqlite.withWriteLock(args.user, args.container, fn, args.busyHandler);\r\n  }\r\n\r\n  /** vacuum this database\r\n   * @see https://www.sqlite.org/lang_vacuum.html\r\n   */\r\n  public vacuum(args?: {\r\n    /** new page size\r\n     * @see https://www.sqlite.org/pragma.html#pragma_page_size\r\n     */\r\n    pageSize?: number;\r\n    /** if present, name of new file to vacuum into */\r\n    into?: LocalFileName;\r\n  }) {\r\n    this.nativeDb.vacuum(args);\r\n  }\r\n\r\n  /** Commit the outermost transaction, writing changes to the file. Then, restart the transaction. */\r\n  public saveChanges(): void {\r\n    this.nativeDb.saveChanges();\r\n  }\r\n\r\n  /** Abandon (cancel) the outermost transaction, discarding all changes since last save. Then, restart the transaction. */\r\n  public abandonChanges(): void {\r\n    this.nativeDb.abandonChanges();\r\n  }\r\n\r\n  /**\r\n   * Use a prepared SQL statement, potentially from the statement cache. If the requested statement doesn't exist\r\n   * in the statement cache, a new statement is prepared. After the callback completes, the statement is reset and saved\r\n   * in the statement cache so it can be reused in the future. Use this method for SQL statements that will be\r\n   * reused often and are expensive to prepare. The statement cache holds the most recently used statements, discarding\r\n   * the oldest statements as it fills. For statements you don't intend to reuse, instead use [[withSqliteStatement]].\r\n   * @param sql The SQLite SQL statement to execute\r\n   * @param callback the callback to invoke on the prepared statement\r\n   * @returns the value returned by `callback`.\r\n   */\r\n  public withPreparedSqliteStatement<T>(sql: string, callback: (stmt: SqliteStatement) => T): T {\r\n    const stmt = this._sqliteStatementCache.findAndRemove(sql) ?? this.prepareSqliteStatement(sql);\r\n    const release = () => this._sqliteStatementCache.addOrDispose(stmt);\r\n    try {\r\n      const val: T = callback(stmt);\r\n      if (val instanceof Promise) {\r\n        val.then(release, release);\r\n      } else {\r\n        release();\r\n      }\r\n      return val;\r\n    } catch (err) {\r\n      release();\r\n      throw err;\r\n    }\r\n  }\r\n\r\n  /**\r\n   * Prepared and execute a callback on a SQL statement. After the callback completes the statement is disposed.\r\n   * Use this method for SQL statements are either not expected to be reused, or are not expensive to prepare.\r\n   * For statements that will be reused often, instead use [[withPreparedSqliteStatement]].\r\n   * @param sql The SQLite SQL statement to execute\r\n   * @param callback the callback to invoke on the prepared statement\r\n   * @returns the value returned by `callback`.\r\n   */\r\n  public withSqliteStatement<T>(sql: string, callback: (stmt: SqliteStatement) => T): T {\r\n    const stmt = this.prepareSqliteStatement(sql);\r\n    const release = () => stmt.dispose();\r\n    try {\r\n      const val: T = callback(stmt);\r\n      if (val instanceof Promise) {\r\n        val.then(release, release);\r\n      } else {\r\n        release();\r\n      }\r\n      return val;\r\n    } catch (err) {\r\n      release();\r\n      throw err;\r\n    }\r\n  }\r\n\r\n  /** Prepare an SQL statement.\r\n     * @param sql The SQLite SQL statement to prepare\r\n     * @param logErrors Determine if errors are logged or not\r\n     * @internal\r\n     */\r\n  public prepareSqliteStatement(sql: string, logErrors = true): SqliteStatement {\r\n    const stmt = new SqliteStatement(sql);\r\n    stmt.prepare(this.nativeDb, logErrors);\r\n    return stmt;\r\n  }\r\n\r\n  /** execute an SQL statement */\r\n  public executeSQL(sql: string): DbResult {\r\n    const stmt = this.prepareSqliteStatement(sql);\r\n    try {\r\n      return stmt.step();\r\n    } finally {\r\n      stmt.dispose();\r\n    }\r\n  }\r\n}\r\n\r\n/** @public */\r\nexport namespace SQLiteDb {\r\n  /** A CloudSqlite container that may be connected to a CloudCache.\r\n   * @internal\r\n   */\r\n  export type CloudContainer = IModelJsNative.CloudContainer;\r\n  /** @internal */\r\n  export type CloudCache = IModelJsNative.CloudCache;\r\n  /** @internal */\r\n  export type CloudPrefetch = IModelJsNative.CloudPrefetch;\r\n  /** Incremental IO for blobs\r\n   * @internal\r\n   */\r\n  export type BlobIO = IModelJsNative.BlobIO;\r\n\r\n  /** Default transaction mode for SQLiteDbs.\r\n     * @see https://www.sqlite.org/lang_transaction.html\r\n    */\r\n  export enum DefaultTxnMode {\r\n    /** no default transaction is started. You must use BEGIN/COMMIT or SQLite will use implicit transactions */\r\n    None = 0,\r\n    /** A deferred transaction is started when the file is first opened. This is the default. */\r\n    Deferred = 1,\r\n    /** An immediate transaction is started when the file is first opened. */\r\n    Immediate = 2,\r\n    /** An exclusive transaction is started when the file is first opened. */\r\n    Exclusive = 3\r\n  }\r\n\r\n  /** parameters common to opening or creating a new SQLiteDb */\r\n  export interface OpenOrCreateParams {\r\n    /** If true, do not require that the `be_Prop` table exist */\r\n    rawSQLite?: boolean;\r\n    /** @see immutable option at https://www.sqlite.org/c3ref/open.html */\r\n    immutable?: boolean;\r\n    /** Do not attempt to verify that the file is a valid sQLite file before opening. */\r\n    skipFileCheck?: boolean;\r\n    /** the default transaction mode\r\n     * @see [[SQLiteDb.DefaultTxnMode]]\r\n    */\r\n    defaultTxn?: 0 | 1 | 2 | 3;\r\n    /** see query parameters from 'URI Filenames' in  https://www.sqlite.org/c3ref/open.html */\r\n    queryParam?: string;\r\n  }\r\n\r\n  /** Parameters for opening an existing SQLiteDb */\r\n  export interface OpenParams extends OpenOrCreateParams {\r\n    /** use OpenMode.ReadWrite to open the file with write access */\r\n    openMode: OpenMode;\r\n  }\r\n\r\n  /** Parameters for creating a new SQLiteDb */\r\n  export interface CreateParams extends OpenOrCreateParams {\r\n    /** see https://www.sqlite.org/pragma.html#pragma_page_size */\r\n    pageSize?: number;\r\n  }\r\n\r\n}\r\n"]}
+{"version":3,"file":"SQLiteDb.js","sourceRoot":"","sources":["../../src/SQLiteDb.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAGH,sDAAsE;AAEtE,+CAA4C;AAC5C,6CAA0C;AAC1C,uDAAoE;AAEpE,0BAA0B;AAC1B,0DAA0D;AAE1D;;GAEG;AACH,MAAa,QAAQ;IAArB;QACE,gBAAgB;QACA,aAAQ,GAAG,IAAI,uBAAU,CAAC,QAAQ,CAAC,QAAQ,EAAE,CAAC;QACtD,0BAAqB,GAAG,IAAI,gCAAc,EAAmB,CAAC;IAuMxE,CAAC;IArMC,gBAAgB;IACT,MAAM,CAAC,YAAY;QACxB,OAAO,IAAI,uBAAU,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC;IAC1C,CAAC;IAED,yBAAyB;IAClB,OAAO;QACZ,IAAI,CAAC,OAAO,EAAE,CAAC;IACjB,CAAC;IAQD,gBAAgB;IACT,QAAQ,CAAC,MAAc,EAAE,SAAsC,EAAE,MAA8B;QACpG,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,MAAM,EAAE,SAAS,EAAE,MAAM,CAAC,CAAC;IACpD,CAAC;IAYD,gBAAgB;IACT,MAAM,CAAC,MAAc,EAAE,QAAwC,EAAE,SAAsC;QAC5G,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,QAAQ,EAAE,SAAS,CAAC,CAAC;IACpD,CAAC;IAED;;OAEG;IACI,OAAO,CAAC,WAAqB;QAClC,IAAI,WAAW,IAAI,IAAI,CAAC,MAAM;YAC5B,IAAI,CAAC,WAAW,EAAE,CAAC;QACrB,IAAI,CAAC,qBAAqB,CAAC,KAAK,EAAE,CAAC;QACnC,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE,CAAC;IAC1B,CAAC;IAED,4CAA4C;IAC5C,IAAW,MAAM,KAAc,OAAO,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;IAE/D,qDAAqD;IACrD,IAAW,UAAU,KAAc,OAAO,IAAI,CAAC,QAAQ,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC;IAEvE;;;;;;;;;;;OAWG;IACI,UAAU,CAAI,IAA6B,EAAE,SAAkB;;QACpE,IAAI,IAAI,CAAC,MAAM;YACb,MAAM,IAAI,KAAK,CAAC,0BAA0B,CAAC,CAAC;QAE9C,MAAM,IAAI,GAAG,GAAG,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,OAAO,GAAG,GAAG,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QAC3E,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,EAAE,MAAA,IAAI,CAAC,QAAQ,mCAAI,uBAAQ,CAAC,QAAQ,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;QAC7E,IAAI;YACF,MAAM,MAAM,GAAG,SAAS,EAAE,CAAC;YAC3B,MAAM,YAAY,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;YAChE,OAAO,MAAM,CAAC;SACf;QAAC,OAAO,CAAC,EAAE;YACV,OAAO,EAAE,CAAC;YACV,MAAM,CAAC,CAAC;SACT;IACH,CAAC;IAED;;;;;;;;;;;;OAYG;IACI,KAAK,CAAC,mBAAmB,CAAI,IAAiC,EAAE,SAAkB;QACvF,OAAO,yBAAW,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,SAAS,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE,GAAG,IAAI,EAAE,QAAQ,EAAE,uBAAQ,CAAC,SAAS,EAAE,EAAE,SAAS,CAAC,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;IAC7J,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,IAA4B;QACxC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IAC7B,CAAC;IAED,oGAAoG;IAC7F,WAAW;QAChB,IAAI,CAAC,QAAQ,CAAC,WAAW,EAAE,CAAC;IAC9B,CAAC;IAED,yHAAyH;IAClH,cAAc;QACnB,IAAI,CAAC,QAAQ,CAAC,cAAc,EAAE,CAAC;IACjC,CAAC;IAED;;;;;;;;;OASG;IACI,2BAA2B,CAAI,GAAW,EAAE,QAAsC;;QACvF,MAAM,IAAI,GAAG,MAAA,IAAI,CAAC,qBAAqB,CAAC,aAAa,CAAC,GAAG,CAAC,mCAAI,IAAI,CAAC,sBAAsB,CAAC,GAAG,CAAC,CAAC;QAC/F,MAAM,OAAO,GAAG,GAAG,EAAE,CAAC,IAAI,CAAC,qBAAqB,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;QACpE,IAAI;YACF,MAAM,GAAG,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC;YAC3B,GAAG,YAAY,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC;YAChE,OAAO,GAAG,CAAC;SACZ;QAAC,OAAO,GAAG,EAAE;YACZ,OAAO,EAAE,CAAC;YACV,MAAM,GAAG,CAAC;SACX;IACH,CAAC;IAED;;;;;;;OAOG;IACI,mBAAmB,CAAI,GAAW,EAAE,QAAsC;QAC/E,MAAM,IAAI,GAAG,IAAI,CAAC,sBAAsB,CAAC,GAAG,CAAC,CAAC;QAC9C,MAAM,OAAO,GAAG,GAAG,EAAE,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC;QACrC,IAAI;YACF,MAAM,GAAG,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC;YAC3B,GAAG,YAAY,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC;YAChE,OAAO,GAAG,CAAC;SACZ;QAAC,OAAO,GAAG,EAAE;YACZ,OAAO,EAAE,CAAC;YACV,MAAM,GAAG,CAAC;SACX;IACH,CAAC;IAED;;;;OAIG;IACI,aAAa,CAAC,aAAqB,EAAE,SAAqB;QAC/D,IAAI,IAAI,CAAC,UAAU;YACjB,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC;QAE1C,IAAI,CAAC,UAAU,CAAC,aAAa,aAAa,EAAE,CAAC,CAAC;QAC9C,IAAI;YACF,SAAS,EAAE,CAAC;YACZ,IAAI,CAAC,UAAU,CAAC,WAAW,aAAa,EAAE,CAAC,CAAC;SAC7C;QAAC,OAAO,CAAC,EAAE;YACV,IAAI,CAAC,UAAU,CAAC,eAAe,aAAa,EAAE,CAAC,CAAC;YAChD,MAAM,CAAC,CAAC;SACT;IACH,CAAC;IAED;;;;SAIK;IACE,sBAAsB,CAAC,GAAW,EAAE,SAAS,GAAG,IAAI;QACzD,MAAM,IAAI,GAAG,IAAI,iCAAe,CAAC,GAAG,CAAC,CAAC;QACtC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC;QACvC,OAAO,IAAI,CAAC;IACd,CAAC;IAED,+BAA+B;IACxB,UAAU,CAAC,GAAW;QAC3B,MAAM,IAAI,GAAG,IAAI,CAAC,sBAAsB,CAAC,GAAG,CAAC,CAAC;QAC9C,IAAI;YACF,OAAO,IAAI,CAAC,IAAI,EAAE,CAAC;SACpB;gBAAS;YACR,IAAI,CAAC,OAAO,EAAE,CAAC;SAChB;IACH,CAAC;CACF;AA1MD,4BA0MC;AAED,cAAc;AACd,WAAiB,QAAQ;IAqDvB;;OAEG;IACH,IAAY,cASX;IATD,WAAY,cAAc;QACxB,4GAA4G;QAC5G,mDAAQ,CAAA;QACR,4FAA4F;QAC5F,2DAAY,CAAA;QACZ,yEAAyE;QACzE,6DAAa,CAAA;QACb,yEAAyE;QACzE,6DAAa,CAAA;IACf,CAAC,EATW,cAAc,GAAd,uBAAc,KAAd,uBAAc,QASzB;AAgDH,CAAC,EAjHgB,QAAQ,GAAR,gBAAQ,KAAR,gBAAQ,QAiHxB","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module SQLiteDb\n */\n\nimport { IModelJsNative } from \"@bentley/imodeljs-native\";\nimport { DbResult, IDisposable, OpenMode } from \"@itwin/core-bentley\";\nimport { LocalFileName } from \"@itwin/core-common\";\nimport { CloudSqlite } from \"./CloudSqlite\";\nimport { IModelHost } from \"./IModelHost\";\nimport { SqliteStatement, StatementCache } from \"./SqliteStatement\";\n\n// cspell:ignore savepoint\n/* eslint-disable @typescript-eslint/unified-signatures */\n\n/** A SQLiteDb file\n * @public\n */\nexport class SQLiteDb implements IDisposable {\n  /** @internal */\n  public readonly nativeDb = new IModelHost.platform.SQLiteDb();\n  private _sqliteStatementCache = new StatementCache<SqliteStatement>();\n\n  /** @internal */\n  public static createBlobIO(): SQLiteDb.BlobIO {\n    return new IModelHost.platform.BlobIO();\n  }\n\n  /** alias for closeDb. */\n  public dispose(): void {\n    this.closeDb();\n  }\n\n  /** Create a SQLiteDb\n   * @param dbName The path to the SQLiteDb file to create.\n   */\n  public createDb(dbName: string): void;\n  /** @beta */\n  public createDb(dbName: string, container?: CloudSqlite.CloudContainer, params?: SQLiteDb.CreateParams): void;\n  /** @internal */\n  public createDb(dbName: string, container?: CloudSqlite.CloudContainer, params?: SQLiteDb.CreateParams): void {\n    this.nativeDb.createDb(dbName, container, params);\n  }\n\n  /** Open a SQLiteDb.\n   * @param dbName The path to the SQLiteDb file to open\n   */\n  public openDb(dbName: string, openMode: OpenMode | SQLiteDb.OpenParams): void;\n  /**\n   * @param container optional CloudContainer holding database\n   * @beta\n   */\n  public openDb(dbName: string, openMode: OpenMode | SQLiteDb.OpenParams, container?: CloudSqlite.CloudContainer): void;\n\n  /** @internal */\n  public openDb(dbName: string, openMode: OpenMode | SQLiteDb.OpenParams, container?: CloudSqlite.CloudContainer): void {\n    this.nativeDb.openDb(dbName, openMode, container);\n  }\n\n  /** Close SQLiteDb.\n   * @param saveChanges if true, call `saveChanges` before closing db. Otherwise unsaved changes are abandoned.\n   */\n  public closeDb(saveChanges?: boolean): void {\n    if (saveChanges && this.isOpen)\n      this.saveChanges();\n    this._sqliteStatementCache.clear();\n    this.nativeDb.closeDb();\n  }\n\n  /** Returns true if this SQLiteDb is open */\n  public get isOpen(): boolean { return this.nativeDb.isOpen(); }\n\n  /** Returns true if this SQLiteDb is open readonly */\n  public get isReadonly(): boolean { return this.nativeDb.isReadonly(); }\n\n  /**\n   * Open a database, perform an operation, then close the database.\n   *\n   * Details:\n   * - if database is open, throw an error\n   * - open a database\n   * - call a function with the database opened. If it is async, await its return.\n   * - if function throws, abandon all changes, close database, and rethrow\n   * - save all changes\n   * - close the database\n   * @return value from operation\n   */\n  public withOpenDb<T>(args: SQLiteDb.WithOpenDbArgs, operation: () => T): T {\n    if (this.isOpen)\n      throw new Error(\"database is already open\");\n\n    const save = () => this.closeDb(true), abandon = () => this.closeDb(false);\n    this.openDb(args.dbName, args.openMode ?? OpenMode.Readonly, args.container);\n    try {\n      const result = operation();\n      result instanceof Promise ? result.then(save, abandon) : save();\n      return result;\n    } catch (e) {\n      abandon();\n      throw e;\n    }\n  }\n\n  /**\n   * Perform an operation on a database in a CloudContainer with the write lock held.\n   *\n   * Details:\n   * - acquire the write lock on a CloudContainer\n   * - call `withOpenDb` with openMode `ReadWrite`\n   * - upload changes\n   * - release the write lock\n   * @param args arguments to lock the container and open the database\n   * @param operation an operation performed on the database with the write lock held.\n   * @return value from operation\n   * @internal\n   */\n  public async withLockedContainer<T>(args: CloudSqlite.LockAndOpenArgs, operation: () => T) {\n    return CloudSqlite.withWriteLock(args.user, args.container, () => this.withOpenDb({ ...args, openMode: OpenMode.ReadWrite }, operation), args.busyHandler);\n  }\n\n  /** vacuum this database\n   * @see https://www.sqlite.org/lang_vacuum.html\n   */\n  public vacuum(args?: SQLiteDb.VacuumDbArgs) {\n    this.nativeDb.vacuum(args);\n  }\n\n  /** Commit the outermost transaction, writing changes to the file. Then, restart the transaction. */\n  public saveChanges(): void {\n    this.nativeDb.saveChanges();\n  }\n\n  /** Abandon (cancel) the outermost transaction, discarding all changes since last save. Then, restart the transaction. */\n  public abandonChanges(): void {\n    this.nativeDb.abandonChanges();\n  }\n\n  /**\n   * Use a prepared SQL statement, potentially from the statement cache. If the requested statement doesn't exist\n   * in the statement cache, a new statement is prepared. After the callback completes, the statement is reset and saved\n   * in the statement cache so it can be reused in the future. Use this method for SQL statements that will be\n   * reused often and are expensive to prepare. The statement cache holds the most recently used statements, discarding\n   * the oldest statements as it fills. For statements you don't intend to reuse, instead use [[withSqliteStatement]].\n   * @param sql The SQLite SQL statement to execute\n   * @param callback the callback to invoke on the prepared statement\n   * @returns the value returned by `callback`.\n   */\n  public withPreparedSqliteStatement<T>(sql: string, callback: (stmt: SqliteStatement) => T): T {\n    const stmt = this._sqliteStatementCache.findAndRemove(sql) ?? this.prepareSqliteStatement(sql);\n    const release = () => this._sqliteStatementCache.addOrDispose(stmt);\n    try {\n      const val = callback(stmt);\n      val instanceof Promise ? val.then(release, release) : release();\n      return val;\n    } catch (err) {\n      release();\n      throw err;\n    }\n  }\n\n  /**\n   * Prepared and execute a callback on a SQL statement. After the callback completes the statement is disposed.\n   * Use this method for SQL statements are either not expected to be reused, or are not expensive to prepare.\n   * For statements that will be reused often, instead use [[withPreparedSqliteStatement]].\n   * @param sql The SQLite SQL statement to execute\n   * @param callback the callback to invoke on the prepared statement\n   * @returns the value returned by `callback`.\n   */\n  public withSqliteStatement<T>(sql: string, callback: (stmt: SqliteStatement) => T): T {\n    const stmt = this.prepareSqliteStatement(sql);\n    const release = () => stmt.dispose();\n    try {\n      const val = callback(stmt);\n      val instanceof Promise ? val.then(release, release) : release();\n      return val;\n    } catch (err) {\n      release();\n      throw err;\n    }\n  }\n\n  /**\n   * Perform an operation on this database within a [savepoint](https://www.sqlite.org/lang_savepoint.html). If the operation completes successfully, the\n   * changes remain in the current transaction. If the operation throws an exception, the savepoint is rolled back\n   * and all changes to the database from this method are reversed, leaving the transaction exactly as it was before this method.\n   */\n  public withSavePoint(savePointName: string, operation: () => void) {\n    if (this.isReadonly)\n      throw new Error(\"database is readonly\");\n\n    this.executeSQL(`SAVEPOINT ${savePointName}`);\n    try {\n      operation();\n      this.executeSQL(`RELEASE ${savePointName}`);\n    } catch (e) {\n      this.executeSQL(`ROLLBACK TO ${savePointName}`);\n      throw e;\n    }\n  }\n\n  /** Prepare an SQL statement.\n     * @param sql The SQLite SQL statement to prepare\n     * @param logErrors Determine if errors are logged or not\n     * @internal\n     */\n  public prepareSqliteStatement(sql: string, logErrors = true): SqliteStatement {\n    const stmt = new SqliteStatement(sql);\n    stmt.prepare(this.nativeDb, logErrors);\n    return stmt;\n  }\n\n  /** execute an SQL statement */\n  public executeSQL(sql: string): DbResult {\n    const stmt = this.prepareSqliteStatement(sql);\n    try {\n      return stmt.step();\n    } finally {\n      stmt.dispose();\n    }\n  }\n}\n\n/** @public */\nexport namespace SQLiteDb {\n  /** interface for reading and writing to a blob in a SQLiteDb\n   * @internal\n   */\n  export interface BlobIO {\n    /** Close this BlobIO if it is opened.\n       * @note this BlobIO *may* be reused after this call by calling `open` again.\n      */\n    close(): void;\n    /** get the total number of bytes in the blob */\n    getNumBytes(): number;\n    /** @return true if this BlobIO was successfully opened and may be use to read or write the blob */\n    isValid(): boolean;\n    /** Open this BlobIO against a table/row/column in a Db */\n    open(\n      /** The database for the blob */\n      db: IModelJsNative.AnyDb,\n      args: {\n        /** the name of the table for the blob*/\n        tableName: string;\n        /** the name of the column for the blob */\n        columnName: string;\n        /** The rowId of the blob */\n        row: number;\n        /** If true, open this BlobIO for write access */\n        writeable?: boolean;\n      }): void;\n    /** Read from a blob\n       * @returns the contents of the requested byte range\n       */\n    read(args: {\n      /** The number of bytes to read */\n      numBytes: number;\n      /** starting offset within the blob to read */\n      offset: number;\n      /** If present and of sufficient size, use this ArrayBuffer for the value. */\n      blob?: ArrayBuffer;\n    }): Uint8Array;\n    /** Reposition this BlobIO to a new rowId\n       * @note this BlobIO must be valid when this methods is called.\n       */\n    changeRow(row: number): void;\n    /** Write to a blob */\n    write(args: {\n      /** The number of bytes to write  */\n      numBytes: number;\n      /** starting offset within the blob to write */\n      offset: number;\n      /** the value to write */\n      blob: ArrayBuffer;\n    }): void;\n  }\n\n  /** Default transaction mode for SQLiteDbs.\n   * @see https://www.sqlite.org/lang_transaction.html\n   */\n  export enum DefaultTxnMode {\n    /** no default transaction is started. You must use BEGIN/COMMIT or SQLite will use implicit transactions */\n    None = 0,\n    /** A deferred transaction is started when the file is first opened. This is the default. */\n    Deferred = 1,\n    /** An immediate transaction is started when the file is first opened. */\n    Immediate = 2,\n    /** An exclusive transaction is started when the file is first opened. */\n    Exclusive = 3\n  }\n\n  /** parameters common to opening or creating a new SQLiteDb */\n  export interface OpenOrCreateParams {\n    /** If true, do not require that the `be_Prop` table exist */\n    rawSQLite?: boolean;\n    /** @see immutable option at https://www.sqlite.org/c3ref/open.html */\n    immutable?: boolean;\n    /** Do not attempt to verify that the file is a valid sQLite file before opening. */\n    skipFileCheck?: boolean;\n    /** the default transaction mode\n   * @see [[SQLiteDb.DefaultTxnMode]]\n  */\n    defaultTxn?: 0 | 1 | 2 | 3;\n    /** see query parameters from 'URI Filenames' in  https://www.sqlite.org/c3ref/open.html */\n    queryParam?: string;\n  }\n\n  /** Parameters for opening an existing SQLiteDb */\n  export interface OpenParams extends OpenOrCreateParams {\n    /** use OpenMode.ReadWrite to open the file with write access */\n    openMode: OpenMode;\n  }\n\n  /** Size of a SQLiteDb page in bytes */\n  export interface PageSize {\n    /** see https://www.sqlite.org/pragma.html#pragma_page_size */\n    pageSize?: number;\n  }\n\n  /** Parameters for creating a new SQLiteDb */\n  export type CreateParams = OpenOrCreateParams & PageSize;\n\n  /** Arguments for `SqliteDb.withOpenDb` */\n  export interface WithOpenDbArgs {\n    /** The name of the database to open */\n    dbName: string;\n    /** either an object with the open parameters or just OpenMode value. */\n    openMode?: OpenMode | SQLiteDb.OpenParams;\n    /** @internal */\n    container?: CloudSqlite.CloudContainer;\n  }\n\n  /** Arguments for `SQLiteDb.vacuum` */\n  export interface VacuumDbArgs extends PageSize {\n    /** if present, name of new file to [vacuum into](https://www.sqlite.org/lang_vacuum.html) */\n    into?: LocalFileName;\n  }\n}\n"]}

package/lib/cjs/Schema.d.ts

@@ -1,56 +1,56 @@
-/** @packageDocumentation
- * @module Schema
- */
-/** Base class for all schema classes - see [working with schemas and elements in TypeScript]($docs/learning/backend/SchemasAndElementsInTypeScript.md).
- * @public
- */
-export declare class Schema {
-    /** The name of the BIS schema handled by this Schema.
-     * @note Every subclass of Schema ** MUST ** override this method to identify its BIS schema.
-     * Failure to do so will ordinarily result in an error when the schema is registered, since there may only
-     * be one JavaScript class for a given BIS schema (usually the errant schema will collide with its superclass.)
-     */
-    static get schemaName(): string;
-    /** if true, this Schema is a proxy for a missing Domain marked with the `BisCore.SchemaHasBehavior` customAttribute.
-     * Classes generated for this Schema will disallow protected operations.
-     * @internal
-     */
-    static get missingRequiredBehavior(): boolean;
-    /** Get a semver-compatible string from a padded version string.
-     * works on unpadded version strings as well
-     * if there is no write version, it will be added
-     * @example Schema.toSemverString("1.02.03") === "1.2.3"
-     * @example Schema.toSemverString("1.01") === "1.0.1" // write version was added
-     * @beta
-     */
-    static toSemverString(paddedVersion: string): string;
-    /** Schemas may not be instantiated. The method is not private only because that precludes subclassing. It throws an
-     * error if it is ever called.
-     * @internal
-     */
-    protected constructor();
-}
-/** Manages registered schemas
- * @public
- */
-export declare class Schemas {
-    private static readonly _registeredSchemas;
-    private constructor();
-    /** Register a schema prior to using it.
-     * @throws [[IModelError]] if a schema of the same name is already registered.
-     */
-    static registerSchema(schema: typeof Schema): void;
-    /** Unregister a schema, by name, if one is already registered.
-     * This function is not normally needed, but is useful for cases where a generated *proxy* schema needs to be replaced by the *real* schema.
-     * @param schemaName Name of the schema to unregister
-     * @return true if the schema was unregistered
-     * @internal
-     */
-    static unregisterSchema(schemaName: string): boolean;
-    /** Look up a previously registered schema
-     * @param schemaName The name of the schema
-     * @returns the previously registered schema or undefined if not registered.
-     */
-    static getRegisteredSchema(schemaName: string): typeof Schema | undefined;
-}
+/** @packageDocumentation
+ * @module Schema
+ */
+/** Base class for all schema classes - see [working with schemas and elements in TypeScript]($docs/learning/backend/SchemasAndElementsInTypeScript.md).
+ * @public
+ */
+export declare class Schema {
+    /** The name of the BIS schema handled by this Schema.
+     * @note Every subclass of Schema ** MUST ** override this method to identify its BIS schema.
+     * Failure to do so will ordinarily result in an error when the schema is registered, since there may only
+     * be one JavaScript class for a given BIS schema (usually the errant schema will collide with its superclass.)
+     */
+    static get schemaName(): string;
+    /** if true, this Schema is a proxy for a missing Domain marked with the `BisCore.SchemaHasBehavior` customAttribute.
+     * Classes generated for this Schema will disallow protected operations.
+     * @internal
+     */
+    static get missingRequiredBehavior(): boolean;
+    /** Get a semver-compatible string from a padded version string.
+     * works on unpadded version strings as well
+     * if there is no write version, it will be added
+     * @example Schema.toSemverString("1.02.03") === "1.2.3"
+     * @example Schema.toSemverString("1.01") === "1.0.1" // write version was added
+     * @beta
+     */
+    static toSemverString(paddedVersion: string): string;
+    /** Schemas may not be instantiated. The method is not private only because that precludes subclassing. It throws an
+     * error if it is ever called.
+     * @internal
+     */
+    protected constructor();
+}
+/** Manages registered schemas
+ * @public
+ */
+export declare class Schemas {
+    private static readonly _registeredSchemas;
+    private constructor();
+    /** Register a schema prior to using it.
+     * @throws [[IModelError]] if a schema of the same name is already registered.
+     */
+    static registerSchema(schema: typeof Schema): void;
+    /** Unregister a schema, by name, if one is already registered.
+     * This function is not normally needed, but is useful for cases where a generated *proxy* schema needs to be replaced by the *real* schema.
+     * @param schemaName Name of the schema to unregister
+     * @return true if the schema was unregistered
+     * @internal
+     */
+    static unregisterSchema(schemaName: string): boolean;
+    /** Look up a previously registered schema
+     * @param schemaName The name of the schema
+     * @returns the previously registered schema or undefined if not registered.
+     */
+    static getRegisteredSchema(schemaName: string): typeof Schema | undefined;
+}
 //# sourceMappingURL=Schema.d.ts.map