@itwin/core-backend 5.0.0-dev.90 → 5.0.0-dev.93

package/lib/esm/SqliteChangesetReader.js

@@ -0,0 +1,337 @@
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module SQLiteDb
+ */
+import { DbChangeStage, DbOpcode, DbResult } from "@itwin/core-bentley";
+import { ECDb } from "./ECDb";
+import { IModelNative } from "./internal/NativePlatform";
+import { _nativeDb } from "./internal/Symbols";
+/**
+ * Read raw sqlite changeset from disk and enumerate changes.
+ * It also optionally let you format change with schema from
+ * a db provided.
+ * @beta
+ */
+export class SqliteChangesetReader {
+    db;
+    _nativeReader = new IModelNative.platform.ChangesetReader();
+    _schemaCache = new Map();
+    _disableSchemaCheck = false;
+    _changeIndex = 0;
+    constructor(
+    /** db from where sql schema will be read */
+    db) {
+        this.db = db;
+    }
+    /**
+     * Open changeset file from disk
+     * @param args fileName of changeset reader and other options.
+     * @returns SqliteChangesetReader instance
+     */
+    static openFile(args) {
+        const reader = new SqliteChangesetReader(args.db);
+        reader._disableSchemaCheck = args.disableSchemaCheck ?? false;
+        reader._nativeReader.openFile(args.fileName, args.invert ?? false);
+        return reader;
+    }
+    /**
+     * Group changeset file into single changeset and open that changeset.
+     * @param args - The arguments for opening the changeset group. Requires an open db.
+     * @returns The SqliteChangesetReader instance.
+     */
+    static openGroup(args) {
+        if (args.changesetFiles.length === 0) {
+            throw new Error("changesetFiles must contain at least one file.");
+        }
+        const reader = new SqliteChangesetReader(args.db);
+        reader._disableSchemaCheck = args.disableSchemaCheck ?? false;
+        reader._nativeReader.openGroup(args.changesetFiles, args.db[_nativeDb], args.invert ?? false);
+        return reader;
+    }
+    /**
+     * Open txn change in iModel.
+     * @param args iModel and other options.
+     * @returns SqliteChangesetReader instance
+     */
+    static openTxn(args) {
+        if (args.db instanceof ECDb) {
+            throw new Error("ECDb does not support openTxn");
+        }
+        const reader = new SqliteChangesetReader(args.db);
+        reader._disableSchemaCheck = args.disableSchemaCheck ?? false;
+        reader._nativeReader.openTxn(args.db[_nativeDb], args.txnId, args.invert ?? false);
+        return reader;
+    }
+    /**
+     * Writes the changeset to a file.
+     * @note can be use with openGroup() or openLocalChanges() to persist changeset.
+     * @param args - The arguments for writing to the file.
+     * @param args.fileName - The name of the file to write to.
+     * @param args.containsSchemaChanges - Indicates whether the changeset contains schema changes.
+     * @param args.overwriteFile - Indicates whether to override the file if it already exists. Default is false.
+     */
+    writeToFile(args) {
+        this._nativeReader.writeToFile(args.fileName, args.containsSchemaChanges, args.overwriteFile ?? false);
+    }
+    /**
+     * Open local changes in iModel.
+     * @param args iModel and other options.
+     * @param args.db must be of type IModelDb
+     * @returns SqliteChangesetReader instance
+     */
+    static openLocalChanges(args) {
+        const reader = new SqliteChangesetReader(args.db);
+        reader._disableSchemaCheck = args.disableSchemaCheck ?? false;
+        reader._nativeReader.openLocalChanges(args.db[_nativeDb], args.includeInMemoryChanges ?? false, args.invert ?? false);
+        return reader;
+    }
+    /** check if schema check is disabled or not */
+    get disableSchemaCheck() { return this._disableSchemaCheck; }
+    /** Move to next change in changeset
+     * @returns true if there is current change false if reader is end of changeset.
+     * @beta
+    */
+    step() {
+        if (this._nativeReader.step()) {
+            this._changeIndex++;
+            return true;
+        }
+        return false;
+    }
+    /** Check if reader current on a row
+     * @beta
+    */
+    get hasRow() {
+        return this._nativeReader.hasRow();
+    }
+    /** Check if its current change is indirect
+     * @beta
+    */
+    get isIndirect() {
+        return this._nativeReader.isIndirectChange();
+    }
+    /** Get count of columns in current change
+     * @beta
+    */
+    get columnCount() {
+        return this._nativeReader.getColumnCount();
+    }
+    /** Get operation that caused the change
+     * @beta
+    */
+    get op() {
+        if (this._nativeReader.getOpCode() === DbOpcode.Insert)
+            return "Inserted";
+        if (this._nativeReader.getOpCode() === DbOpcode.Delete)
+            return "Deleted";
+        return "Updated";
+    }
+    /** Get primary key value array
+     * @beta
+    */
+    get primaryKeyValues() {
+        return this._nativeReader.getPrimaryKeys();
+    }
+    /** Get primary key columns.
+     * @note To this to work db arg must be set when opening changeset file.
+     * @beta
+     */
+    getPrimaryKeyColumnNames() {
+        const cols = this.getColumnNames(this.tableName);
+        if (!this._disableSchemaCheck && cols.length !== this.columnCount)
+            throw new Error(`changeset table ${this.tableName} columns count does not match db declared table. ${this.columnCount} <> ${cols.length}`);
+        return this._nativeReader.getPrimaryKeyColumnIndexes().map((i) => cols[i]);
+    }
+    /** Get current change table.
+     * @beta
+    */
+    get tableName() {
+        return this._nativeReader.getTableName();
+    }
+    /**
+     * Get changed binary value for a column
+     * @param columnIndex index of column in current change
+     * @param stage old or new value for change.
+     * @returns value for changed column
+     * @beta
+     */
+    getChangeValueType(columnIndex, stage) {
+        return this._nativeReader.getColumnValueType(columnIndex, stage === "New" ? DbChangeStage.New : DbChangeStage.Old);
+    }
+    /**
+     * Get changed binary value for a column
+     * @param columnIndex index of column in current change
+     * @param stage old or new value for change.
+     * @returns value for changed column
+     * @beta
+     */
+    getChangeValueBinary(columnIndex, stage) {
+        return this._nativeReader.getColumnValueBinary(columnIndex, stage === "New" ? DbChangeStage.New : DbChangeStage.Old);
+    }
+    /**
+     * Get changed double value for a column
+     * @param columnIndex index of column in current change
+     * @param stage old or new value for change.
+     * @returns value for changed column
+     * @beta
+     */
+    getChangeValueDouble(columnIndex, stage) {
+        return this._nativeReader.getColumnValueDouble(columnIndex, stage === "New" ? DbChangeStage.New : DbChangeStage.Old);
+    }
+    /**
+     * Get changed Id value for a column
+     * @param columnIndex index of column in current change
+     * @param stage old or new value for change.
+     * @returns value for changed column
+     * @beta
+     */
+    getChangeValueId(columnIndex, stage) {
+        return this._nativeReader.getColumnValueId(columnIndex, stage === "New" ? DbChangeStage.New : DbChangeStage.Old);
+    }
+    /**
+     * Get changed integer value for a column
+     * @param columnIndex index of column in current change
+     * @param stage old or new value for change.
+     * @returns value for changed column
+     * @beta
+     */
+    getChangeValueInteger(columnIndex, stage) {
+        return this._nativeReader.getColumnValueInteger(columnIndex, stage === "New" ? DbChangeStage.New : DbChangeStage.Old);
+    }
+    /**
+     * Get changed text value for a column
+     * @param columnIndex index of column in current change
+     * @param stage old or new value for change.
+     * @returns value for changed column
+     * @beta
+     */
+    getChangeValueText(columnIndex, stage) {
+        return this._nativeReader.getColumnValueText(columnIndex, stage === "New" ? DbChangeStage.New : DbChangeStage.Old);
+    }
+    /**
+     * Check if change value is null
+     * @param columnIndex index of column in current change
+     * @param stage old or new value for change.
+     * @returns true if value is null
+     * @beta
+     */
+    isColumnValueNull(columnIndex, stage) {
+        return this._nativeReader.isColumnValueNull(columnIndex, stage === "New" ? DbChangeStage.New : DbChangeStage.Old);
+    }
+    /**
+     * Get change value type
+     * @param columnIndex index of column in current change
+     * @param stage old or new value for change.
+     * @returns change value type
+     * @beta
+     */
+    getColumnValueType(columnIndex, stage) {
+        return this._nativeReader.getColumnValueType(columnIndex, stage === "New" ? DbChangeStage.New : DbChangeStage.Old);
+    }
+    /**
+     * Get changed value for a column
+     * @param columnIndex index of column in current change
+     * @param stage old or new value for change.
+     * @returns value for changed column
+     * @beta
+     */
+    getChangeValue(columnIndex, stage) {
+        return this._nativeReader.getColumnValue(columnIndex, stage === "New" ? DbChangeStage.New : DbChangeStage.Old);
+    }
+    /**
+     * Get all changed value in current change as array
+     * @param stage old or new values for current change.
+     * @returns array of values.
+     * @beta
+     */
+    getChangeValuesArray(stage) {
+        return this._nativeReader.getRow(stage === "New" ? DbChangeStage.New : DbChangeStage.Old);
+    }
+    /**
+     * Get change as object and format its content.
+     * @param stage old or new value for current change.
+     * @param args change format options
+     * @returns return object or undefined
+     * @beta
+     */
+    getChangeValuesObject(stage, args = {}) {
+        const cols = this.getColumnNames(this.tableName);
+        const row = this.getChangeValuesArray(stage);
+        if (!row)
+            return undefined;
+        process.env;
+        const minLen = Math.min(cols.length, row.length);
+        if (!this._disableSchemaCheck && cols.length !== this.columnCount)
+            throw new Error(`changeset table ${this.tableName} columns count does not match db declared table. ${this.columnCount} <> ${cols.length}`);
+        const out = {};
+        if (args.includeTableName) {
+            out.$table = this.tableName;
+        }
+        if (args.includeOpCode) {
+            out.$op = this.op;
+        }
+        if (args.includeStage) {
+            out.$stage = stage;
+        }
+        if (args.includePrimaryKeyInUpdateNew && this.op === "Updated" && stage === "New") {
+            const pkNames = this.getPrimaryKeyColumnNames();
+            const pkValues = this.primaryKeyValues;
+            pkNames.forEach((v, i) => {
+                out[v] = pkValues[i];
+            });
+        }
+        const isNullOrUndefined = (val) => typeof val === "undefined";
+        for (let i = 0; i < minLen; ++i) {
+            const columnValue = row[i];
+            const columnName = cols[i];
+            if (!args.includeNullColumns && isNullOrUndefined(columnValue))
+                continue;
+            out[columnName] = columnValue;
+        }
+        return out;
+    }
+    /**
+     * Get list of column for a table. This function also caches the result.
+     * @note To this to work db arg must be set when opening changeset file.
+     * @param tableName name of the table for which columns are requested.
+     * @returns columns of table.
+     * @beta
+     */
+    getColumnNames(tableName) {
+        const columns = this._schemaCache.get(tableName);
+        if (columns)
+            return columns;
+        return this.db.withPreparedSqliteStatement("SELECT [name] FROM PRAGMA_TABLE_INFO(?) ORDER BY [cid]", (stmt) => {
+            stmt.bindString(1, tableName);
+            const tblCols = [];
+            while (stmt.step() === DbResult.BE_SQLITE_ROW) {
+                tblCols.push(stmt.getValueString(0));
+            }
+            this._schemaCache.set(tableName, tblCols);
+            return tblCols;
+        });
+    }
+    /** index of current change
+     * @beta
+     */
+    get changeIndex() { return this._changeIndex; }
+    /**
+     * Close changeset
+     * @beta
+     */
+    close() {
+        this._changeIndex = 0;
+        this._nativeReader.close();
+    }
+    /**
+     * Dispose this object
+     * @beta
+     */
+    [Symbol.dispose]() {
+        this.close();
+    }
+}
+//# sourceMappingURL=SqliteChangesetReader.js.map

package/lib/esm/SqliteChangesetReader.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SqliteChangesetReader.js","sourceRoot":"","sources":["../../src/SqliteChangesetReader.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AACH,OAAO,EAAE,aAAa,EAAE,QAAQ,EAAE,QAAQ,EAA2B,MAAM,qBAAqB,CAAC;AACjG,OAAO,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAE9B,OAAO,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAC;AACzD,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAoE/C;;;;;GAKG;AACH,MAAM,OAAO,qBAAqB;IAOd;IAND,aAAa,GAAG,IAAI,YAAY,CAAC,QAAQ,CAAC,eAAe,EAAE,CAAC;IACrE,YAAY,GAAG,IAAI,GAAG,EAAoB,CAAC;IAC3C,mBAAmB,GAAG,KAAK,CAAC;IAC5B,YAAY,GAAG,CAAC,CAAC;IACzB;IACE,4CAA4C;IAC5B,EAAS;QAAT,OAAE,GAAF,EAAE,CAAO;IACvB,CAAC;IAEL;;;;OAIG;IACI,MAAM,CAAC,QAAQ,CAAC,IAA+D;QACpF,MAAM,MAAM,GAAG,IAAI,qBAAqB,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QAClD,MAAM,CAAC,mBAAmB,GAAG,IAAI,CAAC,kBAAkB,IAAI,KAAK,CAAC;QAC9D,MAAM,CAAC,aAAa,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,MAAM,IAAI,KAAK,CAAC,CAAC;QACnE,OAAO,MAAM,CAAC;IAChB,CAAC;IACD;;;;OAIG;IACI,MAAM,CAAC,SAAS,CAAC,IAAuE;QAC7F,IAAI,IAAI,CAAC,cAAc,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACrC,MAAM,IAAI,KAAK,CAAC,gDAAgD,CAAC,CAAC;QACpE,CAAC;QACD,MAAM,MAAM,GAAG,IAAI,qBAAqB,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QAClD,MAAM,CAAC,mBAAmB,GAAG,IAAI,CAAC,kBAAkB,IAAI,KAAK,CAAC;QAC9D,MAAM,CAAC,aAAa,CAAC,SAAS,CAAC,IAAI,CAAC,cAAc,EAAE,IAAI,CAAC,EAAE,CAAC,SAAS,CAAC,EAAE,IAAI,CAAC,MAAM,IAAI,KAAK,CAAC,CAAC;QAC9F,OAAO,MAAM,CAAC;IAChB,CAAC;IACD;;;;OAIG;IACI,MAAM,CAAC,OAAO,CAAC,IAAuD;QAC3E,IAAI,IAAI,CAAC,EAAE,YAAY,IAAI,EAAE,CAAC;YAC5B,MAAM,IAAI,KAAK,CAAC,+BAA+B,CAAC,CAAC;QACnD,CAAC;QACD,MAAM,MAAM,GAAG,IAAI,qBAAqB,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QAClD,MAAM,CAAC,mBAAmB,GAAG,IAAI,CAAC,kBAAkB,IAAI,KAAK,CAAC;QAC9D,MAAM,CAAC,aAAa,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC,SAAS,CAAC,EAAE,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,MAAM,IAAI,KAAK,CAAC,CAAC;QACnF,OAAO,MAAM,CAAC;IAChB,CAAC;IACD;;;;;;;OAOG;IACI,WAAW,CAAC,IAAmF;QACpG,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,qBAAqB,EAAE,IAAI,CAAC,aAAa,IAAI,KAAK,CAAC,CAAC;IACzG,CAAC;IACD;;;;;OAKG;IACI,MAAM,CAAC,gBAAgB,CAAC,IAA6F;QAC1H,MAAM,MAAM,GAAG,IAAI,qBAAqB,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QAClD,MAAM,CAAC,mBAAmB,GAAG,IAAI,CAAC,kBAAkB,IAAI,KAAK,CAAC;QAC9D,MAAM,CAAC,aAAa,CAAC,gBAAgB,CAAC,IAAI,CAAC,EAAE,CAAC,SAAS,CAAC,EAAE,IAAI,CAAC,sBAAsB,IAAI,KAAK,EAAE,IAAI,CAAC,MAAM,IAAI,KAAK,CAAC,CAAC;QACtH,OAAO,MAAM,CAAC;IAChB,CAAC;IACD,+CAA+C;IAC/C,IAAW,kBAAkB,KAAc,OAAO,IAAI,CAAC,mBAAmB,CAAC,CAAC,CAAC;IAC7E;;;MAGE;IACK,IAAI;QACT,IAAI,IAAI,CAAC,aAAa,CAAC,IAAI,EAAE,EAAE,CAAC;YAC9B,IAAI,CAAC,YAAY,EAAE,CAAC;YACpB,OAAO,IAAI,CAAC;QACd,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IACD;;MAEE;IACF,IAAW,MAAM;QACf,OAAO,IAAI,CAAC,aAAa,CAAC,MAAM,EAAE,CAAC;IACrC,CAAC;IACD;;MAEE;IACF,IAAW,UAAU;QACnB,OAAO,IAAI,CAAC,aAAa,CAAC,gBAAgB,EAAE,CAAC;IAC/C,CAAC;IACD;;MAEE;IACF,IAAW,WAAW;QACpB,OAAO,IAAI,CAAC,aAAa,CAAC,cAAc,EAAE,CAAC;IAC7C,CAAC;IACD;;MAEE;IACF,IAAW,EAAE;QACX,IAAI,IAAI,CAAC,aAAa,CAAC,SAAS,EAAE,KAAK,QAAQ,CAAC,MAAM;YACpD,OAAO,UAAU,CAAC;QAEpB,IAAI,IAAI,CAAC,aAAa,CAAC,SAAS,EAAE,KAAK,QAAQ,CAAC,MAAM;YACpD,OAAO,SAAS,CAAC;QAEnB,OAAO,SAAS,CAAC;IACnB,CAAC;IACD;;MAEE;IACF,IAAW,gBAAgB;QACzB,OAAO,IAAI,CAAC,aAAa,CAAC,cAAc,EAAE,CAAC;IAC7C,CAAC;IACD;;;OAGG;IACI,wBAAwB;QAC7B,MAAM,IAAI,GAAG,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QACjD,IAAI,CAAC,IAAI,CAAC,mBAAmB,IAAI,IAAI,CAAC,MAAM,KAAK,IAAI,CAAC,WAAW;YAC/D,MAAM,IAAI,KAAK,CAAC,mBAAmB,IAAI,CAAC,SAAS,oDAAoD,IAAI,CAAC,WAAW,OAAO,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC;QAE7I,OAAO,IAAI,CAAC,aAAa,CAAC,0BAA0B,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;IAC7E,CAAC;IACD;;MAEE;IACF,IAAW,SAAS;QAClB,OAAO,IAAI,CAAC,aAAa,CAAC,YAAY,EAAE,CAAC;IAC3C,CAAC;IACD;;;;;;OAMG;IACI,kBAAkB,CAAC,WAAmB,EAAE,KAAuB;QACpE,OAAO,IAAI,CAAC,aAAa,CAAC,kBAAkB,CAAC,WAAW,EAAE,KAAK,KAAK,KAAK,CAAC,CAAC,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC,CAAC,aAAa,CAAC,GAAG,CAAgB,CAAC;IACpI,CAAC;IAED;;;;;;OAMG;IACI,oBAAoB,CAAC,WAAmB,EAAE,KAAuB;QACtE,OAAO,IAAI,CAAC,aAAa,CAAC,oBAAoB,CAAC,WAAW,EAAE,KAAK,KAAK,KAAK,CAAC,CAAC,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC;IACvH,CAAC;IAED;;;;;;OAMG;IACI,oBAAoB,CAAC,WAAmB,EAAE,KAAuB;QACtE,OAAO,IAAI,CAAC,aAAa,CAAC,oBAAoB,CAAC,WAAW,EAAE,KAAK,KAAK,KAAK,CAAC,CAAC,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC;IACvH,CAAC;IAED;;;;;;OAMG;IACI,gBAAgB,CAAC,WAAmB,EAAE,KAAuB;QAClE,OAAO,IAAI,CAAC,aAAa,CAAC,gBAAgB,CAAC,WAAW,EAAE,KAAK,KAAK,KAAK,CAAC,CAAC,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC;IACnH,CAAC;IAED;;;;;;OAMG;IACI,qBAAqB,CAAC,WAAmB,EAAE,KAAuB;QACvE,OAAO,IAAI,CAAC,aAAa,CAAC,qBAAqB,CAAC,WAAW,EAAE,KAAK,KAAK,KAAK,CAAC,CAAC,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC;IACxH,CAAC;IAED;;;;;;OAMG;IACI,kBAAkB,CAAC,WAAmB,EAAE,KAAuB;QACpE,OAAO,IAAI,CAAC,aAAa,CAAC,kBAAkB,CAAC,WAAW,EAAE,KAAK,KAAK,KAAK,CAAC,CAAC,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC;IACrH,CAAC;IAED;;;;;;OAMG;IACI,iBAAiB,CAAC,WAAmB,EAAE,KAAuB;QACnE,OAAO,IAAI,CAAC,aAAa,CAAC,iBAAiB,CAAC,WAAW,EAAE,KAAK,KAAK,KAAK,CAAC,CAAC,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC;IACpH,CAAC;IAED;;;;;;OAMG;IACI,kBAAkB,CAAC,WAAmB,EAAE,KAAuB;QACpE,OAAO,IAAI,CAAC,aAAa,CAAC,kBAAkB,CAAC,WAAW,EAAE,KAAK,KAAK,KAAK,CAAC,CAAC,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC,CAAC,aAAa,CAAC,GAAG,CAA4B,CAAC;IAChJ,CAAC;IAED;;;;;;OAMG;IACI,cAAc,CAAC,WAAmB,EAAE,KAAuB;QAChE,OAAO,IAAI,CAAC,aAAa,CAAC,cAAc,CAAC,WAAW,EAAE,KAAK,KAAK,KAAK,CAAC,CAAC,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC;IACjH,CAAC;IACD;;;;;OAKG;IACI,oBAAoB,CAAC,KAAuB;QACjD,OAAO,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,KAAK,KAAK,KAAK,CAAC,CAAC,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC;IAC5F,CAAC;IACD;;;;;;OAMG;IACI,qBAAqB,CAAC,KAAuB,EAAE,OAAyB,EAAE;QAC/E,MAAM,IAAI,GAAG,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QACjD,MAAM,GAAG,GAAG,IAAI,CAAC,oBAAoB,CAAC,KAAK,CAAC,CAAC;QAC7C,IAAI,CAAC,GAAG;YACN,OAAO,SAAS,CAAC;QACnB,OAAO,CAAC,GAAG,CAAC;QACZ,MAAM,MAAM,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;QAEjD,IAAI,CAAC,IAAI,CAAC,mBAAmB,IAAI,IAAI,CAAC,MAAM,KAAK,IAAI,CAAC,WAAW;YAC/D,MAAM,IAAI,KAAK,CAAC,mBAAmB,IAAI,CAAC,SAAS,oDAAoD,IAAI,CAAC,WAAW,OAAO,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC;QAE7I,MAAM,GAAG,GAAiB,EAAE,CAAC;QAC7B,IAAI,IAAI,CAAC,gBAAgB,EAAE,CAAC;YAC1B,GAAG,CAAC,MAAM,GAAG,IAAI,CAAC,SAAS,CAAC;QAC9B,CAAC;QACD,IAAI,IAAI,CAAC,aAAa,EAAE,CAAC;YACvB,GAAG,CAAC,GAAG,GAAG,IAAI,CAAC,EAAE,CAAC;QACpB,CAAC;QACD,IAAI,IAAI,CAAC,YAAY,EAAE,CAAC;YACtB,GAAG,CAAC,MAAM,GAAG,KAAK,CAAC;QACrB,CAAC;QAED,IAAI,IAAI,CAAC,4BAA4B,IAAI,IAAI,CAAC,EAAE,KAAK,SAAS,IAAI,KAAK,KAAK,KAAK,EAAE,CAAC;YAClF,MAAM,OAAO,GAAG,IAAI,CAAC,wBAAwB,EAAE,CAAC;YAChD,MAAM,QAAQ,GAAG,IAAI,CAAC,gBAAgB,CAAC;YACvC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE;gBACvB,GAAG,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC;YACvB,CAAC,CAAC,CAAC;QACL,CAAC;QACD,MAAM,iBAAiB,GAAG,CAAC,GAAgB,EAAE,EAAE,CAAC,OAAO,GAAG,KAAK,WAAW,CAAC;QAE3E,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,MAAM,EAAE,EAAE,CAAC,EAAE,CAAC;YAChC,MAAM,WAAW,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC;YAC3B,MAAM,UAAU,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;YAC3B,IAAI,CAAC,IAAI,CAAC,kBAAkB,IAAI,iBAAiB,CAAC,WAAW,CAAC;gBAC5D,SAAS;YAEX,GAAG,CAAC,UAAU,CAAC,GAAG,WAAW,CAAC;QAChC,CAAC;QACD,OAAO,GAAG,CAAC;IACb,CAAC;IACD;;;;;;OAMG;IACI,cAAc,CAAC,SAAiB;QACrC,MAAM,OAAO,GAAG,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;QACjD,IAAI,OAAO;YACT,OAAO,OAAO,CAAC;QAEjB,OAAO,IAAI,CAAC,EAAE,CAAC,2BAA2B,CAAC,wDAAwD,EAAE,CAAC,IAAI,EAAE,EAAE;YAC5G,IAAI,CAAC,UAAU,CAAC,CAAC,EAAE,SAAS,CAAC,CAAC;YAC9B,MAAM,OAAO,GAAa,EAAE,CAAC;YAC7B,OAAO,IAAI,CAAC,IAAI,EAAE,KAAK,QAAQ,CAAC,aAAa,EAAE,CAAC;gBAC9C,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,CAAC;YACvC,CAAC;YACD,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;YAC1C,OAAO,OAAO,CAAC;QACjB,CAAC,CAAC,CAAC;IACL,CAAC;IACD;;OAEG;IACH,IAAW,WAAW,KAAK,OAAO,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC;IACtD;;;OAGG;IACI,KAAK;QACV,IAAI,CAAC,YAAY,GAAG,CAAC,CAAC;QACtB,IAAI,CAAC,aAAa,CAAC,KAAK,EAAE,CAAC;IAC7B,CAAC;IACD;;;OAGG;IACI,CAAC,MAAM,CAAC,OAAO,CAAC;QACrB,IAAI,CAAC,KAAK,EAAE,CAAC;IACf,CAAC;CACF","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module SQLiteDb\n */\nimport { DbChangeStage, DbOpcode, DbResult, DbValueType, Id64String } from \"@itwin/core-bentley\";\nimport { ECDb } from \"./ECDb\";\nimport { IModelDb } from \"./IModelDb\";\nimport { IModelNative } from \"./internal/NativePlatform\";\nimport { _nativeDb } from \"./internal/Symbols\";\n\n/** Changed value type\n * @beta\n*/\ntype SqliteValue = Uint8Array | number | string | null | undefined;\n\n/**  Array of changed values\n * @beta\n*/\ntype SqliteValueArray = SqliteValue[];\n/**\n * Format option when converting change from array to column/value object.\n * @beta\n */\nexport interface ChangeFormatArgs {\n  /** include table name */\n  includeTableName?: true;\n  /** include op code */\n  includeOpCode?: true;\n  /** include null columns */\n  includeNullColumns?: true;\n  /** include value version */\n  includeStage?: true;\n  /** include primary key in update change */\n  includePrimaryKeyInUpdateNew?: true;\n}\n\n/** Operation that cause the change\n * @beta\n*/\nexport type SqliteChangeOp = \"Inserted\" | \"Updated\" | \"Deleted\";\n\n/** Stage is version of value that needed to be read\n * @beta\n*/\nexport type SqliteValueStage = \"Old\" | \"New\";\n\n/** Db from which schema will be read. It should be from timeline to which changeset belong.\n * @beta\n*/\nexport type AnyDb = IModelDb | ECDb;\n\n/** Arg to open a changeset file from disk\n * @beta\n*/\nexport interface SqliteChangesetReaderArgs {\n  /** db from which schema will be read. It should be at or ahead of the latest changeset being opened.*/\n  readonly db: AnyDb;\n  /** invert the changeset operations */\n  readonly invert?: true;\n  /** do not check if column of change match db schema instead ignore addition columns */\n  readonly disableSchemaCheck?: true;\n}\n/**\n * Represent sqlite change.\n * @beta\n */\nexport interface SqliteChange {\n  /** name of table */\n  $table?: string;\n  /** SQLite operation that created this change */\n  $op?: SqliteChangeOp;\n  /** version of data in change. */\n  $stage?: SqliteValueStage;\n  /** columns in change */\n  [key: string]: any;\n}\n/**\n * Read raw sqlite changeset from disk and enumerate changes.\n * It also optionally let you format change with schema from\n * a db provided.\n * @beta\n */\nexport class SqliteChangesetReader implements Disposable {\n  private readonly _nativeReader = new IModelNative.platform.ChangesetReader();\n  private _schemaCache = new Map<string, string[]>();\n  private _disableSchemaCheck = false;\n  private _changeIndex = 0;\n  protected constructor(\n    /** db from where sql schema will be read */\n    public readonly db: AnyDb,\n  ) { }\n\n  /**\n   * Open changeset file from disk\n   * @param args fileName of changeset reader and other options.\n   * @returns SqliteChangesetReader instance\n   */\n  public static openFile(args: { readonly fileName: string } & SqliteChangesetReaderArgs): SqliteChangesetReader {\n    const reader = new SqliteChangesetReader(args.db);\n    reader._disableSchemaCheck = args.disableSchemaCheck ?? false;\n    reader._nativeReader.openFile(args.fileName, args.invert ?? false);\n    return reader;\n  }\n  /**\n   * Group changeset file into single changeset and open that changeset.\n   * @param args - The arguments for opening the changeset group. Requires an open db.\n   * @returns The SqliteChangesetReader instance.\n   */\n  public static openGroup(args: { readonly changesetFiles: string[] } & SqliteChangesetReaderArgs): SqliteChangesetReader {\n    if (args.changesetFiles.length === 0) {\n      throw new Error(\"changesetFiles must contain at least one file.\");\n    }\n    const reader = new SqliteChangesetReader(args.db);\n    reader._disableSchemaCheck = args.disableSchemaCheck ?? false;\n    reader._nativeReader.openGroup(args.changesetFiles, args.db[_nativeDb], args.invert ?? false);\n    return reader;\n  }\n  /**\n   * Open txn change in iModel.\n   * @param args iModel and other options.\n   * @returns SqliteChangesetReader instance\n   */\n  public static openTxn(args: { txnId: Id64String } & SqliteChangesetReaderArgs): SqliteChangesetReader {\n    if (args.db instanceof ECDb) {\n      throw new Error(\"ECDb does not support openTxn\");\n    }\n    const reader = new SqliteChangesetReader(args.db);\n    reader._disableSchemaCheck = args.disableSchemaCheck ?? false;\n    reader._nativeReader.openTxn(args.db[_nativeDb], args.txnId, args.invert ?? false);\n    return reader;\n  }\n  /**\n   * Writes the changeset to a file.\n   * @note can be use with openGroup() or openLocalChanges() to persist changeset.\n   * @param args - The arguments for writing to the file.\n   * @param args.fileName - The name of the file to write to.\n   * @param args.containsSchemaChanges - Indicates whether the changeset contains schema changes.\n   * @param args.overwriteFile - Indicates whether to override the file if it already exists. Default is false.\n   */\n  public writeToFile(args: { fileName: string, containsSchemaChanges: boolean, overwriteFile?: boolean }): void {\n    this._nativeReader.writeToFile(args.fileName, args.containsSchemaChanges, args.overwriteFile ?? false);\n  }\n  /**\n   * Open local changes in iModel.\n   * @param args iModel and other options.\n   * @param args.db must be of type IModelDb\n   * @returns SqliteChangesetReader instance\n   */\n  public static openLocalChanges(args: Omit<SqliteChangesetReaderArgs, \"db\"> & { db: IModelDb, includeInMemoryChanges?: true }): SqliteChangesetReader {\n    const reader = new SqliteChangesetReader(args.db);\n    reader._disableSchemaCheck = args.disableSchemaCheck ?? false;\n    reader._nativeReader.openLocalChanges(args.db[_nativeDb], args.includeInMemoryChanges ?? false, args.invert ?? false);\n    return reader;\n  }\n  /** check if schema check is disabled or not */\n  public get disableSchemaCheck(): boolean { return this._disableSchemaCheck; }\n  /** Move to next change in changeset\n   * @returns true if there is current change false if reader is end of changeset.\n   * @beta\n  */\n  public step(): boolean {\n    if (this._nativeReader.step()) {\n      this._changeIndex++;\n      return true;\n    }\n    return false;\n  }\n  /** Check if reader current on a row\n   * @beta\n  */\n  public get hasRow(): boolean {\n    return this._nativeReader.hasRow();\n  }\n  /** Check if its current change is indirect\n   * @beta\n  */\n  public get isIndirect(): boolean {\n    return this._nativeReader.isIndirectChange();\n  }\n  /** Get count of columns in current change\n   * @beta\n  */\n  public get columnCount(): number {\n    return this._nativeReader.getColumnCount();\n  }\n  /** Get operation that caused the change\n   * @beta\n  */\n  public get op(): SqliteChangeOp {\n    if (this._nativeReader.getOpCode() === DbOpcode.Insert)\n      return \"Inserted\";\n\n    if (this._nativeReader.getOpCode() === DbOpcode.Delete)\n      return \"Deleted\";\n\n    return \"Updated\";\n  }\n  /** Get primary key value array\n   * @beta\n  */\n  public get primaryKeyValues(): SqliteValueArray {\n    return this._nativeReader.getPrimaryKeys();\n  }\n  /** Get primary key columns.\n   * @note To this to work db arg must be set when opening changeset file.\n   * @beta\n   */\n  public getPrimaryKeyColumnNames(): string[] {\n    const cols = this.getColumnNames(this.tableName);\n    if (!this._disableSchemaCheck && cols.length !== this.columnCount)\n      throw new Error(`changeset table ${this.tableName} columns count does not match db declared table. ${this.columnCount} <> ${cols.length}`);\n\n    return this._nativeReader.getPrimaryKeyColumnIndexes().map((i) => cols[i]);\n  }\n  /** Get current change table.\n   * @beta\n  */\n  public get tableName(): string {\n    return this._nativeReader.getTableName();\n  }\n  /**\n   * Get changed binary value for a column\n   * @param columnIndex index of column in current change\n   * @param stage old or new value for change.\n   * @returns value for changed column\n   * @beta\n   */\n  public getChangeValueType(columnIndex: number, stage: SqliteValueStage): DbValueType | undefined {\n    return this._nativeReader.getColumnValueType(columnIndex, stage === \"New\" ? DbChangeStage.New : DbChangeStage.Old) as DbValueType;\n  }\n\n  /**\n   * Get changed binary value for a column\n   * @param columnIndex index of column in current change\n   * @param stage old or new value for change.\n   * @returns value for changed column\n   * @beta\n   */\n  public getChangeValueBinary(columnIndex: number, stage: SqliteValueStage): Uint8Array | null | undefined {\n    return this._nativeReader.getColumnValueBinary(columnIndex, stage === \"New\" ? DbChangeStage.New : DbChangeStage.Old);\n  }\n\n  /**\n   * Get changed double value for a column\n   * @param columnIndex index of column in current change\n   * @param stage old or new value for change.\n   * @returns value for changed column\n   * @beta\n   */\n  public getChangeValueDouble(columnIndex: number, stage: SqliteValueStage): number | null | undefined {\n    return this._nativeReader.getColumnValueDouble(columnIndex, stage === \"New\" ? DbChangeStage.New : DbChangeStage.Old);\n  }\n\n  /**\n   * Get changed Id value for a column\n   * @param columnIndex index of column in current change\n   * @param stage old or new value for change.\n   * @returns value for changed column\n   * @beta\n   */\n  public getChangeValueId(columnIndex: number, stage: SqliteValueStage): Id64String | null | undefined {\n    return this._nativeReader.getColumnValueId(columnIndex, stage === \"New\" ? DbChangeStage.New : DbChangeStage.Old);\n  }\n\n  /**\n   * Get changed integer value for a column\n   * @param columnIndex index of column in current change\n   * @param stage old or new value for change.\n   * @returns value for changed column\n   * @beta\n   */\n  public getChangeValueInteger(columnIndex: number, stage: SqliteValueStage): number | null | undefined {\n    return this._nativeReader.getColumnValueInteger(columnIndex, stage === \"New\" ? DbChangeStage.New : DbChangeStage.Old);\n  }\n\n  /**\n   * Get changed text value for a column\n   * @param columnIndex index of column in current change\n   * @param stage old or new value for change.\n   * @returns value for changed column\n   * @beta\n   */\n  public getChangeValueText(columnIndex: number, stage: SqliteValueStage): string | null | undefined {\n    return this._nativeReader.getColumnValueText(columnIndex, stage === \"New\" ? DbChangeStage.New : DbChangeStage.Old);\n  }\n\n  /**\n   * Check if change value is null\n   * @param columnIndex index of column in current change\n   * @param stage old or new value for change.\n   * @returns true if value is null\n   * @beta\n   */\n  public isColumnValueNull(columnIndex: number, stage: SqliteValueStage): boolean | undefined {\n    return this._nativeReader.isColumnValueNull(columnIndex, stage === \"New\" ? DbChangeStage.New : DbChangeStage.Old);\n  }\n\n  /**\n   * Get change value type\n   * @param columnIndex index of column in current change\n   * @param stage old or new value for change.\n   * @returns change value type\n   * @beta\n   */\n  public getColumnValueType(columnIndex: number, stage: SqliteValueStage): DbValueType | undefined {\n    return this._nativeReader.getColumnValueType(columnIndex, stage === \"New\" ? DbChangeStage.New : DbChangeStage.Old) as DbValueType | undefined;\n  }\n\n  /**\n   * Get changed value for a column\n   * @param columnIndex index of column in current change\n   * @param stage old or new value for change.\n   * @returns value for changed column\n   * @beta\n   */\n  public getChangeValue(columnIndex: number, stage: SqliteValueStage): SqliteValue {\n    return this._nativeReader.getColumnValue(columnIndex, stage === \"New\" ? DbChangeStage.New : DbChangeStage.Old);\n  }\n  /**\n   * Get all changed value in current change as array\n   * @param stage old or new values for current change.\n   * @returns array of values.\n   * @beta\n   */\n  public getChangeValuesArray(stage: SqliteValueStage): SqliteValueArray | undefined {\n    return this._nativeReader.getRow(stage === \"New\" ? DbChangeStage.New : DbChangeStage.Old);\n  }\n  /**\n   * Get change as object and format its content.\n   * @param stage old or new value for current change.\n   * @param args change format options\n   * @returns return object or undefined\n   * @beta\n   */\n  public getChangeValuesObject(stage: SqliteValueStage, args: ChangeFormatArgs = {}): SqliteChange | undefined {\n    const cols = this.getColumnNames(this.tableName);\n    const row = this.getChangeValuesArray(stage);\n    if (!row)\n      return undefined;\n    process.env;\n    const minLen = Math.min(cols.length, row.length);\n\n    if (!this._disableSchemaCheck && cols.length !== this.columnCount)\n      throw new Error(`changeset table ${this.tableName} columns count does not match db declared table. ${this.columnCount} <> ${cols.length}`);\n\n    const out: SqliteChange = {};\n    if (args.includeTableName) {\n      out.$table = this.tableName;\n    }\n    if (args.includeOpCode) {\n      out.$op = this.op;\n    }\n    if (args.includeStage) {\n      out.$stage = stage;\n    }\n\n    if (args.includePrimaryKeyInUpdateNew && this.op === \"Updated\" && stage === \"New\") {\n      const pkNames = this.getPrimaryKeyColumnNames();\n      const pkValues = this.primaryKeyValues;\n      pkNames.forEach((v, i) => {\n        out[v] = pkValues[i];\n      });\n    }\n    const isNullOrUndefined = (val: SqliteValue) => typeof val === \"undefined\";\n\n    for (let i = 0; i < minLen; ++i) {\n      const columnValue = row[i];\n      const columnName = cols[i];\n      if (!args.includeNullColumns && isNullOrUndefined(columnValue))\n        continue;\n\n      out[columnName] = columnValue;\n    }\n    return out;\n  }\n  /**\n   * Get list of column for a table. This function also caches the result.\n   * @note To this to work db arg must be set when opening changeset file.\n   * @param tableName name of the table for which columns are requested.\n   * @returns columns of table.\n   * @beta\n   */\n  public getColumnNames(tableName: string): string[] {\n    const columns = this._schemaCache.get(tableName);\n    if (columns)\n      return columns;\n\n    return this.db.withPreparedSqliteStatement(\"SELECT [name] FROM PRAGMA_TABLE_INFO(?) ORDER BY [cid]\", (stmt) => {\n      stmt.bindString(1, tableName);\n      const tblCols: string[] = [];\n      while (stmt.step() === DbResult.BE_SQLITE_ROW) {\n        tblCols.push(stmt.getValueString(0));\n      }\n      this._schemaCache.set(tableName, tblCols);\n      return tblCols;\n    });\n  }\n  /** index of current change\n   * @beta\n   */\n  public get changeIndex() { return this._changeIndex; }\n  /**\n   * Close changeset\n   * @beta\n   */\n  public close() {\n    this._changeIndex = 0;\n    this._nativeReader.close();\n  }\n  /**\n   * Dispose this object\n   * @beta\n   */\n  public [Symbol.dispose](): void {\n    this.close();\n  }\n}\n"]}