npm - @itwin/core-backend - Versions diffs - 5.16.0-dev.6 → 5.16.0-dev.7 - Mend

@itwin/core-backend 5.16.0-dev.6 → 5.16.0-dev.7

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (15) hide show

package/CHANGELOG.md +24 -1
package/lib/cjs/SQLiteDb.d.ts +52 -5
package/lib/cjs/SQLiteDb.d.ts.map +1 -1
package/lib/cjs/SQLiteDb.js +40 -5
package/lib/cjs/SQLiteDb.js.map +1 -1
package/lib/esm/SQLiteDb.d.ts +52 -5
package/lib/esm/SQLiteDb.d.ts.map +1 -1
package/lib/esm/SQLiteDb.js +40 -5
package/lib/esm/SQLiteDb.js.map +1 -1
package/lib/esm/test/standalone/IModelWrite.test.js +6 -2
package/lib/esm/test/standalone/IModelWrite.test.js.map +1 -1
package/lib/esm/test/standalone/SQLiteDb.test.d.ts.map +1 -1
package/lib/esm/test/standalone/SQLiteDb.test.js +422 -1
package/lib/esm/test/standalone/SQLiteDb.test.js.map +1 -1
package/package.json +17 -17

package/CHANGELOG.md CHANGED Viewed

@@ -1,6 +1,29 @@
 # Change Log - @itwin/core-backend
-This log was last generated on Wed, 04 Nov 2026 17:36:46 GMT and should not be manually modified.
+This log was last generated on Thu, 05 Nov 2026 17:48:51 GMT and should not be manually modified.
+## 5.15.0
+Thu, 05 Nov 2026 17:47:36 GMT
+### Updates
+- Return element/model props with Persisted<T> to convey that it has a valid id
+- `EditTxn.deleteElements` is now all-or-nothing: if any element in the expanded delete set is still referenced from outside the set, nothing is deleted and the status is `ConstraintViolation`. `BulkDeleteElementsStatus.PartialSuccess` has been removed. `BulkDeleteElementsResult.failures` reports each blocking element with a `BulkDeleteFailureReason`. Deprecated `skipFKConstraintValidations` (now ignored) and `failedIds`. Successful deletes invalidate instance caches, including surviving elements whose navigation references were cleared.
+- Text annotation fields can index into a String property holding serialized JSON.
+- Quantity and coordinate `FieldRun` values in text annotations now render through the iTwin.js quantity formatting pipeline instead of `toString()`, using the property's KindOfQuantity and the schema's presentation format by default. Apps can supply `FormatSet`s per iModel with `ElementDrivesTextAnnotation.registerFieldFormatting` and evaluate fields in memory with `ElementDrivesTextAnnotation.evaluateFields`. `@itwin/core-quantity` is now a peer dependency of this package.
+- ViewStore.queryViews now validates its query parameters and binds them as SQL parameters.
+- Preserve unchanged geographic coordinate systems during iModel property updates, safely restore the cached CRS after rollback without reentrant writes or stranded transactions when listeners throw, preserve original scoped edit errors even when rollback logging fails, and retry default GCS workspace loading after failed initial connections.
+- Add @beta ChangeUnifier, which merges the rows of ChangesetReaders into EC instances in native code with bounded memory.
+- Add optional iModelId to BlobContainer.MetadataResponse.
+- Added TxnManager.onPrePushValidation.
+- NativeApp.deleteBriefcase now only deletes files in the briefcase cache or valid iModels. BriefcaseManager.deleteBriefcaseFiles only deletes associated files named '<briefcase>-*' or '<briefcase>.*'.
+- Reuse ECSQL column metadata for cached statements in withQueryReader.
+- Promote RebaseManager abort, resume, dispose, rebase events, setCustomHandler, merge state, and RebaseHandler (including recompute, dispose, and shouldReinstate) from @alpha to @beta. Promote TxnManager.rebaser from @internal to @beta. Promote TxnManager.withIndirectTxnMode, withIndirectTxnModeAsync, getMode, getTxnProps, queryTxns, getLastSavedTxnProps, and TxnMode from @alpha to @beta. Mark RebaseManager.resumeSemantic, onConflict, addConflictHandler, and removeConflictHandler as @internal because they depend on internal types.
+- Add Relationships.queryInstances and queryInstancesProps to look up many relationships of a class with batched queries.
+- Bug fix for leader fill color
+- Added check against 0 length elbow when wantElbow is true
+- Move Sheet and Drawing sub-model class validation into Element.onSubModelInsert and allow domain ISubModeledElement classes to define permitted model classes.
+- Add a beta API for discovering available Vertical Coordinate Reference Systems.
 ## 5.14.6
 Wed, 04 Nov 2026 17:35:14 GMT

package/lib/cjs/SQLiteDb.d.ts CHANGED Viewed

@@ -2,7 +2,7 @@
  * @module SQLiteDb
  */
 import { IModelJsNative } from "@bentley/imodeljs-native";
-import { DbResult, OpenMode } from "@itwin/core-bentley";
+import { DbConflictResolution, DbResult, OpenMode } from "@itwin/core-bentley";
 import { LocalFileName } from "@itwin/core-common";
 import { CloudSqlite } from "./CloudSqlite";
 import { SqliteStatement } from "./SqliteStatement";
@@ -106,17 +106,21 @@ export declare class SQLiteDb {
      * extension - to this SQLiteDb. This is *not* the same on-disk format used for iModel changesets.
      * Unlike `BriefcaseDb.pullChanges`, this does *not* perform any iModel-style changeset relationship validation (e.g. parentId/changesetId)
      * against the current state of the database (raw sqlite changesets have no header) - it simply applies the changes it contains. It also does *not*
-     * support DDL/schema changes - raw sqlite changesets cannot represent them. If applying the changeset
-     * encounters any conflict, or otherwise fails, this method throws (conflicts are never resolved
-     * automatically).
+     * support DDL/schema changes - raw sqlite changesets cannot represent them. Conflicts abort by default.
+     * A built-in policy or custom handler can resolve conflicts; unresolved conflicts and other failures throw.
      * @note this method only throws on failure - it does *not* commit or abandon any changes itself. If it
      * throws, some (but not necessarily all) of the changeset's changes may have already been applied to the
      * current transaction. It is the caller's responsibility to call [[saveChanges]] or [[abandonChanges]]
      * as appropriate after catching an error from this method.
      * @param changesetFile the local file name of the changeset to apply.
+     * @param flags Independent apply options. Defaults to [[SQLiteDb.ApplyChangesetFlags.None]].
+     * @param conflictHandler Defaults to [[SQLiteDb.ChangesetConflictPolicy.AbortOnAnyConflict]].
+     * Use [[SQLiteDb.ChangesetConflictPolicy.NoLocalChanges]] for the generic iModel policy without
+     * table-specific rules, or supply a synchronous custom handler. This does not enable any apply flags:
+     * to suppress cascades, also pass [[SQLiteDb.ApplyChangesetFlags.FkNoAction]].
      * @internal
      */
-    applyChangeset(changesetFile: LocalFileName): void;
+    applyChangeset(changesetFile: LocalFileName, flags?: SQLiteDb.ApplyChangesetFlags, conflictHandler?: SQLiteDb.ChangesetConflictPolicy | SQLiteDb.ChangesetConflictHandler): void;
     /**
      * Begin capturing data changes made to this SQLiteDb, so they may later be saved via [[createChangeset]].
      * Intended only to produce changeset files for testing [[applyChangeset]] - not for any other purpose.
@@ -245,6 +249,49 @@ export declare abstract class VersionedSqliteDb extends SQLiteDb {
 }
 /** @public */
 export declare namespace SQLiteDb {
+    /** Independent flags for applying a raw SQLite changeset. Combine with bitwise OR.
+     * @internal
+     */
+    enum ApplyChangesetFlags {
+        /** Apply with no optional flags. */
+        None = 0,
+        /** Apply the inverse of the changeset. */
+        Invert = 1,
+        /** Skip changes that would leave the database unchanged without invoking the conflict handler. */
+        IgnoreNoop = 2,
+        /** Treat all foreign-key actions as NO ACTION, including CASCADE, RESTRICT, SET NULL, and SET DEFAULT. */
+        FkNoAction = 4,
+        /** Report cyclic UNIQUE updates as constraint conflicts instead of retrying them. */
+        NoUpdateLoop = 8
+    }
+    /** Built-in conflict policies, independent of apply flags.
+     * @internal
+     */
+    enum ChangesetConflictPolicy {
+        /** Abort on any conflict. This is the default. */
+        AbortOnAnyConflict = 0,
+        /** Generic iModel policy with no local changes: skip missing rows and constraint conflicts,
+         * replace data and primary-key insert conflicts, and abort on foreign-key violations.
+         * Indirect data conflicts are replaced without warnings except for sqlite_stat1 conflicts.
+         * Primary-key insert conflicts are replaced with a warning even for indirect changes.
+         * Does not include iModel-specific table rules or disable foreign-key actions.
+         */
+        NoLocalChanges = 1
+    }
+    /** Copied conflict metadata, safe to retain after the callback returns.
+     * Row conflicts include table, operation, column count, and primary-key indices.
+     * Foreign-key conflicts only include their cause and violation count because SQLite provides no associated row.
+     * @internal
+     */
+    type ChangesetConflictArgs = IModelJsNative.SQLiteChangesetConflictArgs;
+    /** A synchronous callback returning Skip, Replace, or Abort. Exceptions abort application and
+     * propagate to the caller, who remains responsible for abandoning any partially applied changes.
+     * Replace is valid only for data and primary-key insert conflicts.
+     * The handler may query this database, but must not modify it (including through prepared
+     * statements), close it, change its transaction, or recursively apply another changeset to it.
+     * @internal
+     */
+    type ChangesetConflictHandler = (args: ChangesetConflictArgs) => DbConflictResolution;
     /** A semver version range.
      * @see https://docs.npmjs.com/cli/v6/using-npm/semver
      */

package/lib/cjs/SQLiteDb.d.ts.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"SQLiteDb.d.ts","sourceRoot":"","sources":["../../src/SQLiteDb.ts"],"names":[],"mappings":"AAIA;;GAEG;AAKH,OAAO,EAAE,cAAc,EAAE,MAAM,0BAA0B,CAAC;AAC1D,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;~~AACzD~~,OAAO,EAAE,aAAa,EAAe,MAAM,oBAAoB,CAAC;AAChE,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAG5C,OAAO,EAAE,eAAe,EAAkB,MAAM,mBAAmB,CAAC;AACpE,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAI/C;;;GAGG;AACH,qBAAa,QAAQ;IACnB,gBAAgB;IAChB,SAAgB,CAAC,SAAS,CAAC,0BAAwC;IACnE,OAAO,CAAC,qBAAqB,CAAyC;IAEtE,gBAAgB;WACF,YAAY,IAAI,QAAQ,CAAC,MAAM;IAI7C;;OAEG;IACI,OAAO,IAAI,IAAI;IAItB;;OAEG;IACI,QAAQ,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI;IACrC,YAAY;IACL,QAAQ,CAAC,MAAM,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,WAAW,CAAC,cAAc,EAAE,MAAM,CAAC,EAAE,QAAQ,CAAC,YAAY,GAAG,IAAI;IAK7G;;OAEG;IACI,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,GAAG,QAAQ,CAAC,UAAU,GAAG,IAAI;IAC7E;;;OAGG;IACI,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,GAAG,QAAQ,CAAC,UAAU,EAAE,SAAS,CAAC,EAAE,WAAW,CAAC,cAAc,GAAG,IAAI;IAKrH;;OAEG;IACI,OAAO,CAAC,WAAW,CAAC,EAAE,OAAO,GAAG,IAAI;IAO3C,4CAA4C;IAC5C,IAAW,MAAM,IAAI,OAAO,CAAqC;IAEjE,qDAAqD;IACrD,IAAW,UAAU,IAAI,OAAO,CAAyC;IAEzE,2CAA2C;IAC3C,SAAS,CAAC,WAAW,CAAC,IAAI,EAAE;QAC1B,uCAAuC;QACvC,SAAS,EAAE,MAAM,CAAC;QAClB,uCAAuC;QACvC,OAAO,EAAE,MAAM,CAAC;QAChB,4CAA4C;QAC5C,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,yFAAyF;QACzF,YAAY,CAAC,EAAE,OAAO,CAAC;KACxB;IAQD;;;MAGE;IACK,eAAe,CAAC,SAAS,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI;IAO9D;;;;;;;;;;;OAWG;IACI,UAAU,CAAC,CAAC,EAAE,IAAI,EAAE,QAAQ,CAAC,cAAc,EAAE,SAAS,EAAE,MAAM,CAAC,GAAG,CAAC;IAgB1E;;OAEG;IACH,IAAW,cAAc,IAAI,WAAW,CAAC,cAAc,GAAG,SAAS,CAElE;IAED,+JAA+J;IACxJ,kBAAkB,IAAI,MAAM;IAInC;;;;;;;;;;;;OAYG;IACU,mBAAmB,CAAC,CAAC,EAAE,IAAI,EAAE,WAAW,CAAC,eAAe,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC,CAAC,CAAC;IAIlG;;OAEG;IACI,MAAM,CAAC,IAAI,CAAC,EAAE,QAAQ,CAAC,YAAY;IAI1C,4GAA4G;IACrG,WAAW,IAAI,IAAI;IAI1B,iIAAiI;IAC1H,cAAc,IAAI,IAAI;IAI7B~~;;;;;;;;;;;;;;OAcG~~;IACI,cAAc,CAAC,aAAa,EAAE,aAAa,GAAG,IAAI;~~IAIzD~~;;;;;;OAMG;IACI,mBAAmB,IAAI,IAAI;IAIlC;;;;;;;;OAQG;IACI,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI;IAIpC;;;;;;;OAOG;IACI,eAAe,CAAC,aAAa,EAAE,aAAa,GAAG,IAAI;IAI1D;;;;;;;;;OASG;IACI,2BAA2B,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,IAAI,EAAE,eAAe,KAAK,CAAC,GAAG,CAAC;IAa7F;;;;;;;OAOG;IACI,mBAAmB,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,IAAI,EAAE,eAAe,KAAK,CAAC,GAAG,CAAC;IAarF;;;;OAIG;IACI,aAAa,CAAC,aAAa,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,IAAI;IAcjE;;;;SAIK;IACE,sBAAsB,CAAC,GAAG,EAAE,MAAM,EAAE,SAAS,UAAO,GAAG,eAAe;IAM7E,+BAA+B;IACxB,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,QAAQ;CAIzC;AAED;;;;;;;;;;GAUG;AACH,8BAAsB,iBAAkB,SAAQ,QAAQ;IACtD,SAAS,CAAC,MAAM,CAAC,aAAa;;;MAAwD;IAEtF;;;;;;;;MAQE;IACF,SAAgB,SAAS,EAAE,MAAM,CAAC;IAElC;;;;;OAKG;IACI,mBAAmB,CAAC,QAAQ,EAAE,QAAQ,CAAC,qBAAqB;IAKnE,gFAAgF;IACzE,mBAAmB;IAa1B;;OAEG;IACH,SAAS,CAAC,QAAQ,CAAC,SAAS,CAAC,IAAI,EAAE,GAAG,GAAG,IAAI;IAE7C;;;OAGG;WACW,WAAW,CAAC,QAAQ,EAAE,aAAa,EAAE,SAAS,CAAC,EAAE,GAAG;IAalE;;;OAGG;IACH,SAAS,CAAC,cAAc;IAaxB;;;;OAIG;IACa,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,GAAG,QAAQ,CAAC,UAAU,EAAE,SAAS,CAAC,EAAE,WAAW,CAAC,cAAc;IAK1G,aAAa,CAAC,GAAG,EAAE;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,aAAa,CAAC,EAAE;YAAE,SAAS,EAAE,WAAW,CAAC,cAAc,CAAC;YAAC,IAAI,EAAE,MAAM,CAAA;SAAE,CAAC;QAAC,SAAS,EAAE,MAAM,IAAI,CAAA;KAAE,yBAAN,IAAI;CAMjJ;AAED,cAAc;AACd,yBAAiB,QAAQ,CAAC;IACxB;;OAEG;IACH,KAAY,YAAY,GAAG,MAAM,CAAC;IAElC;;;OAGG;IACH,UAAiB,qBAAqB;QACpC,uFAAuF;QACvF,QAAQ,CAAC,WAAW,EAAE,YAAY,CAAC;QACnC,qFAAqF;QACrF,QAAQ,CAAC,YAAY,EAAE,YAAY,CAAC;KACrC;IAED;;OAEG;IACH,UAAiB,MAAM;QACrB;;YAEI;QACJ,KAAK,IAAI,IAAI,CAAC;QACd,gDAAgD;QAChD,WAAW,IAAI,MAAM,CAAC;QACtB,mGAAmG;QACnG,OAAO,IAAI,OAAO,CAAC;QACnB,0DAA0D;QAC1D,IAAI;QACF,gCAAgC;QAChC,EAAE,EAAE,cAAc,CAAC,KAAK,EACxB,IAAI,EAAE;YACJ,wCAAwC;YACxC,SAAS,EAAE,MAAM,CAAC;YAClB,0CAA0C;YAC1C,UAAU,EAAE,MAAM,CAAC;YACnB,4BAA4B;YAC5B,GAAG,EAAE,MAAM,CAAC;YACZ,iDAAiD;YACjD,SAAS,CAAC,EAAE,OAAO,CAAC;SACrB,GAAG,IAAI,CAAC;QACX;;aAEK;QACL,IAAI,CAAC,IAAI,EAAE;YACT,kCAAkC;YAClC,QAAQ,EAAE,MAAM,CAAC;YACjB,8CAA8C;YAC9C,MAAM,EAAE,MAAM,CAAC;YACf,6EAA6E;YAC7E,IAAI,CAAC,EAAE,WAAW,CAAC;SACpB,GAAG,UAAU,CAAC;QACf;;aAEK;QACL,SAAS,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;QAC7B,sBAAsB;QACtB,KAAK,CAAC,IAAI,EAAE;YACV,oCAAoC;YACpC,QAAQ,EAAE,MAAM,CAAC;YACjB,+CAA+C;YAC/C,MAAM,EAAE,MAAM,CAAC;YACf,yBAAyB;YACzB,IAAI,EAAE,WAAW,CAAC;SACnB,GAAG,IAAI,CAAC;KACV;IAED;;OAEG;IACH,KAAY,cAAc;QACxB,4GAA4G;QAC5G,IAAI,IAAI;QACR,4FAA4F;QAC5F,QAAQ,IAAI;QACZ,yEAAyE;QACzE,SAAS,IAAI;QACb,yEAAyE;QACzE,SAAS,IAAI;KACd;IAED,8DAA8D;IAC9D,UAAiB,kBAAkB;QACjC,6DAA6D;QAC7D,SAAS,CAAC,EAAE,OAAO,CAAC;QACpB,sEAAsE;QACtE,SAAS,CAAC,EAAE,OAAO,CAAC;QACpB,oFAAoF;QACpF,aAAa,CAAC,EAAE,OAAO,CAAC;QACxB;;QAEA;QACA,UAAU,CAAC,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAC3B,2FAA2F;QAC3F,UAAU,CAAC,EAAE,MAAM,CAAC;KACrB;IAED,kDAAkD;IAClD,UAAiB,UAAW,SAAQ,kBAAkB;QACpD,gEAAgE;QAChE,QAAQ,EAAE,QAAQ,CAAC;KACpB;IAED,uCAAuC;IACvC,UAAiB,QAAQ;QACvB,8DAA8D;QAC9D,QAAQ,CAAC,EAAE,MAAM,CAAC;KACnB;IAED,6CAA6C;IAC7C,KAAY,YAAY,GAAG,kBAAkB,GAAG,QAAQ,CAAC;IAEzD,0CAA0C;IAC1C,UAAiB,cAAc;QAC7B,uCAAuC;QACvC,MAAM,EAAE,MAAM,CAAC;QACf,wEAAwE;QACxE,QAAQ,CAAC,EAAE,QAAQ,GAAG,QAAQ,CAAC,UAAU,CAAC;QAC1C,gBAAgB;QAChB,SAAS,CAAC,EAAE,WAAW,CAAC,cAAc,CAAC;KACxC;IAED,sCAAsC;IACtC,UAAiB,YAAa,SAAQ,QAAQ;QAC5C,6FAA6F;QAC7F,IAAI,CAAC,EAAE,aAAa,CAAC;KACtB;CACF"}
1	+ {"version":3,"file":"SQLiteDb.d.ts","sourceRoot":"","sources":["../../src/SQLiteDb.ts"],"names":[],"mappings":"AAIA;;GAEG;AAKH,OAAO,EAAE,cAAc,EAAE,MAAM,0BAA0B,CAAC;AAC1D,OAAO,EAAE,oBAAoB,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AAC/E,OAAO,EAAE,aAAa,EAAe,MAAM,oBAAoB,CAAC;AAChE,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAG5C,OAAO,EAAE,eAAe,EAAkB,MAAM,mBAAmB,CAAC;AACpE,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAI/C;;;GAGG;AACH,qBAAa,QAAQ;IACnB,gBAAgB;IAChB,SAAgB,CAAC,SAAS,CAAC,0BAAwC;IACnE,OAAO,CAAC,qBAAqB,CAAyC;IAEtE,gBAAgB;WACF,YAAY,IAAI,QAAQ,CAAC,MAAM;IAI7C;;OAEG;IACI,OAAO,IAAI,IAAI;IAItB;;OAEG;IACI,QAAQ,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI;IACrC,YAAY;IACL,QAAQ,CAAC,MAAM,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,WAAW,CAAC,cAAc,EAAE,MAAM,CAAC,EAAE,QAAQ,CAAC,YAAY,GAAG,IAAI;IAK7G;;OAEG;IACI,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,GAAG,QAAQ,CAAC,UAAU,GAAG,IAAI;IAC7E;;;OAGG;IACI,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,GAAG,QAAQ,CAAC,UAAU,EAAE,SAAS,CAAC,EAAE,WAAW,CAAC,cAAc,GAAG,IAAI;IAKrH;;OAEG;IACI,OAAO,CAAC,WAAW,CAAC,EAAE,OAAO,GAAG,IAAI;IAO3C,4CAA4C;IAC5C,IAAW,MAAM,IAAI,OAAO,CAAqC;IAEjE,qDAAqD;IACrD,IAAW,UAAU,IAAI,OAAO,CAAyC;IAEzE,2CAA2C;IAC3C,SAAS,CAAC,WAAW,CAAC,IAAI,EAAE;QAC1B,uCAAuC;QACvC,SAAS,EAAE,MAAM,CAAC;QAClB,uCAAuC;QACvC,OAAO,EAAE,MAAM,CAAC;QAChB,4CAA4C;QAC5C,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,yFAAyF;QACzF,YAAY,CAAC,EAAE,OAAO,CAAC;KACxB;IAQD;;;MAGE;IACK,eAAe,CAAC,SAAS,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI;IAO9D;;;;;;;;;;;OAWG;IACI,UAAU,CAAC,CAAC,EAAE,IAAI,EAAE,QAAQ,CAAC,cAAc,EAAE,SAAS,EAAE,MAAM,CAAC,GAAG,CAAC;IAgB1E;;OAEG;IACH,IAAW,cAAc,IAAI,WAAW,CAAC,cAAc,GAAG,SAAS,CAElE;IAED,+JAA+J;IACxJ,kBAAkB,IAAI,MAAM;IAInC;;;;;;;;;;;;OAYG;IACU,mBAAmB,CAAC,CAAC,EAAE,IAAI,EAAE,WAAW,CAAC,eAAe,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC,CAAC,CAAC;IAIlG;;OAEG;IACI,MAAM,CAAC,IAAI,CAAC,EAAE,QAAQ,CAAC,YAAY;IAI1C,4GAA4G;IACrG,WAAW,IAAI,IAAI;IAI1B,iIAAiI;IAC1H,cAAc,IAAI,IAAI;IAI7B;;;;;;;;;;;;;;;;;;OAkBG;IACI,cAAc,CAAC,aAAa,EAAE,aAAa,EAAE,KAAK,CAAC,EAAE,QAAQ,CAAC,mBAAmB,EAAE,eAAe,CAAC,EAAE,QAAQ,CAAC,uBAAuB,GAAG,QAAQ,CAAC,wBAAwB,GAAG,IAAI;IAIvL;;;;;;OAMG;IACI,mBAAmB,IAAI,IAAI;IAIlC;;;;;;;;OAQG;IACI,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI;IAIpC;;;;;;;OAOG;IACI,eAAe,CAAC,aAAa,EAAE,aAAa,GAAG,IAAI;IAI1D;;;;;;;;;OASG;IACI,2BAA2B,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,IAAI,EAAE,eAAe,KAAK,CAAC,GAAG,CAAC;IAa7F;;;;;;;OAOG;IACI,mBAAmB,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,IAAI,EAAE,eAAe,KAAK,CAAC,GAAG,CAAC;IAarF;;;;OAIG;IACI,aAAa,CAAC,aAAa,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,IAAI;IAcjE;;;;SAIK;IACE,sBAAsB,CAAC,GAAG,EAAE,MAAM,EAAE,SAAS,UAAO,GAAG,eAAe;IAM7E,+BAA+B;IACxB,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,QAAQ;CAIzC;AAED;;;;;;;;;;GAUG;AACH,8BAAsB,iBAAkB,SAAQ,QAAQ;IACtD,SAAS,CAAC,MAAM,CAAC,aAAa;;;MAAwD;IAEtF;;;;;;;;MAQE;IACF,SAAgB,SAAS,EAAE,MAAM,CAAC;IAElC;;;;;OAKG;IACI,mBAAmB,CAAC,QAAQ,EAAE,QAAQ,CAAC,qBAAqB;IAKnE,gFAAgF;IACzE,mBAAmB;IAa1B;;OAEG;IACH,SAAS,CAAC,QAAQ,CAAC,SAAS,CAAC,IAAI,EAAE,GAAG,GAAG,IAAI;IAE7C;;;OAGG;WACW,WAAW,CAAC,QAAQ,EAAE,aAAa,EAAE,SAAS,CAAC,EAAE,GAAG;IAalE;;;OAGG;IACH,SAAS,CAAC,cAAc;IAaxB;;;;OAIG;IACa,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,GAAG,QAAQ,CAAC,UAAU,EAAE,SAAS,CAAC,EAAE,WAAW,CAAC,cAAc;IAK1G,aAAa,CAAC,GAAG,EAAE;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,aAAa,CAAC,EAAE;YAAE,SAAS,EAAE,WAAW,CAAC,cAAc,CAAC;YAAC,IAAI,EAAE,MAAM,CAAA;SAAE,CAAC;QAAC,SAAS,EAAE,MAAM,IAAI,CAAA;KAAE,yBAAN,IAAI;CAMjJ;AAED,cAAc;AACd,yBAAiB,QAAQ,CAAC;IACxB;;OAEG;IACH,KAAY,mBAAmB;QAC7B,oCAAoC;QACpC,IAAI,IAAI;QACR,0CAA0C;QAC1C,MAAM,IAAI;QACV,kGAAkG;QAClG,UAAU,IAAI;QACd,0GAA0G;QAC1G,UAAU,IAAI;QACd,qFAAqF;QACrF,YAAY,IAAI;KACjB;IAED;;OAEG;IACH,KAAY,uBAAuB;QACjC,kDAAkD;QAClD,kBAAkB,IAAI;QACtB;;;;;WAKG;QACH,cAAc,IAAI;KACnB;IAED;;;;OAIG;IACH,KAAY,qBAAqB,GAAG,cAAc,CAAC,2BAA2B,CAAC;IAE/E;;;;;;OAMG;IACH,KAAY,wBAAwB,GAAG,CAAC,IAAI,EAAE,qBAAqB,KAAK,oBAAoB,CAAC;IAE7F;;OAEG;IACH,KAAY,YAAY,GAAG,MAAM,CAAC;IAElC;;;OAGG;IACH,UAAiB,qBAAqB;QACpC,uFAAuF;QACvF,QAAQ,CAAC,WAAW,EAAE,YAAY,CAAC;QACnC,qFAAqF;QACrF,QAAQ,CAAC,YAAY,EAAE,YAAY,CAAC;KACrC;IAED;;OAEG;IACH,UAAiB,MAAM;QACrB;;YAEI;QACJ,KAAK,IAAI,IAAI,CAAC;QACd,gDAAgD;QAChD,WAAW,IAAI,MAAM,CAAC;QACtB,mGAAmG;QACnG,OAAO,IAAI,OAAO,CAAC;QACnB,0DAA0D;QAC1D,IAAI;QACF,gCAAgC;QAChC,EAAE,EAAE,cAAc,CAAC,KAAK,EACxB,IAAI,EAAE;YACJ,wCAAwC;YACxC,SAAS,EAAE,MAAM,CAAC;YAClB,0CAA0C;YAC1C,UAAU,EAAE,MAAM,CAAC;YACnB,4BAA4B;YAC5B,GAAG,EAAE,MAAM,CAAC;YACZ,iDAAiD;YACjD,SAAS,CAAC,EAAE,OAAO,CAAC;SACrB,GAAG,IAAI,CAAC;QACX;;aAEK;QACL,IAAI,CAAC,IAAI,EAAE;YACT,kCAAkC;YAClC,QAAQ,EAAE,MAAM,CAAC;YACjB,8CAA8C;YAC9C,MAAM,EAAE,MAAM,CAAC;YACf,6EAA6E;YAC7E,IAAI,CAAC,EAAE,WAAW,CAAC;SACpB,GAAG,UAAU,CAAC;QACf;;aAEK;QACL,SAAS,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;QAC7B,sBAAsB;QACtB,KAAK,CAAC,IAAI,EAAE;YACV,oCAAoC;YACpC,QAAQ,EAAE,MAAM,CAAC;YACjB,+CAA+C;YAC/C,MAAM,EAAE,MAAM,CAAC;YACf,yBAAyB;YACzB,IAAI,EAAE,WAAW,CAAC;SACnB,GAAG,IAAI,CAAC;KACV;IAED;;OAEG;IACH,KAAY,cAAc;QACxB,4GAA4G;QAC5G,IAAI,IAAI;QACR,4FAA4F;QAC5F,QAAQ,IAAI;QACZ,yEAAyE;QACzE,SAAS,IAAI;QACb,yEAAyE;QACzE,SAAS,IAAI;KACd;IAED,8DAA8D;IAC9D,UAAiB,kBAAkB;QACjC,6DAA6D;QAC7D,SAAS,CAAC,EAAE,OAAO,CAAC;QACpB,sEAAsE;QACtE,SAAS,CAAC,EAAE,OAAO,CAAC;QACpB,oFAAoF;QACpF,aAAa,CAAC,EAAE,OAAO,CAAC;QACxB;;QAEA;QACA,UAAU,CAAC,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAC3B,2FAA2F;QAC3F,UAAU,CAAC,EAAE,MAAM,CAAC;KACrB;IAED,kDAAkD;IAClD,UAAiB,UAAW,SAAQ,kBAAkB;QACpD,gEAAgE;QAChE,QAAQ,EAAE,QAAQ,CAAC;KACpB;IAED,uCAAuC;IACvC,UAAiB,QAAQ;QACvB,8DAA8D;QAC9D,QAAQ,CAAC,EAAE,MAAM,CAAC;KACnB;IAED,6CAA6C;IAC7C,KAAY,YAAY,GAAG,kBAAkB,GAAG,QAAQ,CAAC;IAEzD,0CAA0C;IAC1C,UAAiB,cAAc;QAC7B,uCAAuC;QACvC,MAAM,EAAE,MAAM,CAAC;QACf,wEAAwE;QACxE,QAAQ,CAAC,EAAE,QAAQ,GAAG,QAAQ,CAAC,UAAU,CAAC;QAC1C,gBAAgB;QAChB,SAAS,CAAC,EAAE,WAAW,CAAC,cAAc,CAAC;KACxC;IAED,sCAAsC;IACtC,UAAiB,YAAa,SAAQ,QAAQ;QAC5C,6FAA6F;QAC7F,IAAI,CAAC,EAAE,aAAa,CAAC;KACtB;CACF"}

package/lib/cjs/SQLiteDb.js CHANGED Viewed

@@ -198,18 +198,22 @@ class SQLiteDb {
      * extension - to this SQLiteDb. This is *not* the same on-disk format used for iModel changesets.
      * Unlike `BriefcaseDb.pullChanges`, this does *not* perform any iModel-style changeset relationship validation (e.g. parentId/changesetId)
      * against the current state of the database (raw sqlite changesets have no header) - it simply applies the changes it contains. It also does *not*
-     * support DDL/schema changes - raw sqlite changesets cannot represent them. If applying the changeset
-     * encounters any conflict, or otherwise fails, this method throws (conflicts are never resolved
-     * automatically).
+     * support DDL/schema changes - raw sqlite changesets cannot represent them. Conflicts abort by default.
+     * A built-in policy or custom handler can resolve conflicts; unresolved conflicts and other failures throw.
      * @note this method only throws on failure - it does *not* commit or abandon any changes itself. If it
      * throws, some (but not necessarily all) of the changeset's changes may have already been applied to the
      * current transaction. It is the caller's responsibility to call [[saveChanges]] or [[abandonChanges]]
      * as appropriate after catching an error from this method.
      * @param changesetFile the local file name of the changeset to apply.
+     * @param flags Independent apply options. Defaults to [[SQLiteDb.ApplyChangesetFlags.None]].
+     * @param conflictHandler Defaults to [[SQLiteDb.ChangesetConflictPolicy.AbortOnAnyConflict]].
+     * Use [[SQLiteDb.ChangesetConflictPolicy.NoLocalChanges]] for the generic iModel policy without
+     * table-specific rules, or supply a synchronous custom handler. This does not enable any apply flags:
+     * to suppress cascades, also pass [[SQLiteDb.ApplyChangesetFlags.FkNoAction]].
      * @internal
      */
-    applyChangeset(changesetFile) {
-        this[Symbols_1._nativeDb].applyChangeset(changesetFile);
+    applyChangeset(changesetFile, flags, conflictHandler) {
+        this[Symbols_1._nativeDb].applyChangeset(changesetFile, flags, conflictHandler);
     }
     /**
      * Begin capturing data changes made to this SQLiteDb, so they may later be saved via [[createChangeset]].
@@ -417,6 +421,37 @@ class VersionedSqliteDb extends SQLiteDb {
 exports.VersionedSqliteDb = VersionedSqliteDb;
 /** @public */
 (function (SQLiteDb) {
+    /** Independent flags for applying a raw SQLite changeset. Combine with bitwise OR.
+     * @internal
+     */
+    let ApplyChangesetFlags;
+    (function (ApplyChangesetFlags) {
+        /** Apply with no optional flags. */
+        ApplyChangesetFlags[ApplyChangesetFlags["None"] = 0] = "None";
+        /** Apply the inverse of the changeset. */
+        ApplyChangesetFlags[ApplyChangesetFlags["Invert"] = 1] = "Invert";
+        /** Skip changes that would leave the database unchanged without invoking the conflict handler. */
+        ApplyChangesetFlags[ApplyChangesetFlags["IgnoreNoop"] = 2] = "IgnoreNoop";
+        /** Treat all foreign-key actions as NO ACTION, including CASCADE, RESTRICT, SET NULL, and SET DEFAULT. */
+        ApplyChangesetFlags[ApplyChangesetFlags["FkNoAction"] = 4] = "FkNoAction";
+        /** Report cyclic UNIQUE updates as constraint conflicts instead of retrying them. */
+        ApplyChangesetFlags[ApplyChangesetFlags["NoUpdateLoop"] = 8] = "NoUpdateLoop";
+    })(ApplyChangesetFlags = SQLiteDb.ApplyChangesetFlags || (SQLiteDb.ApplyChangesetFlags = {}));
+    /** Built-in conflict policies, independent of apply flags.
+     * @internal
+     */
+    let ChangesetConflictPolicy;
+    (function (ChangesetConflictPolicy) {
+        /** Abort on any conflict. This is the default. */
+        ChangesetConflictPolicy[ChangesetConflictPolicy["AbortOnAnyConflict"] = 0] = "AbortOnAnyConflict";
+        /** Generic iModel policy with no local changes: skip missing rows and constraint conflicts,
+         * replace data and primary-key insert conflicts, and abort on foreign-key violations.
+         * Indirect data conflicts are replaced without warnings except for sqlite_stat1 conflicts.
+         * Primary-key insert conflicts are replaced with a warning even for indirect changes.
+         * Does not include iModel-specific table rules or disable foreign-key actions.
+         */
+        ChangesetConflictPolicy[ChangesetConflictPolicy["NoLocalChanges"] = 1] = "NoLocalChanges";
+    })(ChangesetConflictPolicy = SQLiteDb.ChangesetConflictPolicy || (SQLiteDb.ChangesetConflictPolicy = {}));
     /** Default transaction mode for SQLiteDbs.
      * @see https://www.sqlite.org/lang_transaction.html
      */

package/lib/cjs/SQLiteDb.js.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"SQLiteDb.js","sourceRoot":"","sources":["../../src/SQLiteDb.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEH,yBAAyB;AACzB,+BAA+B;AAC/B,iCAAiC;AAEjC,sDAAyD;AACzD,oDAAgE;AAChE,+CAA4C;AAC5C,8DAAyD;AACzD,6CAA0C;AAC1C,uDAAoE;AACpE,gDAA+C;AAE/C,0CAA0C;AAE1C;;;GAGG;AACH,MAAa,QAAQ;IACnB,gBAAgB;IACA,CAAC,mBAAS,CAAC,GAAG,IAAI,6BAAY,CAAC,QAAQ,CAAC,QAAQ,EAAE,CAAC;IAC3D,qBAAqB,GAAG,IAAI,gCAAc,EAAmB,CAAC;IAEtE,gBAAgB;IACT,MAAM,CAAC,YAAY;QACxB,OAAO,IAAI,6BAAY,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC;IAC5C,CAAC;IAED;;OAEG;IACI,OAAO;QACZ,IAAI,CAAC,OAAO,EAAE,CAAC;IACjB,CAAC;IAQM,QAAQ,CAAC,MAAc,EAAE,SAAsC,EAAE,MAA8B;QACpG,IAAI,CAAC,mBAAS,CAAC,CAAC,QAAQ,CAAC,MAAM,EAAE,SAAS,EAAE,MAAM,CAAC,CAAC;IACtD,CAAC;IAWM,MAAM,CAAC,MAAc,EAAE,QAAwC,EAAE,SAAsC;QAC5G,IAAI,CAAC,mBAAS,CAAC,CAAC,MAAM,CAAC,MAAM,EAAE,QAAQ,EAAE,SAAS,CAAC,CAAC;IACtD,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,mBAAS,CAAC,CAAC,OAAO,EAAE,CAAC;IAC5B,CAAC;IAED,4CAA4C;IAC5C,IAAW,MAAM,KAAc,OAAO,IAAI,CAAC,mBAAS,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;IAEjE,qDAAqD;IACrD,IAAW,UAAU,KAAc,OAAO,IAAI,CAAC,mBAAS,CAAC,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC;IAEzE,2CAA2C;IACjC,WAAW,CAAC,IASrB;QACC,MAAM,YAAY,GAAG,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,uDAAuD,CAAC,CAAC,CAAC,EAAE,CAAC;QACtG,MAAM,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QACnE,IAAI,CAAC,UAAU,CAAC,gBAAgB,IAAI,CAAC,SAAS,IAAI,IAAI,CAAC,OAAO,GAAG,YAAY,GAAG,WAAW,GAAG,CAAC,CAAC;QAChG,IAAI,IAAI,CAAC,YAAY;YACnB,IAAI,CAAC,UAAU,CAAC,kBAAkB,IAAI,CAAC,SAAS,8BAA8B,IAAI,CAAC,SAAS,kFAAkF,IAAI,CAAC,SAAS,0DAA0D,CAAC,CAAC;IAC5P,CAAC;IAED;;;MAGE;IACK,eAAe,CAAC,SAAiB,EAAE,KAAa;QACrD,OAAO,IAAI,CAAC,mBAAmB,CAAC,uBAAuB,SAAS,gBAAgB,EAAE,CAAC,IAAI,EAAE,EAAE;YACzF,IAAI,CAAC,WAAW,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;YAC3B,OAAO,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;QAC9B,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;OAWG;IACI,UAAU,CAAI,IAA6B,EAAE,SAAkB;QACpE,IAAI,IAAI,CAAC,MAAM;YACb,yBAAW,CAAC,UAAU,CAAC,cAAc,EAAE,0BAA0B,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;QAElF,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,IAAI,CAAC,QAAQ,IAAI,uBAAQ,CAAC,QAAQ,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;QAC7E,IAAI,CAAC;YACH,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;QAChB,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,OAAO,EAAE,CAAC;YACV,MAAM,CAAC,CAAC;QACV,CAAC;IACH,CAAC;IAED;;OAEG;IACH,IAAW,cAAc;QACvB,OAAO,IAAI,CAAC,mBAAS,CAAC,CAAC,cAAc,CAAC;IACxC,CAAC;IAED,+JAA+J;IACxJ,kBAAkB;QACvB,OAAO,IAAI,CAAC,mBAAS,CAAC,CAAC,kBAAkB,EAAE,CAAC;IAC9C,CAAC;IAED;;;;;;;;;;;;OAYG;IACI,KAAK,CAAC,mBAAmB,CAAI,IAAiC,EAAE,SAA2B;QAChG,OAAO,yBAAW,CAAC,aAAa,CAAC,IAAI,EAAE,KAAK,IAAI,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE,GAAG,IAAI,EAAE,QAAQ,EAAE,IAAI,CAAC,QAAQ,IAAI,uBAAQ,CAAC,SAAS,EAAE,EAAE,SAAS,CAAC,CAAC,CAAC;IAC7I,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,IAA4B;QACxC,IAAI,CAAC,mBAAS,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IAC/B,CAAC;IAED,4GAA4G;IACrG,WAAW;QAChB,IAAI,CAAC,mBAAS,CAAC,CAAC,WAAW,EAAE,CAAC;IAChC,CAAC;IAED,iIAAiI;IAC1H,cAAc;QACnB,IAAI,CAAC,mBAAS,CAAC,CAAC,cAAc,EAAE,CAAC;IACnC,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACI,cAAc,CAAC,aAA4B;QAChD,IAAI,CAAC,mBAAS,CAAC,CAAC,cAAc,CAAC,aAAa,CAAC,CAAC;IAChD,CAAC;IAED;;;;;;OAMG;IACI,mBAAmB;QACxB,IAAI,CAAC,mBAAS,CAAC,CAAC,mBAAmB,EAAE,CAAC;IACxC,CAAC;IAED;;;;;;;;OAQG;IACI,UAAU,CAAC,GAAW;QAC3B,IAAI,CAAC,mBAAS,CAAC,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;IAClC,CAAC;IAED;;;;;;;OAOG;IACI,eAAe,CAAC,aAA4B;QACjD,IAAI,CAAC,mBAAS,CAAC,CAAC,eAAe,CAAC,aAAa,CAAC,CAAC;IACjD,CAAC;IAED;;;;;;;;;OASG;IACI,2BAA2B,CAAI,GAAW,EAAE,QAAsC;QACvF,MAAM,IAAI,GAAG,IAAI,CAAC,qBAAqB,CAAC,aAAa,CAAC,GAAG,CAAC,IAAI,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,CAAC;YACH,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;QACb,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,OAAO,EAAE,CAAC;YACV,MAAM,GAAG,CAAC;QACZ,CAAC;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,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC;QAC7C,IAAI,CAAC;YACH,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;QACb,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,OAAO,EAAE,CAAC;YACV,MAAM,GAAG,CAAC;QACZ,CAAC;IACH,CAAC;IAED;;;;OAIG;IACI,aAAa,CAAC,aAAqB,EAAE,SAAqB;QAC/D,IAAI,IAAI,CAAC,UAAU;YACjB,yBAAW,CAAC,UAAU,CAAC,UAAU,EAAE,sBAAsB,EAAE,IAAI,CAAC,mBAAS,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC;QAE5F,IAAI,CAAC,UAAU,CAAC,aAAa,aAAa,EAAE,CAAC,CAAC;QAC9C,IAAI,CAAC;YACH,SAAS,EAAE,CAAC;YACZ,IAAI,CAAC,UAAU,CAAC,WAAW,aAAa,EAAE,CAAC,CAAC;QAC9C,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,IAAI,CAAC,UAAU,CAAC,eAAe,aAAa,EAAE,CAAC,CAAC;YAChD,MAAM,CAAC,CAAC;QACV,CAAC;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,mBAAS,CAAC,EAAE,SAAS,CAAC,CAAC;QACzC,OAAO,IAAI,CAAC;IACd,CAAC;IAED,+BAA+B;IACxB,UAAU,CAAC,GAAW;;;YAC3B,MAAM,IAAI,kCAAG,IAAI,CAAC,sBAAsB,CAAC,GAAG,CAAC,QAAA,CAAC;YAC9C,OAAO,IAAI,CAAC,IAAI,EAAE,CAAC;;;;;;;;;KACpB;CACF;AArSD,4BAqSC;AAED;;;;;;;;;;GAUG;AACH,MAAsB,iBAAkB,SAAQ,QAAQ;IAC5C,MAAM,CAAC,aAAa,GAAG,EAAE,SAAS,EAAE,UAAU,EAAE,IAAI,EAAE,UAAU,EAAW,CAAC;IAatF;;;;;OAKG;IACI,mBAAmB,CAAC,QAAwC;QACjE,6IAA6I;QAC7I,IAAI,CAAC,mBAAS,CAAC,CAAC,gBAAgB,CAAC,iBAAiB,CAAC,aAAa,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE,WAAW,EAAE,QAAQ,CAAC,WAAW,EAAE,YAAY,EAAE,QAAQ,CAAC,YAAY,EAAE,CAAC,CAAC,CAAC;IAChK,CAAC;IAED,gFAAgF;IACzE,mBAAmB;QACxB,MAAM,aAAa,GAAG,CAAC,KAAU,EAAE,EAAE;YACnC,IAAI,OAAO,KAAK,KAAK,QAAQ;gBAC3B,yBAAW,CAAC,UAAU,CAAC,2BAA2B,EAAE,yCAAyC,EAAE,IAAI,CAAC,mBAAS,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC;YAChI,OAAO,KAAK,CAAC;QACf,CAAC,CAAC;QACF,MAAM,WAAW,GAAG,aAAa,CAAC,IAAI,CAAC,mBAAS,CAAC,CAAC,iBAAiB,CAAC,iBAAiB,CAAC,aAAa,EAAE,IAAI,CAAC,CAAC,CAAC;QAC5G,MAAM,aAAa,GAAG,IAAI,CAAC,KAAK,CAAC,WAAW,CAAmC,CAAC;QAChF,aAAa,CAAC,aAAa,CAAC,WAAW,CAAC,CAAC;QACzC,aAAa,CAAC,aAAa,CAAC,YAAY,CAAC,CAAC;QAC1C,OAAO,aAAa,CAAC;IACvB,CAAC;IAOD;;;OAGG;IACI,MAAM,CAAC,WAAW,CAAC,QAAuB,EAAE,SAAe;QAChE,MAAM,EAAE,GAAG,IAAK,IAAY,EAAuB,CAAC,CAAC,2DAA2D;QAChH,uBAAU,CAAC,kBAAkB,CAAC,IAAA,cAAO,EAAC,QAAQ,CAAC,CAAC,CAAC;QACjD,IAAI,EAAE,CAAC,UAAU,CAAC,QAAQ,CAAC;YACzB,EAAE,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;QAE1B,EAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;QACtB,EAAE,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;QACxB,MAAM,MAAM,GAAG,IAAI,EAAE,CAAC,SAAS,EAAE,CAAC;QAClC,EAAE,CAAC,mBAAmB,CAAC,EAAE,WAAW,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,EAAE,CAAC,CAAC;QACtE,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IACnB,CAAC;IAED;;;OAGG;IACO,cAAc;QACtB,MAAM,QAAQ,GAAG,IAAI,CAAC,mBAAmB,EAAE,CAAC;QAC5C,MAAM,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC,CAAC,sDAAsD;QAC1F,MAAM,KAAK,GAAG,UAAU,CAAC,CAAC,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC,CAAC,QAAQ,CAAC,YAAY,CAAC;QACxE,IAAI,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,SAAS,EAAE,KAAK,CAAC;YACzC,OAAO;QAET,IAAI,CAAC,OAAO,EAAE,CAAC;QACf,MAAM,MAAM,GAAG,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC;QACjD,yBAAW,CAAC,UAAU,CAAC,sBAAsB,EAAE,YAAY,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,eAAe,IAAI,CAAC,WAAW,CAAC,IAAI,QAAQ,UAAU,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,EAAE,EAAE,IAAI,CAAC,mBAAS,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC;IAEnM,CAAC;IAED;;;;OAIG;IACa,MAAM,CAAC,MAAc,EAAE,QAAwC,EAAE,SAAsC;QACrH,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,QAAQ,EAAE,SAAS,CAAC,CAAC;QAC1C,IAAI,CAAC,cAAc,EAAE,CAAC;IACxB,CAAC;IAEM,KAAK,CAAC,aAAa,CAAC,GAAuH;QAChJ,2EAA2E;QAC3E,OAAO,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC,CAAC;YAC1B,KAAK,CAAC,mBAAmB,CAAC,EAAE,MAAM,EAAE,GAAG,CAAC,MAAM,EAAE,GAAG,GAAG,CAAC,aAAa,EAAE,EAAE,KAAK,IAAI,EAAE,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC;YACpG,KAAK,CAAC,UAAU,CAAC,EAAE,GAAG,GAAG,EAAE,QAAQ,EAAE,uBAAQ,CAAC,SAAS,EAAE,EAAE,GAAG,CAAC,SAAS,CAAC,CAAC;IAC9E,CAAC;;AA7FH,8CA8FC;AAED,cAAc;AACd,WAAiB,QAAQ;IAqEvB;;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,EAjIgB,QAAQ,wBAAR,QAAQ,QAiIxB","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 as fs from \"fs\";\r\nimport { dirname } from \"path\";\r\nimport * as semver from \"semver\";\r\nimport { IModelJsNative } from \"@bentley/imodeljs-native\";\r\nimport { DbResult, OpenMode } from \"@itwin/core-bentley\";\r\nimport { LocalFileName, SqliteError } from \"@itwin/core-common\";\r\nimport { CloudSqlite } from \"./CloudSqlite\";\r\nimport { IModelNative } from \"./internal/NativePlatform\";\r\nimport { IModelJsFs } from \"./IModelJsFs\";\r\nimport { SqliteStatement, StatementCache } from \"./SqliteStatement\";\r\nimport { _nativeDb } from \"./internal/Symbols\";\r\n\r\n// cspell:ignore savepoint julianday rowid\r\n\r\n/*\r\n A \"generic\" SQLiteDb. This class may be used to access local files or databases in a cloud container.\r\n * @public\r\n /\r\nexport class SQLiteDb {\r\n /* @internal /\r\n public readonly [_nativeDb] = new IModelNative.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 IModelNative.platform.BlobIO();\r\n }\r\n\r\n /* alias for closeDb.\r\n * @deprecated in 4.0 - might be removed in next major version. Use [[closeDb]]\r\n /\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 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 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 /* Create a new table in this database. /\r\n protected createTable(args: {\r\n /* The name of the table to create. /\r\n tableName: string;\r\n /* all of the columns in the table. /\r\n columns: string;\r\n /* any unique or foreign key constraints /\r\n constraints?: string;\r\n /* if true, add a \"lastMod\" timestamp column and triggers to automatically update it. /\r\n addTimestamp?: boolean;\r\n }) {\r\n const timestampCol = args.addTimestamp ? \",lastMod TIMESTAMP NOT NULL DEFAULT(julianday('now'))\" : \"\";\r\n const constraints = args.constraints ? `,${args.constraints}` : \"\";\r\n this.executeSQL(`CREATE TABLE ${args.tableName}(${args.columns}${timestampCol}${constraints})`);\r\n if (args.addTimestamp)\r\n this.executeSQL(`CREATE TRIGGER ${args.tableName}_timestamp AFTER UPDATE ON ${args.tableName} WHEN old.lastMod=new.lastMod AND old.lastMod != julianday('now') BEGIN UPDATE ${args.tableName} SET lastMod=julianday('now') WHERE rowid=new.rowid; END`);\r\n }\r\n\r\n /\r\n Get the last modified date for a row in a table of this database.\r\n * @note the table must have been created with `addTimestamp: true`\r\n /\r\n public readLastModTime(tableName: string, rowId: number): Date {\r\n return this.withSqliteStatement(`SELECT lastMod from ${tableName} WHERE rowid=?`, (stmt) => {\r\n stmt.bindInteger(1, rowId);\r\n return stmt.getValueDate(0);\r\n });\r\n }\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 SqliteError.throwError(\"already-open\", \"database is already open\", args.dbName);\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 /* The cloud container backing this SQLite database, if any.\r\n * @beta\r\n /\r\n public get cloudContainer(): CloudSqlite.CloudContainer \| undefined {\r\n return this[_nativeDb].cloudContainer;\r\n }\r\n\r\n /* Returns the Id of the most-recently-inserted row in this database, per [sqlite3_last_insert_rowid](https://www.sqlite.org/c3ref/last_insert_rowid.html). /\r\n public getLastInsertRowId(): number {\r\n return this[_nativeDb].getLastInsertRowId();\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: () => Promise<T>) {\r\n return CloudSqlite.withWriteLock(args, async () => this.withOpenDb({ ...args, openMode: args.openMode ?? OpenMode.ReadWrite }, operation));\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 default 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 default transaction. /\r\n public abandonChanges(): void {\r\n this[_nativeDb].abandonChanges();\r\n }\r\n\r\n /\r\n Apply a raw sqlite changeset file - the plain, uncompressed byte stream produced by the sqlite session\r\n * extension - to this SQLiteDb. This is not the same on-disk format used for iModel changesets.\r\n * Unlike `BriefcaseDb.pullChanges`, this does not perform any iModel-style changeset relationship validation (e.g. parentId/changesetId)\r\n * against the current state of the database (raw sqlite changesets have no header) - it simply applies the changes it contains. It also does not\r\n * support DDL/schema changes - raw sqlite changesets cannot represent them. If applying the changeset\r\n * encounters any conflict, or otherwise fails, this method throws (conflicts are never resolved\r\n * automatically).\r\n * @note this method only throws on failure - it does not commit or abandon any changes itself. If it\r\n * throws, some (but not necessarily all) of the changeset's changes may have already been applied to the\r\n * current transaction. It is the caller's responsibility to call [[saveChanges]] or [[abandonChanges]]\r\n * as appropriate after catching an error from this method.\r\n * @param changesetFile the local file name of the changeset to apply.\r\n * @internal\r\n /\r\n public applyChangeset(changesetFile: LocalFileName): void {\r\n this[_nativeDb].applyChangeset(changesetFile);\r\n }\r\n\r\n /\r\n Begin capturing data changes made to this SQLiteDb, so they may later be saved via [[createChangeset]].\r\n * Intended only to produce changeset files for testing [[applyChangeset]] - not for any other purpose.\r\n * @note DDL/schema changes are not captured - the raw sqlite changeset format produced by [[createChangeset]]\r\n * cannot represent them. [[createChangeset]] throws if any DDL was executed via [[executeDdl]] since tracking began.\r\n * @internal\r\n /\r\n public startChangeTracking(): void {\r\n this[_nativeDb].startChangeTracking();\r\n }\r\n\r\n /\r\n Execute a DDL statement (e.g. `CREATE TABLE`). DDL cannot be represented in the raw sqlite changeset format\r\n * produced by [[createChangeset]], so it is never included in a changeset regardless of how it is executed.\r\n * However, unlike DDL executed via [[executeSQL]], DDL executed via this method is recorded by change\r\n * tracking (see [[startChangeTracking]]) for detection purposes: if any DDL is executed via this method while\r\n * tracking is active, [[createChangeset]] throws rather than silently producing a changeset that omits the\r\n * schema change.\r\n * @internal\r\n /\r\n public executeDdl(ddl: string): void {\r\n this[_nativeDb].executeDdl(ddl);\r\n }\r\n\r\n /\r\n Write out the changes captured since [[startChangeTracking]] was called to a changeset file, holding the\r\n * raw sqlite changeset (the plain, uncompressed byte stream produced by the sqlite session extension). This\r\n * is not the same on-disk format used for iModel changesets. Throws if any DDL/schema changes were captured,\r\n * since raw sqlite changesets cannot represent them.\r\n * @param changesetFile the local file name to write the changeset to.\r\n * @internal\r\n /\r\n public createChangeset(changesetFile: LocalFileName): void {\r\n this[_nativeDb].createChangeset(changesetFile);\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 Prepare 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[Symbol.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 SqliteError.throwError(\"readonly\", \"database is readonly\", this[_nativeDb].getFilePath());\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 using stmt = this.prepareSqliteStatement(sql);\r\n return stmt.step();\r\n }\r\n}\r\n\r\n/\r\n Abstract base class for a SQLite database that has [[SQLiteDb.RequiredVersionRanges]] stored in it.\r\n * This class provides version checking when the database is opened, to guarantee that a valid version of software is\r\n * always used for access.\r\n \r\n Notes:\r\n * - This class may be used either to access a local file, or one stored in a cloud container.\r\n * - Subclasses must provide a `myVersion` member indicating the version of its software, and implement the `createDDL` member to create its\r\n * tables.\r\n * @beta\r\n /\r\nexport abstract class VersionedSqliteDb extends SQLiteDb {\r\n protected static _versionProps = { namespace: \"SQLiteDb\", name: \"versions\" } as const;\r\n\r\n /* The current semver \"persistence version\" of this class.\r\n * @note This value should only be changed when logic in its code is modified in a way that affects the operation of extant copies.\r\n * If this value is outside of the range of accepted versions of a to-be-opened VersionedSqliteDb, the operation will fail. In this manner, if\r\n * changes are made to the format of a VersionedSqliteDb, or if bug fixes are necessary, the `requiredVersions` property in a VersionedSqliteDb may be updated\r\n * and immediately old versions of the package will refuse to open the VersionedSqliteDb, with a message to the user that they need to upgrade their\r\n * software. Likewise, if a new version of the package is asked to open an older VersionedSqliteDb that has not been upgraded to the lowest version\r\n * supported by it, the user will be informed that they need to upgrade their software.\r\n * @note this identifier is independent of versions in `package.json` files.\r\n /\r\n public abstract myVersion: string;\r\n\r\n /\r\n Change the \"versions required to open this database\" property stored in this database. After this call,\r\n * versions of software that don't meet the supplied ranges will fail.\r\n * @param versions the new versions required for reading and writing this database.\r\n * @note the database must be opened for write access.\r\n /\r\n public setRequiredVersions(versions: SQLiteDb.RequiredVersionRanges) {\r\n // NOTE: It might look tempting to just stringify the supplied `versions` object, but we only include required members - there may be others.\r\n this[_nativeDb].saveFileProperty(VersionedSqliteDb._versionProps, JSON.stringify({ readVersion: versions.readVersion, writeVersion: versions.writeVersion }));\r\n }\r\n\r\n /* Get the required version ranges necessary to open this VersionedSqliteDb. /\r\n public getRequiredVersions() {\r\n const checkIsString = (value: any) => {\r\n if (typeof value !== \"string\")\r\n SqliteError.throwError(\"invalid-versions-property\", `CloudDb has invalid \"versions\" property`, this[_nativeDb].getFilePath());\r\n return value;\r\n };\r\n const versionJson = checkIsString(this[_nativeDb].queryFileProperty(VersionedSqliteDb._versionProps, true));\r\n const versionRanges = JSON.parse(versionJson) as SQLiteDb.RequiredVersionRanges;\r\n checkIsString(versionRanges.readVersion);\r\n checkIsString(versionRanges.writeVersion);\r\n return versionRanges;\r\n }\r\n\r\n /\r\n Implement this method to create all tables for this subclass of `VersionedSqliteDb` when a new database file is created. Called from [[createNewDb]].\r\n /\r\n protected abstract createDDL(args: any): void;\r\n\r\n /\r\n Create a new database file for the subclass of VersionedSqliteDb.\r\n * @note The required versions are saved as [[myVersion]] or newer for both read and write.\r\n /\r\n public static createNewDb(fileName: LocalFileName, setupArgs?: any) {\r\n const db = new (this as any)() as VersionedSqliteDb; // \"as any\" necessary because VersionedSqliteDb is abstract\r\n IModelJsFs.recursiveMkDirSync(dirname(fileName));\r\n if (fs.existsSync(fileName))\r\n fs.unlinkSync(fileName);\r\n\r\n db.createDb(fileName);\r\n db.createDDL(setupArgs);\r\n const minVer = `^${db.myVersion}`;\r\n db.setRequiredVersions({ readVersion: minVer, writeVersion: minVer });\r\n db.closeDb(true);\r\n }\r\n\r\n /\r\n Verify that this version of the software meets the required version range (as appropriate, read or write) stored in the database.\r\n * Throws otherwise.\r\n /\r\n protected verifyVersions() {\r\n const versions = this.getRequiredVersions();\r\n const isReadonly = this.isReadonly; // so we can tell read/write after the file is closed.\r\n const range = isReadonly ? versions.readVersion : versions.writeVersion;\r\n if (semver.satisfies(this.myVersion, range))\r\n return;\r\n\r\n this.closeDb();\r\n const tooNew = semver.gtr(this.myVersion, range);\r\n SqliteError.throwError(\"incompatible-version\", `requires ${tooNew ? \"older\" : \"newer\"} version of ${this.constructor.name} for ${isReadonly ? \"read\" : \"write\"}`, this[_nativeDb].getFilePath());\r\n\r\n }\r\n\r\n /\r\n Open this database and verify that this version of the software meets the required version range (as appropriate, read or write) stored in the database.\r\n * Throws otherwise.\r\n * @see [[SqliteDb.openDb]] for argument types\r\n /\r\n public override openDb(dbName: string, openMode: OpenMode \| SQLiteDb.OpenParams, container?: CloudSqlite.CloudContainer) {\r\n super.openDb(dbName, openMode, container);\r\n this.verifyVersions();\r\n }\r\n\r\n public async upgradeSchema(arg: { dbName: string, lockContainer?: { container: CloudSqlite.CloudContainer, user: string }, upgradeFn: () => void }) {\r\n // can't use \"this\" because it checks for version, which we don't want here\r\n return (arg.lockContainer) ?\r\n super.withLockedContainer({ dbName: arg.dbName, ...arg.lockContainer }, async () => arg.upgradeFn) :\r\n super.withOpenDb({ ...arg, openMode: OpenMode.ReadWrite }, arg.upgradeFn);\r\n }\r\n}\r\n\r\n/* @public /\r\nexport namespace SQLiteDb {\r\n /* A semver version range.\r\n * @see https://docs.npmjs.com/cli/v6/using-npm/semver\r\n /\r\n export type VersionRange = string;\r\n\r\n /\r\n A pair of semver [[SQLiteDb.VersionRange]]s, one for read and one for write, required to access a [[VersionedSqliteDb]].\r\n * If the version of the software attempting to read or write the database does not satisfy the range, access is denied.\r\n /\r\n export interface RequiredVersionRanges {\r\n /* a range of acceptable persistence versions for reading from a VersionedSqliteDb. /\r\n readonly readVersion: VersionRange;\r\n /* a range of acceptable persistence versions for writing to a VersionedSqliteDb. /\r\n readonly writeVersion: VersionRange;\r\n }\r\n\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"]}
1	+ {"version":3,"file":"SQLiteDb.js","sourceRoot":"","sources":["../../src/SQLiteDb.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEH,yBAAyB;AACzB,+BAA+B;AAC/B,iCAAiC;AAEjC,sDAA+E;AAC/E,oDAAgE;AAChE,+CAA4C;AAC5C,8DAAyD;AACzD,6CAA0C;AAC1C,uDAAoE;AACpE,gDAA+C;AAE/C,0CAA0C;AAE1C;;;GAGG;AACH,MAAa,QAAQ;IACnB,gBAAgB;IACA,CAAC,mBAAS,CAAC,GAAG,IAAI,6BAAY,CAAC,QAAQ,CAAC,QAAQ,EAAE,CAAC;IAC3D,qBAAqB,GAAG,IAAI,gCAAc,EAAmB,CAAC;IAEtE,gBAAgB;IACT,MAAM,CAAC,YAAY;QACxB,OAAO,IAAI,6BAAY,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC;IAC5C,CAAC;IAED;;OAEG;IACI,OAAO;QACZ,IAAI,CAAC,OAAO,EAAE,CAAC;IACjB,CAAC;IAQM,QAAQ,CAAC,MAAc,EAAE,SAAsC,EAAE,MAA8B;QACpG,IAAI,CAAC,mBAAS,CAAC,CAAC,QAAQ,CAAC,MAAM,EAAE,SAAS,EAAE,MAAM,CAAC,CAAC;IACtD,CAAC;IAWM,MAAM,CAAC,MAAc,EAAE,QAAwC,EAAE,SAAsC;QAC5G,IAAI,CAAC,mBAAS,CAAC,CAAC,MAAM,CAAC,MAAM,EAAE,QAAQ,EAAE,SAAS,CAAC,CAAC;IACtD,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,mBAAS,CAAC,CAAC,OAAO,EAAE,CAAC;IAC5B,CAAC;IAED,4CAA4C;IAC5C,IAAW,MAAM,KAAc,OAAO,IAAI,CAAC,mBAAS,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;IAEjE,qDAAqD;IACrD,IAAW,UAAU,KAAc,OAAO,IAAI,CAAC,mBAAS,CAAC,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC;IAEzE,2CAA2C;IACjC,WAAW,CAAC,IASrB;QACC,MAAM,YAAY,GAAG,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,uDAAuD,CAAC,CAAC,CAAC,EAAE,CAAC;QACtG,MAAM,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QACnE,IAAI,CAAC,UAAU,CAAC,gBAAgB,IAAI,CAAC,SAAS,IAAI,IAAI,CAAC,OAAO,GAAG,YAAY,GAAG,WAAW,GAAG,CAAC,CAAC;QAChG,IAAI,IAAI,CAAC,YAAY;YACnB,IAAI,CAAC,UAAU,CAAC,kBAAkB,IAAI,CAAC,SAAS,8BAA8B,IAAI,CAAC,SAAS,kFAAkF,IAAI,CAAC,SAAS,0DAA0D,CAAC,CAAC;IAC5P,CAAC;IAED;;;MAGE;IACK,eAAe,CAAC,SAAiB,EAAE,KAAa;QACrD,OAAO,IAAI,CAAC,mBAAmB,CAAC,uBAAuB,SAAS,gBAAgB,EAAE,CAAC,IAAI,EAAE,EAAE;YACzF,IAAI,CAAC,WAAW,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;YAC3B,OAAO,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;QAC9B,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;OAWG;IACI,UAAU,CAAI,IAA6B,EAAE,SAAkB;QACpE,IAAI,IAAI,CAAC,MAAM;YACb,yBAAW,CAAC,UAAU,CAAC,cAAc,EAAE,0BAA0B,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;QAElF,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,IAAI,CAAC,QAAQ,IAAI,uBAAQ,CAAC,QAAQ,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;QAC7E,IAAI,CAAC;YACH,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;QAChB,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,OAAO,EAAE,CAAC;YACV,MAAM,CAAC,CAAC;QACV,CAAC;IACH,CAAC;IAED;;OAEG;IACH,IAAW,cAAc;QACvB,OAAO,IAAI,CAAC,mBAAS,CAAC,CAAC,cAAc,CAAC;IACxC,CAAC;IAED,+JAA+J;IACxJ,kBAAkB;QACvB,OAAO,IAAI,CAAC,mBAAS,CAAC,CAAC,kBAAkB,EAAE,CAAC;IAC9C,CAAC;IAED;;;;;;;;;;;;OAYG;IACI,KAAK,CAAC,mBAAmB,CAAI,IAAiC,EAAE,SAA2B;QAChG,OAAO,yBAAW,CAAC,aAAa,CAAC,IAAI,EAAE,KAAK,IAAI,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE,GAAG,IAAI,EAAE,QAAQ,EAAE,IAAI,CAAC,QAAQ,IAAI,uBAAQ,CAAC,SAAS,EAAE,EAAE,SAAS,CAAC,CAAC,CAAC;IAC7I,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,IAA4B;QACxC,IAAI,CAAC,mBAAS,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IAC/B,CAAC;IAED,4GAA4G;IACrG,WAAW;QAChB,IAAI,CAAC,mBAAS,CAAC,CAAC,WAAW,EAAE,CAAC;IAChC,CAAC;IAED,iIAAiI;IAC1H,cAAc;QACnB,IAAI,CAAC,mBAAS,CAAC,CAAC,cAAc,EAAE,CAAC;IACnC,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACI,cAAc,CAAC,aAA4B,EAAE,KAAoC,EAAE,eAAsF;QAC9K,IAAI,CAAC,mBAAS,CAAC,CAAC,cAAc,CAAC,aAAa,EAAE,KAAK,EAAE,eAAe,CAAC,CAAC;IACxE,CAAC;IAED;;;;;;OAMG;IACI,mBAAmB;QACxB,IAAI,CAAC,mBAAS,CAAC,CAAC,mBAAmB,EAAE,CAAC;IACxC,CAAC;IAED;;;;;;;;OAQG;IACI,UAAU,CAAC,GAAW;QAC3B,IAAI,CAAC,mBAAS,CAAC,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;IAClC,CAAC;IAED;;;;;;;OAOG;IACI,eAAe,CAAC,aAA4B;QACjD,IAAI,CAAC,mBAAS,CAAC,CAAC,eAAe,CAAC,aAAa,CAAC,CAAC;IACjD,CAAC;IAED;;;;;;;;;OASG;IACI,2BAA2B,CAAI,GAAW,EAAE,QAAsC;QACvF,MAAM,IAAI,GAAG,IAAI,CAAC,qBAAqB,CAAC,aAAa,CAAC,GAAG,CAAC,IAAI,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,CAAC;YACH,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;QACb,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,OAAO,EAAE,CAAC;YACV,MAAM,GAAG,CAAC;QACZ,CAAC;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,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC;QAC7C,IAAI,CAAC;YACH,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;QACb,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,OAAO,EAAE,CAAC;YACV,MAAM,GAAG,CAAC;QACZ,CAAC;IACH,CAAC;IAED;;;;OAIG;IACI,aAAa,CAAC,aAAqB,EAAE,SAAqB;QAC/D,IAAI,IAAI,CAAC,UAAU;YACjB,yBAAW,CAAC,UAAU,CAAC,UAAU,EAAE,sBAAsB,EAAE,IAAI,CAAC,mBAAS,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC;QAE5F,IAAI,CAAC,UAAU,CAAC,aAAa,aAAa,EAAE,CAAC,CAAC;QAC9C,IAAI,CAAC;YACH,SAAS,EAAE,CAAC;YACZ,IAAI,CAAC,UAAU,CAAC,WAAW,aAAa,EAAE,CAAC,CAAC;QAC9C,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,IAAI,CAAC,UAAU,CAAC,eAAe,aAAa,EAAE,CAAC,CAAC;YAChD,MAAM,CAAC,CAAC;QACV,CAAC;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,mBAAS,CAAC,EAAE,SAAS,CAAC,CAAC;QACzC,OAAO,IAAI,CAAC;IACd,CAAC;IAED,+BAA+B;IACxB,UAAU,CAAC,GAAW;;;YAC3B,MAAM,IAAI,kCAAG,IAAI,CAAC,sBAAsB,CAAC,GAAG,CAAC,QAAA,CAAC;YAC9C,OAAO,IAAI,CAAC,IAAI,EAAE,CAAC;;;;;;;;;KACpB;CACF;AAzSD,4BAySC;AAED;;;;;;;;;;GAUG;AACH,MAAsB,iBAAkB,SAAQ,QAAQ;IAC5C,MAAM,CAAC,aAAa,GAAG,EAAE,SAAS,EAAE,UAAU,EAAE,IAAI,EAAE,UAAU,EAAW,CAAC;IAatF;;;;;OAKG;IACI,mBAAmB,CAAC,QAAwC;QACjE,6IAA6I;QAC7I,IAAI,CAAC,mBAAS,CAAC,CAAC,gBAAgB,CAAC,iBAAiB,CAAC,aAAa,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE,WAAW,EAAE,QAAQ,CAAC,WAAW,EAAE,YAAY,EAAE,QAAQ,CAAC,YAAY,EAAE,CAAC,CAAC,CAAC;IAChK,CAAC;IAED,gFAAgF;IACzE,mBAAmB;QACxB,MAAM,aAAa,GAAG,CAAC,KAAU,EAAE,EAAE;YACnC,IAAI,OAAO,KAAK,KAAK,QAAQ;gBAC3B,yBAAW,CAAC,UAAU,CAAC,2BAA2B,EAAE,yCAAyC,EAAE,IAAI,CAAC,mBAAS,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC;YAChI,OAAO,KAAK,CAAC;QACf,CAAC,CAAC;QACF,MAAM,WAAW,GAAG,aAAa,CAAC,IAAI,CAAC,mBAAS,CAAC,CAAC,iBAAiB,CAAC,iBAAiB,CAAC,aAAa,EAAE,IAAI,CAAC,CAAC,CAAC;QAC5G,MAAM,aAAa,GAAG,IAAI,CAAC,KAAK,CAAC,WAAW,CAAmC,CAAC;QAChF,aAAa,CAAC,aAAa,CAAC,WAAW,CAAC,CAAC;QACzC,aAAa,CAAC,aAAa,CAAC,YAAY,CAAC,CAAC;QAC1C,OAAO,aAAa,CAAC;IACvB,CAAC;IAOD;;;OAGG;IACI,MAAM,CAAC,WAAW,CAAC,QAAuB,EAAE,SAAe;QAChE,MAAM,EAAE,GAAG,IAAK,IAAY,EAAuB,CAAC,CAAC,2DAA2D;QAChH,uBAAU,CAAC,kBAAkB,CAAC,IAAA,cAAO,EAAC,QAAQ,CAAC,CAAC,CAAC;QACjD,IAAI,EAAE,CAAC,UAAU,CAAC,QAAQ,CAAC;YACzB,EAAE,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;QAE1B,EAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;QACtB,EAAE,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;QACxB,MAAM,MAAM,GAAG,IAAI,EAAE,CAAC,SAAS,EAAE,CAAC;QAClC,EAAE,CAAC,mBAAmB,CAAC,EAAE,WAAW,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,EAAE,CAAC,CAAC;QACtE,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IACnB,CAAC;IAED;;;OAGG;IACO,cAAc;QACtB,MAAM,QAAQ,GAAG,IAAI,CAAC,mBAAmB,EAAE,CAAC;QAC5C,MAAM,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC,CAAC,sDAAsD;QAC1F,MAAM,KAAK,GAAG,UAAU,CAAC,CAAC,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC,CAAC,QAAQ,CAAC,YAAY,CAAC;QACxE,IAAI,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,SAAS,EAAE,KAAK,CAAC;YACzC,OAAO;QAET,IAAI,CAAC,OAAO,EAAE,CAAC;QACf,MAAM,MAAM,GAAG,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC;QACjD,yBAAW,CAAC,UAAU,CAAC,sBAAsB,EAAE,YAAY,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,eAAe,IAAI,CAAC,WAAW,CAAC,IAAI,QAAQ,UAAU,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,EAAE,EAAE,IAAI,CAAC,mBAAS,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC;IAEnM,CAAC;IAED;;;;OAIG;IACa,MAAM,CAAC,MAAc,EAAE,QAAwC,EAAE,SAAsC;QACrH,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,QAAQ,EAAE,SAAS,CAAC,CAAC;QAC1C,IAAI,CAAC,cAAc,EAAE,CAAC;IACxB,CAAC;IAEM,KAAK,CAAC,aAAa,CAAC,GAAuH;QAChJ,2EAA2E;QAC3E,OAAO,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC,CAAC;YAC1B,KAAK,CAAC,mBAAmB,CAAC,EAAE,MAAM,EAAE,GAAG,CAAC,MAAM,EAAE,GAAG,GAAG,CAAC,aAAa,EAAE,EAAE,KAAK,IAAI,EAAE,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC;YACpG,KAAK,CAAC,UAAU,CAAC,EAAE,GAAG,GAAG,EAAE,QAAQ,EAAE,uBAAQ,CAAC,SAAS,EAAE,EAAE,GAAG,CAAC,SAAS,CAAC,CAAC;IAC9E,CAAC;;AA7FH,8CA8FC;AAED,cAAc;AACd,WAAiB,QAAQ;IACvB;;OAEG;IACH,IAAY,mBAWX;IAXD,WAAY,mBAAmB;QAC7B,oCAAoC;QACpC,6DAAQ,CAAA;QACR,0CAA0C;QAC1C,iEAAU,CAAA;QACV,kGAAkG;QAClG,yEAAc,CAAA;QACd,0GAA0G;QAC1G,yEAAc,CAAA;QACd,qFAAqF;QACrF,6EAAgB,CAAA;IAClB,CAAC,EAXW,mBAAmB,GAAnB,4BAAmB,KAAnB,4BAAmB,QAW9B;IAED;;OAEG;IACH,IAAY,uBAUX;IAVD,WAAY,uBAAuB;QACjC,kDAAkD;QAClD,iGAAsB,CAAA;QACtB;;;;;WAKG;QACH,yFAAkB,CAAA;IACpB,CAAC,EAVW,uBAAuB,GAAvB,gCAAuB,KAAvB,gCAAuB,QAUlC;IAsFD;;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,EAhLgB,QAAQ,wBAAR,QAAQ,QAgLxB","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 as fs from \"fs\";\r\nimport { dirname } from \"path\";\r\nimport * as semver from \"semver\";\r\nimport { IModelJsNative } from \"@bentley/imodeljs-native\";\r\nimport { DbConflictResolution, DbResult, OpenMode } from \"@itwin/core-bentley\";\r\nimport { LocalFileName, SqliteError } from \"@itwin/core-common\";\r\nimport { CloudSqlite } from \"./CloudSqlite\";\r\nimport { IModelNative } from \"./internal/NativePlatform\";\r\nimport { IModelJsFs } from \"./IModelJsFs\";\r\nimport { SqliteStatement, StatementCache } from \"./SqliteStatement\";\r\nimport { _nativeDb } from \"./internal/Symbols\";\r\n\r\n// cspell:ignore savepoint julianday rowid\r\n\r\n/*\r\n A \"generic\" SQLiteDb. This class may be used to access local files or databases in a cloud container.\r\n * @public\r\n /\r\nexport class SQLiteDb {\r\n /* @internal /\r\n public readonly [_nativeDb] = new IModelNative.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 IModelNative.platform.BlobIO();\r\n }\r\n\r\n /* alias for closeDb.\r\n * @deprecated in 4.0 - might be removed in next major version. Use [[closeDb]]\r\n /\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 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 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 /* Create a new table in this database. /\r\n protected createTable(args: {\r\n /* The name of the table to create. /\r\n tableName: string;\r\n /* all of the columns in the table. /\r\n columns: string;\r\n /* any unique or foreign key constraints /\r\n constraints?: string;\r\n /* if true, add a \"lastMod\" timestamp column and triggers to automatically update it. /\r\n addTimestamp?: boolean;\r\n }) {\r\n const timestampCol = args.addTimestamp ? \",lastMod TIMESTAMP NOT NULL DEFAULT(julianday('now'))\" : \"\";\r\n const constraints = args.constraints ? `,${args.constraints}` : \"\";\r\n this.executeSQL(`CREATE TABLE ${args.tableName}(${args.columns}${timestampCol}${constraints})`);\r\n if (args.addTimestamp)\r\n this.executeSQL(`CREATE TRIGGER ${args.tableName}_timestamp AFTER UPDATE ON ${args.tableName} WHEN old.lastMod=new.lastMod AND old.lastMod != julianday('now') BEGIN UPDATE ${args.tableName} SET lastMod=julianday('now') WHERE rowid=new.rowid; END`);\r\n }\r\n\r\n /\r\n Get the last modified date for a row in a table of this database.\r\n * @note the table must have been created with `addTimestamp: true`\r\n /\r\n public readLastModTime(tableName: string, rowId: number): Date {\r\n return this.withSqliteStatement(`SELECT lastMod from ${tableName} WHERE rowid=?`, (stmt) => {\r\n stmt.bindInteger(1, rowId);\r\n return stmt.getValueDate(0);\r\n });\r\n }\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 SqliteError.throwError(\"already-open\", \"database is already open\", args.dbName);\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 /* The cloud container backing this SQLite database, if any.\r\n * @beta\r\n /\r\n public get cloudContainer(): CloudSqlite.CloudContainer \| undefined {\r\n return this[_nativeDb].cloudContainer;\r\n }\r\n\r\n /* Returns the Id of the most-recently-inserted row in this database, per [sqlite3_last_insert_rowid](https://www.sqlite.org/c3ref/last_insert_rowid.html). /\r\n public getLastInsertRowId(): number {\r\n return this[_nativeDb].getLastInsertRowId();\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: () => Promise<T>) {\r\n return CloudSqlite.withWriteLock(args, async () => this.withOpenDb({ ...args, openMode: args.openMode ?? OpenMode.ReadWrite }, operation));\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 default 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 default transaction. /\r\n public abandonChanges(): void {\r\n this[_nativeDb].abandonChanges();\r\n }\r\n\r\n /\r\n Apply a raw sqlite changeset file - the plain, uncompressed byte stream produced by the sqlite session\r\n * extension - to this SQLiteDb. This is not the same on-disk format used for iModel changesets.\r\n * Unlike `BriefcaseDb.pullChanges`, this does not perform any iModel-style changeset relationship validation (e.g. parentId/changesetId)\r\n * against the current state of the database (raw sqlite changesets have no header) - it simply applies the changes it contains. It also does not\r\n * support DDL/schema changes - raw sqlite changesets cannot represent them. Conflicts abort by default.\r\n * A built-in policy or custom handler can resolve conflicts; unresolved conflicts and other failures throw.\r\n * @note this method only throws on failure - it does not commit or abandon any changes itself. If it\r\n * throws, some (but not necessarily all) of the changeset's changes may have already been applied to the\r\n * current transaction. It is the caller's responsibility to call [[saveChanges]] or [[abandonChanges]]\r\n * as appropriate after catching an error from this method.\r\n * @param changesetFile the local file name of the changeset to apply.\r\n * @param flags Independent apply options. Defaults to [[SQLiteDb.ApplyChangesetFlags.None]].\r\n * @param conflictHandler Defaults to [[SQLiteDb.ChangesetConflictPolicy.AbortOnAnyConflict]].\r\n * Use [[SQLiteDb.ChangesetConflictPolicy.NoLocalChanges]] for the generic iModel policy without\r\n * table-specific rules, or supply a synchronous custom handler. This does not enable any apply flags:\r\n * to suppress cascades, also pass [[SQLiteDb.ApplyChangesetFlags.FkNoAction]].\r\n * @internal\r\n /\r\n public applyChangeset(changesetFile: LocalFileName, flags?: SQLiteDb.ApplyChangesetFlags, conflictHandler?: SQLiteDb.ChangesetConflictPolicy \| SQLiteDb.ChangesetConflictHandler): void {\r\n this[_nativeDb].applyChangeset(changesetFile, flags, conflictHandler);\r\n }\r\n\r\n /\r\n Begin capturing data changes made to this SQLiteDb, so they may later be saved via [[createChangeset]].\r\n * Intended only to produce changeset files for testing [[applyChangeset]] - not for any other purpose.\r\n * @note DDL/schema changes are not captured - the raw sqlite changeset format produced by [[createChangeset]]\r\n * cannot represent them. [[createChangeset]] throws if any DDL was executed via [[executeDdl]] since tracking began.\r\n * @internal\r\n /\r\n public startChangeTracking(): void {\r\n this[_nativeDb].startChangeTracking();\r\n }\r\n\r\n /\r\n Execute a DDL statement (e.g. `CREATE TABLE`). DDL cannot be represented in the raw sqlite changeset format\r\n * produced by [[createChangeset]], so it is never included in a changeset regardless of how it is executed.\r\n * However, unlike DDL executed via [[executeSQL]], DDL executed via this method is recorded by change\r\n * tracking (see [[startChangeTracking]]) for detection purposes: if any DDL is executed via this method while\r\n * tracking is active, [[createChangeset]] throws rather than silently producing a changeset that omits the\r\n * schema change.\r\n * @internal\r\n /\r\n public executeDdl(ddl: string): void {\r\n this[_nativeDb].executeDdl(ddl);\r\n }\r\n\r\n /\r\n Write out the changes captured since [[startChangeTracking]] was called to a changeset file, holding the\r\n * raw sqlite changeset (the plain, uncompressed byte stream produced by the sqlite session extension). This\r\n * is not the same on-disk format used for iModel changesets. Throws if any DDL/schema changes were captured,\r\n * since raw sqlite changesets cannot represent them.\r\n * @param changesetFile the local file name to write the changeset to.\r\n * @internal\r\n /\r\n public createChangeset(changesetFile: LocalFileName): void {\r\n this[_nativeDb].createChangeset(changesetFile);\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 Prepare 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[Symbol.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 SqliteError.throwError(\"readonly\", \"database is readonly\", this[_nativeDb].getFilePath());\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 using stmt = this.prepareSqliteStatement(sql);\r\n return stmt.step();\r\n }\r\n}\r\n\r\n/\r\n Abstract base class for a SQLite database that has [[SQLiteDb.RequiredVersionRanges]] stored in it.\r\n * This class provides version checking when the database is opened, to guarantee that a valid version of software is\r\n * always used for access.\r\n \r\n Notes:\r\n * - This class may be used either to access a local file, or one stored in a cloud container.\r\n * - Subclasses must provide a `myVersion` member indicating the version of its software, and implement the `createDDL` member to create its\r\n * tables.\r\n * @beta\r\n /\r\nexport abstract class VersionedSqliteDb extends SQLiteDb {\r\n protected static _versionProps = { namespace: \"SQLiteDb\", name: \"versions\" } as const;\r\n\r\n /* The current semver \"persistence version\" of this class.\r\n * @note This value should only be changed when logic in its code is modified in a way that affects the operation of extant copies.\r\n * If this value is outside of the range of accepted versions of a to-be-opened VersionedSqliteDb, the operation will fail. In this manner, if\r\n * changes are made to the format of a VersionedSqliteDb, or if bug fixes are necessary, the `requiredVersions` property in a VersionedSqliteDb may be updated\r\n * and immediately old versions of the package will refuse to open the VersionedSqliteDb, with a message to the user that they need to upgrade their\r\n * software. Likewise, if a new version of the package is asked to open an older VersionedSqliteDb that has not been upgraded to the lowest version\r\n * supported by it, the user will be informed that they need to upgrade their software.\r\n * @note this identifier is independent of versions in `package.json` files.\r\n /\r\n public abstract myVersion: string;\r\n\r\n /\r\n Change the \"versions required to open this database\" property stored in this database. After this call,\r\n * versions of software that don't meet the supplied ranges will fail.\r\n * @param versions the new versions required for reading and writing this database.\r\n * @note the database must be opened for write access.\r\n /\r\n public setRequiredVersions(versions: SQLiteDb.RequiredVersionRanges) {\r\n // NOTE: It might look tempting to just stringify the supplied `versions` object, but we only include required members - there may be others.\r\n this[_nativeDb].saveFileProperty(VersionedSqliteDb._versionProps, JSON.stringify({ readVersion: versions.readVersion, writeVersion: versions.writeVersion }));\r\n }\r\n\r\n /* Get the required version ranges necessary to open this VersionedSqliteDb. /\r\n public getRequiredVersions() {\r\n const checkIsString = (value: any) => {\r\n if (typeof value !== \"string\")\r\n SqliteError.throwError(\"invalid-versions-property\", `CloudDb has invalid \"versions\" property`, this[_nativeDb].getFilePath());\r\n return value;\r\n };\r\n const versionJson = checkIsString(this[_nativeDb].queryFileProperty(VersionedSqliteDb._versionProps, true));\r\n const versionRanges = JSON.parse(versionJson) as SQLiteDb.RequiredVersionRanges;\r\n checkIsString(versionRanges.readVersion);\r\n checkIsString(versionRanges.writeVersion);\r\n return versionRanges;\r\n }\r\n\r\n /\r\n Implement this method to create all tables for this subclass of `VersionedSqliteDb` when a new database file is created. Called from [[createNewDb]].\r\n /\r\n protected abstract createDDL(args: any): void;\r\n\r\n /\r\n Create a new database file for the subclass of VersionedSqliteDb.\r\n * @note The required versions are saved as [[myVersion]] or newer for both read and write.\r\n /\r\n public static createNewDb(fileName: LocalFileName, setupArgs?: any) {\r\n const db = new (this as any)() as VersionedSqliteDb; // \"as any\" necessary because VersionedSqliteDb is abstract\r\n IModelJsFs.recursiveMkDirSync(dirname(fileName));\r\n if (fs.existsSync(fileName))\r\n fs.unlinkSync(fileName);\r\n\r\n db.createDb(fileName);\r\n db.createDDL(setupArgs);\r\n const minVer = `^${db.myVersion}`;\r\n db.setRequiredVersions({ readVersion: minVer, writeVersion: minVer });\r\n db.closeDb(true);\r\n }\r\n\r\n /\r\n Verify that this version of the software meets the required version range (as appropriate, read or write) stored in the database.\r\n * Throws otherwise.\r\n /\r\n protected verifyVersions() {\r\n const versions = this.getRequiredVersions();\r\n const isReadonly = this.isReadonly; // so we can tell read/write after the file is closed.\r\n const range = isReadonly ? versions.readVersion : versions.writeVersion;\r\n if (semver.satisfies(this.myVersion, range))\r\n return;\r\n\r\n this.closeDb();\r\n const tooNew = semver.gtr(this.myVersion, range);\r\n SqliteError.throwError(\"incompatible-version\", `requires ${tooNew ? \"older\" : \"newer\"} version of ${this.constructor.name} for ${isReadonly ? \"read\" : \"write\"}`, this[_nativeDb].getFilePath());\r\n\r\n }\r\n\r\n /\r\n Open this database and verify that this version of the software meets the required version range (as appropriate, read or write) stored in the database.\r\n * Throws otherwise.\r\n * @see [[SqliteDb.openDb]] for argument types\r\n /\r\n public override openDb(dbName: string, openMode: OpenMode \| SQLiteDb.OpenParams, container?: CloudSqlite.CloudContainer) {\r\n super.openDb(dbName, openMode, container);\r\n this.verifyVersions();\r\n }\r\n\r\n public async upgradeSchema(arg: { dbName: string, lockContainer?: { container: CloudSqlite.CloudContainer, user: string }, upgradeFn: () => void }) {\r\n // can't use \"this\" because it checks for version, which we don't want here\r\n return (arg.lockContainer) ?\r\n super.withLockedContainer({ dbName: arg.dbName, ...arg.lockContainer }, async () => arg.upgradeFn) :\r\n super.withOpenDb({ ...arg, openMode: OpenMode.ReadWrite }, arg.upgradeFn);\r\n }\r\n}\r\n\r\n/* @public /\r\nexport namespace SQLiteDb {\r\n /* Independent flags for applying a raw SQLite changeset. Combine with bitwise OR.\r\n * @internal\r\n /\r\n export enum ApplyChangesetFlags {\r\n /* Apply with no optional flags. /\r\n None = 0,\r\n /* Apply the inverse of the changeset. /\r\n Invert = 1,\r\n /* Skip changes that would leave the database unchanged without invoking the conflict handler. /\r\n IgnoreNoop = 2,\r\n /* Treat all foreign-key actions as NO ACTION, including CASCADE, RESTRICT, SET NULL, and SET DEFAULT. /\r\n FkNoAction = 4,\r\n /* Report cyclic UNIQUE updates as constraint conflicts instead of retrying them. /\r\n NoUpdateLoop = 8,\r\n }\r\n\r\n /* Built-in conflict policies, independent of apply flags.\r\n * @internal\r\n /\r\n export enum ChangesetConflictPolicy {\r\n /* Abort on any conflict. This is the default. /\r\n AbortOnAnyConflict = 0,\r\n /* Generic iModel policy with no local changes: skip missing rows and constraint conflicts,\r\n * replace data and primary-key insert conflicts, and abort on foreign-key violations.\r\n * Indirect data conflicts are replaced without warnings except for sqlite_stat1 conflicts.\r\n * Primary-key insert conflicts are replaced with a warning even for indirect changes.\r\n * Does not include iModel-specific table rules or disable foreign-key actions.\r\n /\r\n NoLocalChanges = 1,\r\n }\r\n\r\n /* Copied conflict metadata, safe to retain after the callback returns.\r\n * Row conflicts include table, operation, column count, and primary-key indices.\r\n * Foreign-key conflicts only include their cause and violation count because SQLite provides no associated row.\r\n * @internal\r\n /\r\n export type ChangesetConflictArgs = IModelJsNative.SQLiteChangesetConflictArgs;\r\n\r\n /* A synchronous callback returning Skip, Replace, or Abort. Exceptions abort application and\r\n * propagate to the caller, who remains responsible for abandoning any partially applied changes.\r\n * Replace is valid only for data and primary-key insert conflicts.\r\n * The handler may query this database, but must not modify it (including through prepared\r\n * statements), close it, change its transaction, or recursively apply another changeset to it.\r\n * @internal\r\n /\r\n export type ChangesetConflictHandler = (args: ChangesetConflictArgs) => DbConflictResolution;\r\n\r\n /* A semver version range.\r\n * @see https://docs.npmjs.com/cli/v6/using-npm/semver\r\n /\r\n export type VersionRange = string;\r\n\r\n /\r\n A pair of semver [[SQLiteDb.VersionRange]]s, one for read and one for write, required to access a [[VersionedSqliteDb]].\r\n * If the version of the software attempting to read or write the database does not satisfy the range, access is denied.\r\n /\r\n export interface RequiredVersionRanges {\r\n /* a range of acceptable persistence versions for reading from a VersionedSqliteDb. /\r\n readonly readVersion: VersionRange;\r\n /* a range of acceptable persistence versions for writing to a VersionedSqliteDb. /\r\n readonly writeVersion: VersionRange;\r\n }\r\n\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/esm/SQLiteDb.d.ts CHANGED Viewed

@@ -2,7 +2,7 @@
  * @module SQLiteDb
  */
 import { IModelJsNative } from "@bentley/imodeljs-native";
-import { DbResult, OpenMode } from "@itwin/core-bentley";
+import { DbConflictResolution, DbResult, OpenMode } from "@itwin/core-bentley";
 import { LocalFileName } from "@itwin/core-common";
 import { CloudSqlite } from "./CloudSqlite";
 import { SqliteStatement } from "./SqliteStatement";
@@ -106,17 +106,21 @@ export declare class SQLiteDb {
      * extension - to this SQLiteDb. This is *not* the same on-disk format used for iModel changesets.
      * Unlike `BriefcaseDb.pullChanges`, this does *not* perform any iModel-style changeset relationship validation (e.g. parentId/changesetId)
      * against the current state of the database (raw sqlite changesets have no header) - it simply applies the changes it contains. It also does *not*
-     * support DDL/schema changes - raw sqlite changesets cannot represent them. If applying the changeset
-     * encounters any conflict, or otherwise fails, this method throws (conflicts are never resolved
-     * automatically).
+     * support DDL/schema changes - raw sqlite changesets cannot represent them. Conflicts abort by default.
+     * A built-in policy or custom handler can resolve conflicts; unresolved conflicts and other failures throw.
      * @note this method only throws on failure - it does *not* commit or abandon any changes itself. If it
      * throws, some (but not necessarily all) of the changeset's changes may have already been applied to the
      * current transaction. It is the caller's responsibility to call [[saveChanges]] or [[abandonChanges]]
      * as appropriate after catching an error from this method.
      * @param changesetFile the local file name of the changeset to apply.
+     * @param flags Independent apply options. Defaults to [[SQLiteDb.ApplyChangesetFlags.None]].
+     * @param conflictHandler Defaults to [[SQLiteDb.ChangesetConflictPolicy.AbortOnAnyConflict]].
+     * Use [[SQLiteDb.ChangesetConflictPolicy.NoLocalChanges]] for the generic iModel policy without
+     * table-specific rules, or supply a synchronous custom handler. This does not enable any apply flags:
+     * to suppress cascades, also pass [[SQLiteDb.ApplyChangesetFlags.FkNoAction]].
      * @internal
      */
-    applyChangeset(changesetFile: LocalFileName): void;
+    applyChangeset(changesetFile: LocalFileName, flags?: SQLiteDb.ApplyChangesetFlags, conflictHandler?: SQLiteDb.ChangesetConflictPolicy | SQLiteDb.ChangesetConflictHandler): void;
     /**
      * Begin capturing data changes made to this SQLiteDb, so they may later be saved via [[createChangeset]].
      * Intended only to produce changeset files for testing [[applyChangeset]] - not for any other purpose.
@@ -245,6 +249,49 @@ export declare abstract class VersionedSqliteDb extends SQLiteDb {
 }
 /** @public */
 export declare namespace SQLiteDb {
+    /** Independent flags for applying a raw SQLite changeset. Combine with bitwise OR.
+     * @internal
+     */
+    enum ApplyChangesetFlags {
+        /** Apply with no optional flags. */
+        None = 0,
+        /** Apply the inverse of the changeset. */
+        Invert = 1,
+        /** Skip changes that would leave the database unchanged without invoking the conflict handler. */
+        IgnoreNoop = 2,
+        /** Treat all foreign-key actions as NO ACTION, including CASCADE, RESTRICT, SET NULL, and SET DEFAULT. */
+        FkNoAction = 4,
+        /** Report cyclic UNIQUE updates as constraint conflicts instead of retrying them. */
+        NoUpdateLoop = 8
+    }
+    /** Built-in conflict policies, independent of apply flags.
+     * @internal
+     */
+    enum ChangesetConflictPolicy {
+        /** Abort on any conflict. This is the default. */
+        AbortOnAnyConflict = 0,
+        /** Generic iModel policy with no local changes: skip missing rows and constraint conflicts,
+         * replace data and primary-key insert conflicts, and abort on foreign-key violations.
+         * Indirect data conflicts are replaced without warnings except for sqlite_stat1 conflicts.
+         * Primary-key insert conflicts are replaced with a warning even for indirect changes.
+         * Does not include iModel-specific table rules or disable foreign-key actions.
+         */
+        NoLocalChanges = 1
+    }
+    /** Copied conflict metadata, safe to retain after the callback returns.
+     * Row conflicts include table, operation, column count, and primary-key indices.
+     * Foreign-key conflicts only include their cause and violation count because SQLite provides no associated row.
+     * @internal
+     */
+    type ChangesetConflictArgs = IModelJsNative.SQLiteChangesetConflictArgs;
+    /** A synchronous callback returning Skip, Replace, or Abort. Exceptions abort application and
+     * propagate to the caller, who remains responsible for abandoning any partially applied changes.
+     * Replace is valid only for data and primary-key insert conflicts.
+     * The handler may query this database, but must not modify it (including through prepared
+     * statements), close it, change its transaction, or recursively apply another changeset to it.
+     * @internal
+     */
+    type ChangesetConflictHandler = (args: ChangesetConflictArgs) => DbConflictResolution;
     /** A semver version range.
      * @see https://docs.npmjs.com/cli/v6/using-npm/semver
      */

package/lib/esm/SQLiteDb.d.ts.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"SQLiteDb.d.ts","sourceRoot":"","sources":["../../src/SQLiteDb.ts"],"names":[],"mappings":"AAIA;;GAEG;AAKH,OAAO,EAAE,cAAc,EAAE,MAAM,0BAA0B,CAAC;AAC1D,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;~~AACzD~~,OAAO,EAAE,aAAa,EAAe,MAAM,oBAAoB,CAAC;AAChE,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAG5C,OAAO,EAAE,eAAe,EAAkB,MAAM,mBAAmB,CAAC;AACpE,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAI/C;;;GAGG;AACH,qBAAa,QAAQ;IACnB,gBAAgB;IAChB,SAAgB,CAAC,SAAS,CAAC,0BAAwC;IACnE,OAAO,CAAC,qBAAqB,CAAyC;IAEtE,gBAAgB;WACF,YAAY,IAAI,QAAQ,CAAC,MAAM;IAI7C;;OAEG;IACI,OAAO,IAAI,IAAI;IAItB;;OAEG;IACI,QAAQ,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI;IACrC,YAAY;IACL,QAAQ,CAAC,MAAM,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,WAAW,CAAC,cAAc,EAAE,MAAM,CAAC,EAAE,QAAQ,CAAC,YAAY,GAAG,IAAI;IAK7G;;OAEG;IACI,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,GAAG,QAAQ,CAAC,UAAU,GAAG,IAAI;IAC7E;;;OAGG;IACI,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,GAAG,QAAQ,CAAC,UAAU,EAAE,SAAS,CAAC,EAAE,WAAW,CAAC,cAAc,GAAG,IAAI;IAKrH;;OAEG;IACI,OAAO,CAAC,WAAW,CAAC,EAAE,OAAO,GAAG,IAAI;IAO3C,4CAA4C;IAC5C,IAAW,MAAM,IAAI,OAAO,CAAqC;IAEjE,qDAAqD;IACrD,IAAW,UAAU,IAAI,OAAO,CAAyC;IAEzE,2CAA2C;IAC3C,SAAS,CAAC,WAAW,CAAC,IAAI,EAAE;QAC1B,uCAAuC;QACvC,SAAS,EAAE,MAAM,CAAC;QAClB,uCAAuC;QACvC,OAAO,EAAE,MAAM,CAAC;QAChB,4CAA4C;QAC5C,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,yFAAyF;QACzF,YAAY,CAAC,EAAE,OAAO,CAAC;KACxB;IAQD;;;MAGE;IACK,eAAe,CAAC,SAAS,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI;IAO9D;;;;;;;;;;;OAWG;IACI,UAAU,CAAC,CAAC,EAAE,IAAI,EAAE,QAAQ,CAAC,cAAc,EAAE,SAAS,EAAE,MAAM,CAAC,GAAG,CAAC;IAgB1E;;OAEG;IACH,IAAW,cAAc,IAAI,WAAW,CAAC,cAAc,GAAG,SAAS,CAElE;IAED,+JAA+J;IACxJ,kBAAkB,IAAI,MAAM;IAInC;;;;;;;;;;;;OAYG;IACU,mBAAmB,CAAC,CAAC,EAAE,IAAI,EAAE,WAAW,CAAC,eAAe,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC,CAAC,CAAC;IAIlG;;OAEG;IACI,MAAM,CAAC,IAAI,CAAC,EAAE,QAAQ,CAAC,YAAY;IAI1C,4GAA4G;IACrG,WAAW,IAAI,IAAI;IAI1B,iIAAiI;IAC1H,cAAc,IAAI,IAAI;IAI7B~~;;;;;;;;;;;;;;OAcG~~;IACI,cAAc,CAAC,aAAa,EAAE,aAAa,GAAG,IAAI;~~IAIzD~~;;;;;;OAMG;IACI,mBAAmB,IAAI,IAAI;IAIlC;;;;;;;;OAQG;IACI,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI;IAIpC;;;;;;;OAOG;IACI,eAAe,CAAC,aAAa,EAAE,aAAa,GAAG,IAAI;IAI1D;;;;;;;;;OASG;IACI,2BAA2B,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,IAAI,EAAE,eAAe,KAAK,CAAC,GAAG,CAAC;IAa7F;;;;;;;OAOG;IACI,mBAAmB,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,IAAI,EAAE,eAAe,KAAK,CAAC,GAAG,CAAC;IAarF;;;;OAIG;IACI,aAAa,CAAC,aAAa,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,IAAI;IAcjE;;;;SAIK;IACE,sBAAsB,CAAC,GAAG,EAAE,MAAM,EAAE,SAAS,UAAO,GAAG,eAAe;IAM7E,+BAA+B;IACxB,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,QAAQ;CAIzC;AAED;;;;;;;;;;GAUG;AACH,8BAAsB,iBAAkB,SAAQ,QAAQ;IACtD,SAAS,CAAC,MAAM,CAAC,aAAa;;;MAAwD;IAEtF;;;;;;;;MAQE;IACF,SAAgB,SAAS,EAAE,MAAM,CAAC;IAElC;;;;;OAKG;IACI,mBAAmB,CAAC,QAAQ,EAAE,QAAQ,CAAC,qBAAqB;IAKnE,gFAAgF;IACzE,mBAAmB;IAa1B;;OAEG;IACH,SAAS,CAAC,QAAQ,CAAC,SAAS,CAAC,IAAI,EAAE,GAAG,GAAG,IAAI;IAE7C;;;OAGG;WACW,WAAW,CAAC,QAAQ,EAAE,aAAa,EAAE,SAAS,CAAC,EAAE,GAAG;IAalE;;;OAGG;IACH,SAAS,CAAC,cAAc;IAaxB;;;;OAIG;IACa,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,GAAG,QAAQ,CAAC,UAAU,EAAE,SAAS,CAAC,EAAE,WAAW,CAAC,cAAc;IAK1G,aAAa,CAAC,GAAG,EAAE;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,aAAa,CAAC,EAAE;YAAE,SAAS,EAAE,WAAW,CAAC,cAAc,CAAC;YAAC,IAAI,EAAE,MAAM,CAAA;SAAE,CAAC;QAAC,SAAS,EAAE,MAAM,IAAI,CAAA;KAAE,yBAAN,IAAI;CAMjJ;AAED,cAAc;AACd,yBAAiB,QAAQ,CAAC;IACxB;;OAEG;IACH,KAAY,YAAY,GAAG,MAAM,CAAC;IAElC;;;OAGG;IACH,UAAiB,qBAAqB;QACpC,uFAAuF;QACvF,QAAQ,CAAC,WAAW,EAAE,YAAY,CAAC;QACnC,qFAAqF;QACrF,QAAQ,CAAC,YAAY,EAAE,YAAY,CAAC;KACrC;IAED;;OAEG;IACH,UAAiB,MAAM;QACrB;;YAEI;QACJ,KAAK,IAAI,IAAI,CAAC;QACd,gDAAgD;QAChD,WAAW,IAAI,MAAM,CAAC;QACtB,mGAAmG;QACnG,OAAO,IAAI,OAAO,CAAC;QACnB,0DAA0D;QAC1D,IAAI;QACF,gCAAgC;QAChC,EAAE,EAAE,cAAc,CAAC,KAAK,EACxB,IAAI,EAAE;YACJ,wCAAwC;YACxC,SAAS,EAAE,MAAM,CAAC;YAClB,0CAA0C;YAC1C,UAAU,EAAE,MAAM,CAAC;YACnB,4BAA4B;YAC5B,GAAG,EAAE,MAAM,CAAC;YACZ,iDAAiD;YACjD,SAAS,CAAC,EAAE,OAAO,CAAC;SACrB,GAAG,IAAI,CAAC;QACX;;aAEK;QACL,IAAI,CAAC,IAAI,EAAE;YACT,kCAAkC;YAClC,QAAQ,EAAE,MAAM,CAAC;YACjB,8CAA8C;YAC9C,MAAM,EAAE,MAAM,CAAC;YACf,6EAA6E;YAC7E,IAAI,CAAC,EAAE,WAAW,CAAC;SACpB,GAAG,UAAU,CAAC;QACf;;aAEK;QACL,SAAS,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;QAC7B,sBAAsB;QACtB,KAAK,CAAC,IAAI,EAAE;YACV,oCAAoC;YACpC,QAAQ,EAAE,MAAM,CAAC;YACjB,+CAA+C;YAC/C,MAAM,EAAE,MAAM,CAAC;YACf,yBAAyB;YACzB,IAAI,EAAE,WAAW,CAAC;SACnB,GAAG,IAAI,CAAC;KACV;IAED;;OAEG;IACH,KAAY,cAAc;QACxB,4GAA4G;QAC5G,IAAI,IAAI;QACR,4FAA4F;QAC5F,QAAQ,IAAI;QACZ,yEAAyE;QACzE,SAAS,IAAI;QACb,yEAAyE;QACzE,SAAS,IAAI;KACd;IAED,8DAA8D;IAC9D,UAAiB,kBAAkB;QACjC,6DAA6D;QAC7D,SAAS,CAAC,EAAE,OAAO,CAAC;QACpB,sEAAsE;QACtE,SAAS,CAAC,EAAE,OAAO,CAAC;QACpB,oFAAoF;QACpF,aAAa,CAAC,EAAE,OAAO,CAAC;QACxB;;QAEA;QACA,UAAU,CAAC,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAC3B,2FAA2F;QAC3F,UAAU,CAAC,EAAE,MAAM,CAAC;KACrB;IAED,kDAAkD;IAClD,UAAiB,UAAW,SAAQ,kBAAkB;QACpD,gEAAgE;QAChE,QAAQ,EAAE,QAAQ,CAAC;KACpB;IAED,uCAAuC;IACvC,UAAiB,QAAQ;QACvB,8DAA8D;QAC9D,QAAQ,CAAC,EAAE,MAAM,CAAC;KACnB;IAED,6CAA6C;IAC7C,KAAY,YAAY,GAAG,kBAAkB,GAAG,QAAQ,CAAC;IAEzD,0CAA0C;IAC1C,UAAiB,cAAc;QAC7B,uCAAuC;QACvC,MAAM,EAAE,MAAM,CAAC;QACf,wEAAwE;QACxE,QAAQ,CAAC,EAAE,QAAQ,GAAG,QAAQ,CAAC,UAAU,CAAC;QAC1C,gBAAgB;QAChB,SAAS,CAAC,EAAE,WAAW,CAAC,cAAc,CAAC;KACxC;IAED,sCAAsC;IACtC,UAAiB,YAAa,SAAQ,QAAQ;QAC5C,6FAA6F;QAC7F,IAAI,CAAC,EAAE,aAAa,CAAC;KACtB;CACF"}
1	+ {"version":3,"file":"SQLiteDb.d.ts","sourceRoot":"","sources":["../../src/SQLiteDb.ts"],"names":[],"mappings":"AAIA;;GAEG;AAKH,OAAO,EAAE,cAAc,EAAE,MAAM,0BAA0B,CAAC;AAC1D,OAAO,EAAE,oBAAoB,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AAC/E,OAAO,EAAE,aAAa,EAAe,MAAM,oBAAoB,CAAC;AAChE,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAG5C,OAAO,EAAE,eAAe,EAAkB,MAAM,mBAAmB,CAAC;AACpE,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAI/C;;;GAGG;AACH,qBAAa,QAAQ;IACnB,gBAAgB;IAChB,SAAgB,CAAC,SAAS,CAAC,0BAAwC;IACnE,OAAO,CAAC,qBAAqB,CAAyC;IAEtE,gBAAgB;WACF,YAAY,IAAI,QAAQ,CAAC,MAAM;IAI7C;;OAEG;IACI,OAAO,IAAI,IAAI;IAItB;;OAEG;IACI,QAAQ,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI;IACrC,YAAY;IACL,QAAQ,CAAC,MAAM,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,WAAW,CAAC,cAAc,EAAE,MAAM,CAAC,EAAE,QAAQ,CAAC,YAAY,GAAG,IAAI;IAK7G;;OAEG;IACI,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,GAAG,QAAQ,CAAC,UAAU,GAAG,IAAI;IAC7E;;;OAGG;IACI,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,GAAG,QAAQ,CAAC,UAAU,EAAE,SAAS,CAAC,EAAE,WAAW,CAAC,cAAc,GAAG,IAAI;IAKrH;;OAEG;IACI,OAAO,CAAC,WAAW,CAAC,EAAE,OAAO,GAAG,IAAI;IAO3C,4CAA4C;IAC5C,IAAW,MAAM,IAAI,OAAO,CAAqC;IAEjE,qDAAqD;IACrD,IAAW,UAAU,IAAI,OAAO,CAAyC;IAEzE,2CAA2C;IAC3C,SAAS,CAAC,WAAW,CAAC,IAAI,EAAE;QAC1B,uCAAuC;QACvC,SAAS,EAAE,MAAM,CAAC;QAClB,uCAAuC;QACvC,OAAO,EAAE,MAAM,CAAC;QAChB,4CAA4C;QAC5C,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,yFAAyF;QACzF,YAAY,CAAC,EAAE,OAAO,CAAC;KACxB;IAQD;;;MAGE;IACK,eAAe,CAAC,SAAS,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI;IAO9D;;;;;;;;;;;OAWG;IACI,UAAU,CAAC,CAAC,EAAE,IAAI,EAAE,QAAQ,CAAC,cAAc,EAAE,SAAS,EAAE,MAAM,CAAC,GAAG,CAAC;IAgB1E;;OAEG;IACH,IAAW,cAAc,IAAI,WAAW,CAAC,cAAc,GAAG,SAAS,CAElE;IAED,+JAA+J;IACxJ,kBAAkB,IAAI,MAAM;IAInC;;;;;;;;;;;;OAYG;IACU,mBAAmB,CAAC,CAAC,EAAE,IAAI,EAAE,WAAW,CAAC,eAAe,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC,CAAC,CAAC;IAIlG;;OAEG;IACI,MAAM,CAAC,IAAI,CAAC,EAAE,QAAQ,CAAC,YAAY;IAI1C,4GAA4G;IACrG,WAAW,IAAI,IAAI;IAI1B,iIAAiI;IAC1H,cAAc,IAAI,IAAI;IAI7B;;;;;;;;;;;;;;;;;;OAkBG;IACI,cAAc,CAAC,aAAa,EAAE,aAAa,EAAE,KAAK,CAAC,EAAE,QAAQ,CAAC,mBAAmB,EAAE,eAAe,CAAC,EAAE,QAAQ,CAAC,uBAAuB,GAAG,QAAQ,CAAC,wBAAwB,GAAG,IAAI;IAIvL;;;;;;OAMG;IACI,mBAAmB,IAAI,IAAI;IAIlC;;;;;;;;OAQG;IACI,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI;IAIpC;;;;;;;OAOG;IACI,eAAe,CAAC,aAAa,EAAE,aAAa,GAAG,IAAI;IAI1D;;;;;;;;;OASG;IACI,2BAA2B,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,IAAI,EAAE,eAAe,KAAK,CAAC,GAAG,CAAC;IAa7F;;;;;;;OAOG;IACI,mBAAmB,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,IAAI,EAAE,eAAe,KAAK,CAAC,GAAG,CAAC;IAarF;;;;OAIG;IACI,aAAa,CAAC,aAAa,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,IAAI;IAcjE;;;;SAIK;IACE,sBAAsB,CAAC,GAAG,EAAE,MAAM,EAAE,SAAS,UAAO,GAAG,eAAe;IAM7E,+BAA+B;IACxB,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,QAAQ;CAIzC;AAED;;;;;;;;;;GAUG;AACH,8BAAsB,iBAAkB,SAAQ,QAAQ;IACtD,SAAS,CAAC,MAAM,CAAC,aAAa;;;MAAwD;IAEtF;;;;;;;;MAQE;IACF,SAAgB,SAAS,EAAE,MAAM,CAAC;IAElC;;;;;OAKG;IACI,mBAAmB,CAAC,QAAQ,EAAE,QAAQ,CAAC,qBAAqB;IAKnE,gFAAgF;IACzE,mBAAmB;IAa1B;;OAEG;IACH,SAAS,CAAC,QAAQ,CAAC,SAAS,CAAC,IAAI,EAAE,GAAG,GAAG,IAAI;IAE7C;;;OAGG;WACW,WAAW,CAAC,QAAQ,EAAE,aAAa,EAAE,SAAS,CAAC,EAAE,GAAG;IAalE;;;OAGG;IACH,SAAS,CAAC,cAAc;IAaxB;;;;OAIG;IACa,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,GAAG,QAAQ,CAAC,UAAU,EAAE,SAAS,CAAC,EAAE,WAAW,CAAC,cAAc;IAK1G,aAAa,CAAC,GAAG,EAAE;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,aAAa,CAAC,EAAE;YAAE,SAAS,EAAE,WAAW,CAAC,cAAc,CAAC;YAAC,IAAI,EAAE,MAAM,CAAA;SAAE,CAAC;QAAC,SAAS,EAAE,MAAM,IAAI,CAAA;KAAE,yBAAN,IAAI;CAMjJ;AAED,cAAc;AACd,yBAAiB,QAAQ,CAAC;IACxB;;OAEG;IACH,KAAY,mBAAmB;QAC7B,oCAAoC;QACpC,IAAI,IAAI;QACR,0CAA0C;QAC1C,MAAM,IAAI;QACV,kGAAkG;QAClG,UAAU,IAAI;QACd,0GAA0G;QAC1G,UAAU,IAAI;QACd,qFAAqF;QACrF,YAAY,IAAI;KACjB;IAED;;OAEG;IACH,KAAY,uBAAuB;QACjC,kDAAkD;QAClD,kBAAkB,IAAI;QACtB;;;;;WAKG;QACH,cAAc,IAAI;KACnB;IAED;;;;OAIG;IACH,KAAY,qBAAqB,GAAG,cAAc,CAAC,2BAA2B,CAAC;IAE/E;;;;;;OAMG;IACH,KAAY,wBAAwB,GAAG,CAAC,IAAI,EAAE,qBAAqB,KAAK,oBAAoB,CAAC;IAE7F;;OAEG;IACH,KAAY,YAAY,GAAG,MAAM,CAAC;IAElC;;;OAGG;IACH,UAAiB,qBAAqB;QACpC,uFAAuF;QACvF,QAAQ,CAAC,WAAW,EAAE,YAAY,CAAC;QACnC,qFAAqF;QACrF,QAAQ,CAAC,YAAY,EAAE,YAAY,CAAC;KACrC;IAED;;OAEG;IACH,UAAiB,MAAM;QACrB;;YAEI;QACJ,KAAK,IAAI,IAAI,CAAC;QACd,gDAAgD;QAChD,WAAW,IAAI,MAAM,CAAC;QACtB,mGAAmG;QACnG,OAAO,IAAI,OAAO,CAAC;QACnB,0DAA0D;QAC1D,IAAI;QACF,gCAAgC;QAChC,EAAE,EAAE,cAAc,CAAC,KAAK,EACxB,IAAI,EAAE;YACJ,wCAAwC;YACxC,SAAS,EAAE,MAAM,CAAC;YAClB,0CAA0C;YAC1C,UAAU,EAAE,MAAM,CAAC;YACnB,4BAA4B;YAC5B,GAAG,EAAE,MAAM,CAAC;YACZ,iDAAiD;YACjD,SAAS,CAAC,EAAE,OAAO,CAAC;SACrB,GAAG,IAAI,CAAC;QACX;;aAEK;QACL,IAAI,CAAC,IAAI,EAAE;YACT,kCAAkC;YAClC,QAAQ,EAAE,MAAM,CAAC;YACjB,8CAA8C;YAC9C,MAAM,EAAE,MAAM,CAAC;YACf,6EAA6E;YAC7E,IAAI,CAAC,EAAE,WAAW,CAAC;SACpB,GAAG,UAAU,CAAC;QACf;;aAEK;QACL,SAAS,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;QAC7B,sBAAsB;QACtB,KAAK,CAAC,IAAI,EAAE;YACV,oCAAoC;YACpC,QAAQ,EAAE,MAAM,CAAC;YACjB,+CAA+C;YAC/C,MAAM,EAAE,MAAM,CAAC;YACf,yBAAyB;YACzB,IAAI,EAAE,WAAW,CAAC;SACnB,GAAG,IAAI,CAAC;KACV;IAED;;OAEG;IACH,KAAY,cAAc;QACxB,4GAA4G;QAC5G,IAAI,IAAI;QACR,4FAA4F;QAC5F,QAAQ,IAAI;QACZ,yEAAyE;QACzE,SAAS,IAAI;QACb,yEAAyE;QACzE,SAAS,IAAI;KACd;IAED,8DAA8D;IAC9D,UAAiB,kBAAkB;QACjC,6DAA6D;QAC7D,SAAS,CAAC,EAAE,OAAO,CAAC;QACpB,sEAAsE;QACtE,SAAS,CAAC,EAAE,OAAO,CAAC;QACpB,oFAAoF;QACpF,aAAa,CAAC,EAAE,OAAO,CAAC;QACxB;;QAEA;QACA,UAAU,CAAC,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAC3B,2FAA2F;QAC3F,UAAU,CAAC,EAAE,MAAM,CAAC;KACrB;IAED,kDAAkD;IAClD,UAAiB,UAAW,SAAQ,kBAAkB;QACpD,gEAAgE;QAChE,QAAQ,EAAE,QAAQ,CAAC;KACpB;IAED,uCAAuC;IACvC,UAAiB,QAAQ;QACvB,8DAA8D;QAC9D,QAAQ,CAAC,EAAE,MAAM,CAAC;KACnB;IAED,6CAA6C;IAC7C,KAAY,YAAY,GAAG,kBAAkB,GAAG,QAAQ,CAAC;IAEzD,0CAA0C;IAC1C,UAAiB,cAAc;QAC7B,uCAAuC;QACvC,MAAM,EAAE,MAAM,CAAC;QACf,wEAAwE;QACxE,QAAQ,CAAC,EAAE,QAAQ,GAAG,QAAQ,CAAC,UAAU,CAAC;QAC1C,gBAAgB;QAChB,SAAS,CAAC,EAAE,WAAW,CAAC,cAAc,CAAC;KACxC;IAED,sCAAsC;IACtC,UAAiB,YAAa,SAAQ,QAAQ;QAC5C,6FAA6F;QAC7F,IAAI,CAAC,EAAE,aAAa,CAAC;KACtB;CACF"}

package/lib/esm/SQLiteDb.js CHANGED Viewed

@@ -195,18 +195,22 @@ export class SQLiteDb {
      * extension - to this SQLiteDb. This is *not* the same on-disk format used for iModel changesets.
      * Unlike `BriefcaseDb.pullChanges`, this does *not* perform any iModel-style changeset relationship validation (e.g. parentId/changesetId)
      * against the current state of the database (raw sqlite changesets have no header) - it simply applies the changes it contains. It also does *not*
-     * support DDL/schema changes - raw sqlite changesets cannot represent them. If applying the changeset
-     * encounters any conflict, or otherwise fails, this method throws (conflicts are never resolved
-     * automatically).
+     * support DDL/schema changes - raw sqlite changesets cannot represent them. Conflicts abort by default.
+     * A built-in policy or custom handler can resolve conflicts; unresolved conflicts and other failures throw.
      * @note this method only throws on failure - it does *not* commit or abandon any changes itself. If it
      * throws, some (but not necessarily all) of the changeset's changes may have already been applied to the
      * current transaction. It is the caller's responsibility to call [[saveChanges]] or [[abandonChanges]]
      * as appropriate after catching an error from this method.
      * @param changesetFile the local file name of the changeset to apply.
+     * @param flags Independent apply options. Defaults to [[SQLiteDb.ApplyChangesetFlags.None]].
+     * @param conflictHandler Defaults to [[SQLiteDb.ChangesetConflictPolicy.AbortOnAnyConflict]].
+     * Use [[SQLiteDb.ChangesetConflictPolicy.NoLocalChanges]] for the generic iModel policy without
+     * table-specific rules, or supply a synchronous custom handler. This does not enable any apply flags:
+     * to suppress cascades, also pass [[SQLiteDb.ApplyChangesetFlags.FkNoAction]].
      * @internal
      */
-    applyChangeset(changesetFile) {
-        this[_nativeDb].applyChangeset(changesetFile);
+    applyChangeset(changesetFile, flags, conflictHandler) {
+        this[_nativeDb].applyChangeset(changesetFile, flags, conflictHandler);
     }
     /**
      * Begin capturing data changes made to this SQLiteDb, so they may later be saved via [[createChangeset]].
@@ -412,6 +416,37 @@ export class VersionedSqliteDb extends SQLiteDb {
 }
 /** @public */
 (function (SQLiteDb) {
+    /** Independent flags for applying a raw SQLite changeset. Combine with bitwise OR.
+     * @internal
+     */
+    let ApplyChangesetFlags;
+    (function (ApplyChangesetFlags) {
+        /** Apply with no optional flags. */
+        ApplyChangesetFlags[ApplyChangesetFlags["None"] = 0] = "None";
+        /** Apply the inverse of the changeset. */
+        ApplyChangesetFlags[ApplyChangesetFlags["Invert"] = 1] = "Invert";
+        /** Skip changes that would leave the database unchanged without invoking the conflict handler. */
+        ApplyChangesetFlags[ApplyChangesetFlags["IgnoreNoop"] = 2] = "IgnoreNoop";
+        /** Treat all foreign-key actions as NO ACTION, including CASCADE, RESTRICT, SET NULL, and SET DEFAULT. */
+        ApplyChangesetFlags[ApplyChangesetFlags["FkNoAction"] = 4] = "FkNoAction";
+        /** Report cyclic UNIQUE updates as constraint conflicts instead of retrying them. */
+        ApplyChangesetFlags[ApplyChangesetFlags["NoUpdateLoop"] = 8] = "NoUpdateLoop";
+    })(ApplyChangesetFlags = SQLiteDb.ApplyChangesetFlags || (SQLiteDb.ApplyChangesetFlags = {}));
+    /** Built-in conflict policies, independent of apply flags.
+     * @internal
+     */
+    let ChangesetConflictPolicy;
+    (function (ChangesetConflictPolicy) {
+        /** Abort on any conflict. This is the default. */
+        ChangesetConflictPolicy[ChangesetConflictPolicy["AbortOnAnyConflict"] = 0] = "AbortOnAnyConflict";
+        /** Generic iModel policy with no local changes: skip missing rows and constraint conflicts,
+         * replace data and primary-key insert conflicts, and abort on foreign-key violations.
+         * Indirect data conflicts are replaced without warnings except for sqlite_stat1 conflicts.
+         * Primary-key insert conflicts are replaced with a warning even for indirect changes.
+         * Does not include iModel-specific table rules or disable foreign-key actions.
+         */
+        ChangesetConflictPolicy[ChangesetConflictPolicy["NoLocalChanges"] = 1] = "NoLocalChanges";
+    })(ChangesetConflictPolicy = SQLiteDb.ChangesetConflictPolicy || (SQLiteDb.ChangesetConflictPolicy = {}));
     /** Default transaction mode for SQLiteDbs.
      * @see https://www.sqlite.org/lang_transaction.html
      */