@itwin/core-backend 3.4.0-dev.9 → 3.5.0-dev.12

package/lib/cjs/SQLiteDb.js

@@ -8,10 +8,11 @@
  */
 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 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
@@ -23,18 +24,6 @@ class 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();
     }
@@ -42,9 +31,7 @@ class SQLiteDb {
     dispose() {
         this.closeDb();
     }
-    /** Create a SQLiteDb
-     * @param dbName The path to the SQLiteDb file to create.
-     */
+    /** @internal */
     createDb(dbName, container, params) {
         this.nativeDb.createDb(dbName, container, params);
     }
@@ -53,7 +40,7 @@ class SQLiteDb {
         this.nativeDb.openDb(dbName, openMode, container);
     }
     /** Close SQLiteDb.
-     * @param saveChanges if true, call `saveChanges` before closing db.
+     * @param saveChanges if true, call `saveChanges` before closing db. Otherwise unsaved changes are abandoned.
      */
     closeDb(saveChanges) {
         if (saveChanges && this.isOpen)
@@ -61,45 +48,53 @@ class SQLiteDb {
         this._sqliteStatementCache.clear();
         this.nativeDb.closeDb();
     }
-    /** Returns true if the SQLiteDb is open */
+    /** 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(); }
     /**
-     * 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)
+     * 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
      */
-    static withOpenDb(args, operation) {
+    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;
+        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(db);
-            if (result instanceof Promise) {
-                fromPromise = true;
-                const doClose = () => db.closeDb();
-                result.then(doClose, doClose);
-            }
+            const result = operation();
+            result instanceof Promise ? result.then(save, abandon) : save();
             return result;
         }
-        finally {
-            if (!fromPromise)
-                db.closeDb();
+        catch (e) {
+            abandon();
+            throw e;
         }
     }
     /**
-     * 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.
+     * 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
      */
-    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);
+    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
@@ -131,12 +126,7 @@ class SQLiteDb {
         const release = () => this._sqliteStatementCache.addOrDispose(stmt);
         try {
             const val = callback(stmt);
-            if (val instanceof Promise) {
-                val.then(release, release);
-            }
-            else {
-                release();
-            }
+            val instanceof Promise ? val.then(release, release) : release();
             return val;
         }
         catch (err) {
@@ -157,12 +147,7 @@ class SQLiteDb {
         const release = () => stmt.dispose();
         try {
             const val = callback(stmt);
-            if (val instanceof Promise) {
-                val.then(release, release);
-            }
-            else {
-                release();
-            }
+            val instanceof Promise ? val.then(release, release) : release();
             return val;
         }
         catch (err) {
@@ -170,6 +155,24 @@ class SQLiteDb {
             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
@@ -195,8 +198,8 @@ exports.SQLiteDb = SQLiteDb;
 /** @public */
 (function (SQLiteDb) {
     /** Default transaction mode for SQLiteDbs.
-       * @see https://www.sqlite.org/lang_transaction.html
-      */
+     * @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 */

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":["/*---------------------------------------------------------------------------------------------\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 { IModelJsNative } from \"@bentley/imodeljs-native\";\r\nimport { DbResult, IDisposable, OpenMode } from \"@itwin/core-bentley\";\r\nimport { LocalFileName } from \"@itwin/core-common\";\r\nimport { CloudSqlite } from \"./CloudSqlite\";\r\nimport { IModelHost } from \"./IModelHost\";\r\nimport { SqliteStatement, StatementCache } from \"./SqliteStatement\";\r\n\r\n// cspell:ignore savepoint\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 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): void;\r\n  /** @beta */\r\n  public createDb(dbName: string, container?: CloudSqlite.CloudContainer, params?: SQLiteDb.CreateParams): void;\r\n  /** @internal */\r\n  public createDb(dbName: string, container?: CloudSqlite.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   * @beta\r\n   */\r\n  public openDb(dbName: string, openMode: OpenMode | SQLiteDb.OpenParams, container?: CloudSqlite.CloudContainer): void;\r\n\r\n  /** @internal */\r\n  public openDb(dbName: string, openMode: OpenMode | SQLiteDb.OpenParams, container?: CloudSqlite.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. Otherwise unsaved changes are abandoned.\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 this SQLiteDb is open */\r\n  public get isOpen(): boolean { return this.nativeDb.isOpen(); }\r\n\r\n  /** Returns true if this SQLiteDb is open readonly */\r\n  public get isReadonly(): boolean { return this.nativeDb.isReadonly(); }\r\n\r\n  /**\r\n   * Open a database, perform an operation, then close the database.\r\n   *\r\n   * Details:\r\n   * - if database is open, throw an error\r\n   * - open a database\r\n   * - call a function with the database opened. If it is async, await its return.\r\n   * - if function throws, abandon all changes, close database, and rethrow\r\n   * - save all changes\r\n   * - close the database\r\n   * @return value from operation\r\n   */\r\n  public withOpenDb<T>(args: SQLiteDb.WithOpenDbArgs, operation: () => T): T {\r\n    if (this.isOpen)\r\n      throw new Error(\"database is already open\");\r\n\r\n    const save = () => this.closeDb(true), abandon = () => this.closeDb(false);\r\n    this.openDb(args.dbName, args.openMode ?? OpenMode.Readonly, args.container);\r\n    try {\r\n      const result = operation();\r\n      result instanceof Promise ? result.then(save, abandon) : save();\r\n      return result;\r\n    } catch (e) {\r\n      abandon();\r\n      throw e;\r\n    }\r\n  }\r\n\r\n  /**\r\n   * Perform an operation on a database in a CloudContainer with the write lock held.\r\n   *\r\n   * Details:\r\n   * - acquire the write lock on a CloudContainer\r\n   * - call `withOpenDb` with openMode `ReadWrite`\r\n   * - upload changes\r\n   * - release the write lock\r\n   * @param args arguments to lock the container and open the database\r\n   * @param operation an operation performed on the database with the write lock held.\r\n   * @return value from operation\r\n   * @internal\r\n   */\r\n  public async withLockedContainer<T>(args: CloudSqlite.LockAndOpenArgs, operation: () => T) {\r\n    return CloudSqlite.withWriteLock(args.user, args.container, () => this.withOpenDb({ ...args, openMode: OpenMode.ReadWrite }, operation), 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?: SQLiteDb.VacuumDbArgs) {\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 = callback(stmt);\r\n      val instanceof Promise ? val.then(release, release) : release();\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 = callback(stmt);\r\n      val instanceof Promise ? val.then(release, release) : release();\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   * Perform an operation on this database within a [savepoint](https://www.sqlite.org/lang_savepoint.html). If the operation completes successfully, the\r\n   * changes remain in the current transaction. If the operation throws an exception, the savepoint is rolled back\r\n   * and all changes to the database from this method are reversed, leaving the transaction exactly as it was before this method.\r\n   */\r\n  public withSavePoint(savePointName: string, operation: () => void) {\r\n    if (this.isReadonly)\r\n      throw new Error(\"database is readonly\");\r\n\r\n    this.executeSQL(`SAVEPOINT ${savePointName}`);\r\n    try {\r\n      operation();\r\n      this.executeSQL(`RELEASE ${savePointName}`);\r\n    } catch (e) {\r\n      this.executeSQL(`ROLLBACK TO ${savePointName}`);\r\n      throw e;\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  /** interface for reading and writing to a blob in a SQLiteDb\r\n   * @internal\r\n   */\r\n  export interface BlobIO {\r\n    /** Close this BlobIO if it is opened.\r\n       * @note this BlobIO *may* be reused after this call by calling `open` again.\r\n      */\r\n    close(): void;\r\n    /** get the total number of bytes in the blob */\r\n    getNumBytes(): number;\r\n    /** @return true if this BlobIO was successfully opened and may be use to read or write the blob */\r\n    isValid(): boolean;\r\n    /** Open this BlobIO against a table/row/column in a Db */\r\n    open(\r\n      /** The database for the blob */\r\n      db: IModelJsNative.AnyDb,\r\n      args: {\r\n        /** the name of the table for the blob*/\r\n        tableName: string;\r\n        /** the name of the column for the blob */\r\n        columnName: string;\r\n        /** The rowId of the blob */\r\n        row: number;\r\n        /** If true, open this BlobIO for write access */\r\n        writeable?: boolean;\r\n      }): void;\r\n    /** Read from a blob\r\n       * @returns the contents of the requested byte range\r\n       */\r\n    read(args: {\r\n      /** The number of bytes to read */\r\n      numBytes: number;\r\n      /** starting offset within the blob to read */\r\n      offset: number;\r\n      /** If present and of sufficient size, use this ArrayBuffer for the value. */\r\n      blob?: ArrayBuffer;\r\n    }): Uint8Array;\r\n    /** Reposition this BlobIO to a new rowId\r\n       * @note this BlobIO must be valid when this methods is called.\r\n       */\r\n    changeRow(row: number): void;\r\n    /** Write to a blob */\r\n    write(args: {\r\n      /** The number of bytes to write  */\r\n      numBytes: number;\r\n      /** starting offset within the blob to write */\r\n      offset: number;\r\n      /** the value to write */\r\n      blob: ArrayBuffer;\r\n    }): void;\r\n  }\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  /** Size of a SQLiteDb page in bytes */\r\n  export interface PageSize {\r\n    /** see https://www.sqlite.org/pragma.html#pragma_page_size */\r\n    pageSize?: number;\r\n  }\r\n\r\n  /** Parameters for creating a new SQLiteDb */\r\n  export type CreateParams = OpenOrCreateParams & PageSize;\r\n\r\n  /** Arguments for `SqliteDb.withOpenDb` */\r\n  export interface WithOpenDbArgs {\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?: CloudSqlite.CloudContainer;\r\n  }\r\n\r\n  /** Arguments for `SQLiteDb.vacuum` */\r\n  export interface VacuumDbArgs extends PageSize {\r\n    /** if present, name of new file to [vacuum into](https://www.sqlite.org/lang_vacuum.html) */\r\n    into?: LocalFileName;\r\n  }\r\n}\r\n"]}

package/lib/cjs/SqliteStatement.d.ts

@@ -40,8 +40,9 @@ export declare type BindParameter = number | string;
 export declare class SqliteStatement implements IterableIterator<any>, IDisposable {
     private _sql;
     private _stmt;
+    private _db;
     constructor(_sql: string);
-    get stmt(): IModelJsNative.SqliteStatement | undefined;
+    get stmt(): IModelJsNative.SqliteStatement;
     get sql(): string;
     /** Check if this statement has been prepared successfully or not */
     get isPrepared(): boolean;
@@ -52,7 +53,7 @@ export declare class SqliteStatement implements IterableIterator<any>, IDisposab
      * @throws if the SQL statement cannot be prepared. Normally, prepare fails due to SQL syntax errors or references to tables or properties that do not exist.
      * The error.message property will provide details.
      */
-    prepare(db: IModelJsNative.DgnDb | IModelJsNative.ECDb | IModelJsNative.SQLiteDb, logErrors?: boolean): void;
+    prepare(db: IModelJsNative.AnyDb, logErrors?: boolean): void;
     /** Indicates whether the prepared statement makes no **direct* changes to the content of the file
      * or not. See [SQLite docs](https://www.sqlite.org/c3ref/stmt_readonly.html) for details.
      */
@@ -62,6 +63,13 @@ export declare class SqliteStatement implements IterableIterator<any>, IDisposab
     reset(): void;
     /** Call this function when finished with this statement. This releases the native resources held by the statement. */
     dispose(): void;
+    /**
+     * Call `step` on this statement and determine whether a new row is available.
+     * Use this method only when this statement has been prepared with a SELECT statement.
+     * @return true if a new row is available, false otherwise.
+     * @throws if `step` returns anything other than BE_SQLITE_ROW or BE_SQLITE_DONE.
+     */
+    nextRow(): boolean;
     /** Binds a value to the specified SQL parameter.
      *  The value must be of one of these types:
      *  JavaScript Type | SQLite Type
@@ -145,6 +153,10 @@ export declare class SqliteStatement implements IterableIterator<any>, IDisposab
      * @param columnIx Index of SQL column in query result (0-based)
      */
     getValue(columnIx: number): SqliteValue;
+    /** Determine whether the value of the specified column is null
+     * @param colIndex Index of SQL column in query result (0-based)
+     */
+    isValueNull(colIndex: number): boolean;
     /** Get a size in bytes of a blob or text column
      * @param colIndex Index of SQL column in query result (0-based)
      */

package/lib/cjs/SqliteStatement.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"SqliteStatement.d.ts","sourceRoot":"","sources":["../../src/SqliteStatement.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAU,QAAQ,EAAE,UAAU,EAAE,UAAU,EAAE,WAAW,EAAU,MAAM,qBAAqB,CAAC;AAEpG,OAAO,EAAE,cAAc,EAAE,MAAM,0BAA0B,CAAC;AAK1D;;;;GAIG;AACH,MAAM,WAAW,WAAW;IAC1B,EAAE,CAAC,EAAE,UAAU,CAAC;IAChB,IAAI,CAAC,EAAE,UAAU,CAAC;CACnB;AAED;;GAEG;AACH,oBAAY,aAAa,GAAG,MAAM,GAAG,MAAM,CAAC;AAE5C;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,qBAAa,eAAgB,YAAW,gBAAgB,CAAC,GAAG,CAAC,EAAE,WAAW;IAGrD,OAAO,CAAC,IAAI;IAF/B,OAAO,CAAC,KAAK,CAA6C;gBAE/B,IAAI,EAAE,MAAM;IACvC,IAAW,IAAI,+CAAyB;IACxC,IAAW,GAAG,WAAwB;IAEtC,oEAAoE;IACpE,IAAW,UAAU,IAAI,OAAO,CAAqC;IAErE;;;;;;OAMG;IACI,OAAO,CAAC,EAAE,EAAE,cAAc,CAAC,KAAK,GAAG,cAAc,CAAC,IAAI,GAAG,cAAc,CAAC,QAAQ,EAAE,SAAS,UAAO,GAAG,IAAI;IAOhH;;OAEG;IACH,IAAW,UAAU,IAAI,OAAO,CAE/B;IAED;OACG;IACI,KAAK,IAAI,IAAI;IAIpB,sHAAsH;IAC/G,OAAO,IAAI,IAAI;IAOtB;;;;;;;;;;;;;;;;OAgBG;IACI,SAAS,CAAC,SAAS,EAAE,aAAa,EAAE,KAAK,EAAE,GAAG,GAAG,IAAI;IA0B5D,OAAO,CAAC,SAAS;IAIjB;;;OAGG;IACI,WAAW,CAAC,SAAS,EAAE,aAAa,EAAE,GAAG,EAAE,MAAM;IAGxD;;;OAGG;IACI,UAAU,CAAC,SAAS,EAAE,aAAa,EAAE,GAAG,EAAE,MAAM;IAGvD;;;OAGG;IACI,UAAU,CAAC,SAAS,EAAE,aAAa,EAAE,GAAG,EAAE,MAAM;IAGvD;;;OAGG;IACI,MAAM,CAAC,SAAS,EAAE,aAAa,EAAE,EAAE,EAAE,UAAU;IAGtD;;;OAGG;IACI,QAAQ,CAAC,SAAS,EAAE,aAAa,EAAE,IAAI,EAAE,UAAU;IAG1D;;;OAGG;IACI,QAAQ,CAAC,SAAS,EAAE,aAAa,EAAE,IAAI,EAAE,UAAU;IAG1D;;OAEG;IACI,QAAQ,CAAC,SAAS,EAAE,aAAa;IAIxC;;;;;;OAMG;IACI,UAAU,CAAC,MAAM,EAAE,GAAG,EAAE,GAAG,MAAM,GAAG,IAAI;IAuB/C;;OAEG;IACI,aAAa,IAAI,IAAI;IAM5B;;;;;;;;;;OAUG;IACI,IAAI,IAAI,QAAQ;IAEvB,4EAA4E;IACrE,cAAc,IAAI,MAAM;IAE/B;;OAEG;IACI,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,WAAW;IAE9C;;OAEG;IACI,cAAc,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM;IAE/C;;OAEG;IACI,YAAY,CAAC,QAAQ,EAAE,MAAM,GAAG,UAAU;IACjD;;MAEE;IACK,cAAc,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM;IAC/C;;MAEE;IACK,eAAe,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM;IAChD;;MAEE;IACK,cAAc,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM;IAC/C;;MAEE;IACK,UAAU,CAAC,QAAQ,EAAE,MAAM,GAAG,UAAU;IAC/C;;MAEE;IACK,YAAY,CAAC,QAAQ,EAAE,MAAM,GAAG,UAAU;IAEjD;;;;;;;;;;;;OAYG;IACI,MAAM,IAAI,GAAG;IAiCpB,OAAO,CAAC,MAAM,CAAC,8BAA8B;IAgB7C;OACG;IACI,IAAI,IAAI,cAAc,CAAC,GAAG,CAAC;IAIlC,yEAAyE;IAClE,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,gBAAgB,CAAC,GAAG,CAAC;CAClD;AAED;;;;;;GAMG;AACH,oBAAY,eAAe;IAGzB,OAAO,IAAI;IACX,MAAM,IAAI;IACV,MAAM,IAAI;IACV,IAAI,IAAI;IACR,IAAI,IAAI;CACT;AAED;;;;;GAKG;AACH,qBAAa,WAAW;IACtB,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAiC;IACvD,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAS;gBAEhB,IAAI,EAAE,cAAc,CAAC,eAAe,EAAE,QAAQ,EAAE,MAAM;IAKzE,kDAAkD;IAClD,IAAW,MAAM,IAAI,OAAO,CAAmD;IAE/E,uCAAuC;IACvC,IAAW,IAAI,IAAI,eAAe,CAAqD;IAEvF,gDAAgD;IAChD,IAAW,UAAU,IAAI,MAAM,CAAqD;IAEpF;;;;;;;;;OASG;IACH,IAAW,KAAK,IAAI,GAAG,CAetB;IAED,4BAA4B;IACrB,OAAO,IAAI,UAAU;IAC5B,sCAAsC;IAC/B,SAAS,IAAI,MAAM;IAC1B,uCAAuC;IAChC,UAAU,IAAI,MAAM;IAC3B,sCAAsC;IAC/B,SAAS,IAAI,MAAM;IAC1B,mCAAmC;IAC5B,KAAK,IAAI,UAAU;IAC1B,oCAAoC;IAC7B,OAAO,IAAI,UAAU;CAC7B;AAED,UAAU,SAAS;IACjB,UAAU,EAAE,OAAO,CAAC;IACpB,GAAG,EAAE,MAAM,CAAC;IACZ,OAAO,IAAI,IAAI,CAAC;IAChB,KAAK,IAAI,IAAI,CAAC;IACd,aAAa,IAAI,IAAI,CAAC;CACvB;AAED;;;;GAIG;AACH,qBAAa,cAAc,CAAC,IAAI,SAAS,SAAS;IAChD,OAAO,CAAC,MAAM,CAAuB;gBAElB,QAAQ,SAAK;IAIhC,IAAW,IAAI,WAA+B;IACvC,YAAY,CAAC,IAAI,EAAE,IAAI,GAAG,IAAI;IAiB9B,aAAa,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS;IAI5C,KAAK;CAIb"}
+{"version":3,"file":"SqliteStatement.d.ts","sourceRoot":"","sources":["../../src/SqliteStatement.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAwB,QAAQ,EAAE,UAAU,EAAE,UAAU,EAAE,WAAW,EAAU,MAAM,qBAAqB,CAAC;AAElH,OAAO,EAAE,cAAc,EAAE,MAAM,0BAA0B,CAAC;AAK1D;;;;GAIG;AACH,MAAM,WAAW,WAAW;IAC1B,EAAE,CAAC,EAAE,UAAU,CAAC;IAChB,IAAI,CAAC,EAAE,UAAU,CAAC;CACnB;AAED;;GAEG;AACH,oBAAY,aAAa,GAAG,MAAM,GAAG,MAAM,CAAC;AAE5C;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,qBAAa,eAAgB,YAAW,gBAAgB,CAAC,GAAG,CAAC,EAAE,WAAW;IAIrD,OAAO,CAAC,IAAI;IAH/B,OAAO,CAAC,KAAK,CAA6C;IAC1D,OAAO,CAAC,GAAG,CAAmC;gBAEnB,IAAI,EAAE,MAAM;IACvC,IAAW,IAAI,IAAI,cAAc,CAAC,eAAe,CAAwB;IACzE,IAAW,GAAG,WAAwB;IAEtC,oEAAoE;IACpE,IAAW,UAAU,IAAI,OAAO,CAAqC;IAErE;;;;;;OAMG;IACI,OAAO,CAAC,EAAE,EAAE,cAAc,CAAC,KAAK,EAAE,SAAS,UAAO,GAAG,IAAI;IAQhE;;OAEG;IACH,IAAW,UAAU,IAAI,OAAO,CAE/B;IAED;OACG;IACI,KAAK,IAAI,IAAI;IAIpB,sHAAsH;IAC/G,OAAO,IAAI,IAAI;IAQtB;;;;;OAKG;IACI,OAAO,IAAI,OAAO;IAYzB;;;;;;;;;;;;;;;;OAgBG;IACI,SAAS,CAAC,SAAS,EAAE,aAAa,EAAE,KAAK,EAAE,GAAG,GAAG,IAAI;IA0B5D,OAAO,CAAC,SAAS;IAIjB;;;OAGG;IACI,WAAW,CAAC,SAAS,EAAE,aAAa,EAAE,GAAG,EAAE,MAAM;IAGxD;;;OAGG;IACI,UAAU,CAAC,SAAS,EAAE,aAAa,EAAE,GAAG,EAAE,MAAM;IAGvD;;;OAGG;IACI,UAAU,CAAC,SAAS,EAAE,aAAa,EAAE,GAAG,EAAE,MAAM;IAGvD;;;OAGG;IACI,MAAM,CAAC,SAAS,EAAE,aAAa,EAAE,EAAE,EAAE,UAAU;IAGtD;;;OAGG;IACI,QAAQ,CAAC,SAAS,EAAE,aAAa,EAAE,IAAI,EAAE,UAAU;IAG1D;;;OAGG;IACI,QAAQ,CAAC,SAAS,EAAE,aAAa,EAAE,IAAI,EAAE,UAAU;IAG1D;;OAEG;IACI,QAAQ,CAAC,SAAS,EAAE,aAAa;IAIxC;;;;;;OAMG;IACI,UAAU,CAAC,MAAM,EAAE,GAAG,EAAE,GAAG,MAAM,GAAG,IAAI;IAuB/C;;OAEG;IACI,aAAa,IAAI,IAAI;IAM5B;;;;;;;;;;OAUG;IACI,IAAI,IAAI,QAAQ;IAEvB,4EAA4E;IACrE,cAAc,IAAI,MAAM;IAE/B;;OAEG;IACI,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,WAAW;IAE9C;;OAEG;IACI,WAAW,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO;IAE7C;;OAEG;IACI,cAAc,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM;IAE/C;;OAEG;IACI,YAAY,CAAC,QAAQ,EAAE,MAAM,GAAG,UAAU;IACjD;;MAEE;IACK,cAAc,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM;IAC/C;;MAEE;IACK,eAAe,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM;IAChD;;MAEE;IACK,cAAc,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM;IAC/C;;MAEE;IACK,UAAU,CAAC,QAAQ,EAAE,MAAM,GAAG,UAAU;IAC/C;;MAEE;IACK,YAAY,CAAC,QAAQ,EAAE,MAAM,GAAG,UAAU;IAEjD;;;;;;;;;;;;OAYG;IACI,MAAM,IAAI,GAAG;IAiCpB,OAAO,CAAC,MAAM,CAAC,8BAA8B;IAgB7C;OACG;IACI,IAAI,IAAI,cAAc,CAAC,GAAG,CAAC;IAIlC,yEAAyE;IAClE,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,gBAAgB,CAAC,GAAG,CAAC;CAClD;AAED;;;;;;GAMG;AACH,oBAAY,eAAe;IAGzB,OAAO,IAAI;IACX,MAAM,IAAI;IACV,MAAM,IAAI;IACV,IAAI,IAAI;IACR,IAAI,IAAI;CACT;AAED;;;;;GAKG;AACH,qBAAa,WAAW;IACtB,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAiC;IACvD,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAS;gBAEhB,IAAI,EAAE,cAAc,CAAC,eAAe,EAAE,QAAQ,EAAE,MAAM;IAKzE,kDAAkD;IAClD,IAAW,MAAM,IAAI,OAAO,CAAmD;IAE/E,uCAAuC;IACvC,IAAW,IAAI,IAAI,eAAe,CAAqD;IAEvF,gDAAgD;IAChD,IAAW,UAAU,IAAI,MAAM,CAAqD;IAEpF;;;;;;;;;OASG;IACH,IAAW,KAAK,IAAI,GAAG,CAetB;IAED,4BAA4B;IACrB,OAAO,IAAI,UAAU;IAC5B,sCAAsC;IAC/B,SAAS,IAAI,MAAM;IAC1B,uCAAuC;IAChC,UAAU,IAAI,MAAM;IAC3B,sCAAsC;IAC/B,SAAS,IAAI,MAAM;IAC1B,mCAAmC;IAC5B,KAAK,IAAI,UAAU;IAC1B,oCAAoC;IAC7B,OAAO,IAAI,UAAU;CAC7B;AAED,UAAU,SAAS;IACjB,UAAU,EAAE,OAAO,CAAC;IACpB,GAAG,EAAE,MAAM,CAAC;IACZ,OAAO,IAAI,IAAI,CAAC;IAChB,KAAK,IAAI,IAAI,CAAC;IACd,aAAa,IAAI,IAAI,CAAC;CACvB;AAED;;;;GAIG;AACH,qBAAa,cAAc,CAAC,IAAI,SAAS,SAAS;IAChD,OAAO,CAAC,MAAM,CAAuB;gBAElB,QAAQ,SAAK;IAIhC,IAAW,IAAI,WAA+B;IACvC,YAAY,CAAC,IAAI,EAAE,IAAI,GAAG,IAAI;IAiB9B,aAAa,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS;IAI5C,KAAK;CAIb"}

package/lib/cjs/SqliteStatement.js

@@ -50,6 +50,7 @@ class SqliteStatement {
     prepare(db, logErrors = true) {
         if (this.isPrepared)
             throw new Error("SqliteStatement is already prepared");
+        this._db = db;
         this._stmt = new IModelHost_1.IModelHost.platform.SqliteStatement();
         this._stmt.prepare(db, this._sql, logErrors);
     }
@@ -57,20 +58,37 @@ class SqliteStatement {
      * or not. See [SQLite docs](https://www.sqlite.org/c3ref/stmt_readonly.html) for details.
      */
     get isReadonly() {
-        return this._stmt.isReadonly();
+        return this.stmt.isReadonly();
     }
     /** Reset this statement so that the next call to step will return the first row, if any.
      */
     reset() {
-        this._stmt.reset();
+        this.stmt.reset();
     }
     /** Call this function when finished with this statement. This releases the native resources held by the statement. */
     dispose() {
         if (this._stmt) {
             this._stmt.dispose(); // free native statement
             this._stmt = undefined;
+            this._db = undefined;
         }
     }
+    /**
+     * Call `step` on this statement and determine whether a new row is available.
+     * Use this method only when this statement has been prepared with a SELECT statement.
+     * @return true if a new row is available, false otherwise.
+     * @throws if `step` returns anything other than BE_SQLITE_ROW or BE_SQLITE_DONE.
+     */
+    nextRow() {
+        const rc = this.step();
+        switch (rc) {
+            case core_bentley_1.DbResult.BE_SQLITE_ROW:
+                return true;
+            case core_bentley_1.DbResult.BE_SQLITE_DONE:
+                return false;
+        }
+        throw new core_bentley_1.BentleyError(rc, this._db.getLastError());
+    }
     /** Binds a value to the specified SQL parameter.
      *  The value must be of one of these types:
      *  JavaScript Type | SQLite Type
@@ -91,28 +109,28 @@ class SqliteStatement {
     bindValue(parameter, value) {
         let stat;
         if (value === undefined || value === null) {
-            stat = this._stmt.bindNull(parameter);
+            stat = this.stmt.bindNull(parameter);
         }
         else if (typeof (value) === "number") {
             if (Number.isInteger(value))
-                stat = this._stmt.bindInteger(parameter, value);
+                stat = this.stmt.bindInteger(parameter, value);
             else
-                stat = this._stmt.bindDouble(parameter, value);
+                stat = this.stmt.bindDouble(parameter, value);
         }
         else if (typeof (value) === "boolean") {
-            stat = this._stmt.bindInteger(parameter, value ? 1 : 0);
+            stat = this.stmt.bindInteger(parameter, value ? 1 : 0);
         }
         else if (typeof (value) === "string") {
-            stat = this._stmt.bindString(parameter, value);
+            stat = this.stmt.bindString(parameter, value);
         }
         else if (!!value.id) {
-            stat = this._stmt.bindId(parameter, value.id);
+            stat = this.stmt.bindId(parameter, value.id);
         }
         else if (!!value.guid) {
-            stat = this._stmt.bindGuid(parameter, value.guid);
+            stat = this.stmt.bindGuid(parameter, value.guid);
         }
         else if (value instanceof Uint8Array) {
-            stat = this._stmt.bindBlob(parameter, value);
+            stat = this.stmt.bindBlob(parameter, value);
         }
         else
             throw new core_common_1.IModelError(core_bentley_1.DbResult.BE_SQLITE_ERROR, `Parameter value ${value} is of an unsupported data type.`);
@@ -128,48 +146,48 @@ class SqliteStatement {
      *  @param val integer to bind.
      */
     bindInteger(parameter, val) {
-        this.checkBind(this._stmt.bindInteger(parameter, val));
+        this.checkBind(this.stmt.bindInteger(parameter, val));
     }
     /** Bind a double parameter
      *  @param parameter Index (1-based) or name of the parameter (including the initial ':', '@' or '$')
      *  @param val double to bind.
      */
     bindDouble(parameter, val) {
-        this.checkBind(this._stmt.bindDouble(parameter, val));
+        this.checkBind(this.stmt.bindDouble(parameter, val));
     }
     /** Bind a string parameter
      *  @param parameter Index (1-based) or name of the parameter (including the initial ':', '@' or '$')
      *  @param val string to bind.
      */
     bindString(parameter, val) {
-        this.checkBind(this._stmt.bindString(parameter, val));
+        this.checkBind(this.stmt.bindString(parameter, val));
     }
     /** Bind an Id64String parameter as a 64-bit integer
      *  @param parameter Index (1-based) or name of the parameter (including the initial ':', '@' or '$')
      *  @param val Id to bind.
      */
     bindId(parameter, id) {
-        this.checkBind(this._stmt.bindId(parameter, id));
+        this.checkBind(this.stmt.bindId(parameter, id));
     }
     /** Bind a Guid parameter
      *  @param parameter Index (1-based) or name of the parameter (including the initial ':', '@' or '$')
      *  @param val Guid to bind.
      */
     bindGuid(parameter, guid) {
-        this.checkBind(this._stmt.bindGuid(parameter, guid));
+        this.checkBind(this.stmt.bindGuid(parameter, guid));
     }
     /** Bind a blob parameter
      *  @param parameter Index (1-based) or name of the parameter (including the initial ':', '@' or '$')
      *  @param val blob to bind.
      */
     bindBlob(parameter, blob) {
-        this.checkBind(this._stmt.bindBlob(parameter, blob));
+        this.checkBind(this.stmt.bindBlob(parameter, blob));
     }
     /** Bind null to a parameter
      *  @param parameter Index (1-based) or name of the parameter (including the initial ':', '@' or '$')
      */
     bindNull(parameter) {
-        this.checkBind(this._stmt.bindNull(parameter));
+        this.checkBind(this.stmt.bindNull(parameter));
     }
     /** Bind values to all parameters in the statement.
      * @param values The values to bind to the parameters.
@@ -201,7 +219,7 @@ class SqliteStatement {
      * @throws [IModelError]($common) in case of errors
      */
     clearBindings() {
-        const stat = this._stmt.clearBindings();
+        const stat = this.stmt.clearBindings();
         if (stat !== core_bentley_1.DbResult.BE_SQLITE_OK)
             throw new core_common_1.IModelError(stat, "Error in clearBindings");
     }
@@ -216,41 +234,45 @@ class SqliteStatement {
      *  - [DbResult.BE_SQLITE_DONE]($core-bentley) if the statement has been executed successfully.
      *  - Error status in case of errors.
      */
-    step() { return this._stmt.step(); }
+    step() { return this.stmt.step(); }
     /** Get the query result's column count (only for SQL SELECT statements). */
-    getColumnCount() { return this._stmt.getColumnCount(); }
+    getColumnCount() { return this.stmt.getColumnCount(); }
     /** Get the value for the column at the given index in the query result.
      * @param columnIx Index of SQL column in query result (0-based)
      */
-    getValue(columnIx) { return new SqliteValue(this._stmt, columnIx); }
+    getValue(columnIx) { return new SqliteValue(this.stmt, columnIx); }
+    /** Determine whether the value of the specified column is null
+     * @param colIndex Index of SQL column in query result (0-based)
+     */
+    isValueNull(colIndex) { return this.stmt.isValueNull(colIndex); }
     /** Get a size in bytes of a blob or text column
      * @param colIndex Index of SQL column in query result (0-based)
      */
-    getColumnBytes(colIndex) { return this._stmt.getColumnBytes(colIndex); }
+    getColumnBytes(colIndex) { return this.stmt.getColumnBytes(colIndex); }
     /** Get a value as a blob
      * @param colIndex Index of SQL column in query result (0-based)
      */
-    getValueBlob(colIndex) { return this._stmt.getValueBlob(colIndex); }
+    getValueBlob(colIndex) { return this.stmt.getValueBlob(colIndex); }
     /** Get a value as a double
     * @param colIndex Index of SQL column in query result (0-based)
     */
-    getValueDouble(colIndex) { return this._stmt.getValueDouble(colIndex); }
+    getValueDouble(colIndex) { return this.stmt.getValueDouble(colIndex); }
     /** Get a value as a integer
     * @param colIndex Index of SQL column in query result (0-based)
     */
-    getValueInteger(colIndex) { return this._stmt.getValueInteger(colIndex); }
+    getValueInteger(colIndex) { return this.stmt.getValueInteger(colIndex); }
     /** Get a value as a string
     * @param colIndex Index of SQL column in query result (0-based)
     */
-    getValueString(colIndex) { return this._stmt.getValueString(colIndex); }
+    getValueString(colIndex) { return this.stmt.getValueString(colIndex); }
     /** Get a value as an Id
     * @param colIndex Index of SQL column in query result (0-based)
     */
-    getValueId(colIndex) { return this._stmt.getValueId(colIndex); }
+    getValueId(colIndex) { return this.stmt.getValueId(colIndex); }
     /** Get a value as a Guid
     * @param colIndex Index of SQL column in query result (0-based)
     */
-    getValueGuid(colIndex) { return this._stmt.getValueGuid(colIndex); }
+    getValueGuid(colIndex) { return this.stmt.getValueGuid(colIndex); }
     /** Get the current row.
      * The returned row is formatted as JavaScript object where every SELECT clause item becomes a property in the JavaScript object.
      *