@itwin/core-backend 5.6.0 → 5.6.2

package/lib/cjs/internal/IntegrityCheck.d.ts

@@ -0,0 +1,240 @@
+import { IModelDb } from "../IModelDb";
+/**
+ * Information about each integrity check type, including the name, expected result type, and SQL query to execute
+ * @internal
+ */
+export declare const integrityCheckTypeMap: {
+    readonly checkDataColumns: {
+        readonly name: "Check Data Columns";
+        readonly resultType: "CheckDataColumnsResultRow";
+        readonly sqlCommand: "check_data_columns";
+        readonly sqlQuery: "PRAGMA integrity_check(check_data_columns) options enable_experimental_features";
+    };
+    readonly checkECProfile: {
+        readonly name: "Check EC Profile";
+        readonly resultType: "CheckECProfileResultRow";
+        readonly sqlCommand: "check_ec_profile";
+        readonly sqlQuery: "PRAGMA integrity_check(check_ec_profile) options enable_experimental_features";
+    };
+    readonly checkNavigationClassIds: {
+        readonly name: "Check Navigation Class Ids";
+        readonly resultType: "CheckNavClassIdsResultRow";
+        readonly sqlCommand: "check_nav_class_ids";
+        readonly sqlQuery: "PRAGMA integrity_check(check_nav_class_ids) options enable_experimental_features";
+    };
+    readonly checkNavigationIds: {
+        readonly name: "Check Navigation Ids";
+        readonly resultType: "CheckNavIdsResultRow";
+        readonly sqlCommand: "check_nav_ids";
+        readonly sqlQuery: "PRAGMA integrity_check(check_nav_ids) options enable_experimental_features";
+    };
+    readonly checkLinktableForeignKeyClassIds: {
+        readonly name: "Check Link Table Foreign Key Class Ids";
+        readonly resultType: "CheckLinkTableFkClassIdsResultRow";
+        readonly sqlCommand: "check_linktable_fk_class_ids";
+        readonly sqlQuery: "PRAGMA integrity_check(check_linktable_fk_class_ids) options enable_experimental_features";
+    };
+    readonly checkLinktableForeignKeyIds: {
+        readonly name: "Check Link Table Foreign Key Ids";
+        readonly resultType: "CheckLinkTableFkIdsResultRow";
+        readonly sqlCommand: "check_linktable_fk_ids";
+        readonly sqlQuery: "PRAGMA integrity_check(check_linktable_fk_ids) options enable_experimental_features";
+    };
+    readonly checkClassIds: {
+        readonly name: "Check Class Ids";
+        readonly resultType: "CheckClassIdsResultRow";
+        readonly sqlCommand: "check_class_ids";
+        readonly sqlQuery: "PRAGMA integrity_check(check_class_ids) options enable_experimental_features";
+    };
+    readonly checkDataSchema: {
+        readonly name: "Check Data Schema";
+        readonly resultType: "CheckDataSchemaResultRow";
+        readonly sqlCommand: "check_data_schema";
+        readonly sqlQuery: "PRAGMA integrity_check(check_data_schema) options enable_experimental_features";
+    };
+    readonly checkSchemaLoad: {
+        readonly name: "Check Schema Load";
+        readonly resultType: "CheckSchemaLoadResultRow";
+        readonly sqlCommand: "check_schema_load";
+        readonly sqlQuery: "PRAGMA integrity_check(check_schema_load) options enable_experimental_features";
+    };
+    readonly checkMissingChildRows: {
+        readonly name: "Check Missing Child Rows";
+        readonly resultType: "CheckMissingChildRowsResultRow";
+        readonly sqlCommand: "check_missing_child_rows";
+        readonly sqlQuery: "PRAGMA integrity_check(check_missing_child_rows) options enable_experimental_features";
+    };
+};
+/**
+ * Type representing the keys of the integrityCheckType map, which correspond to the different types of integrity checks that can be performed.
+ */
+export type IntegrityCheckKey = keyof typeof integrityCheckTypeMap;
+/** Map of integrity check keys to their result row types */
+interface IntegrityCheckResultTypeMap {
+    checkDataColumns: CheckDataColumnsResultRow;
+    checkECProfile: CheckECProfileResultRow;
+    checkNavigationClassIds: CheckNavClassIdsResultRow;
+    checkNavigationIds: CheckNavIdsResultRow;
+    checkLinktableForeignKeyClassIds: CheckLinkTableFkClassIdsResultRow;
+    checkLinktableForeignKeyIds: CheckLinkTableFkIdsResultRow;
+    checkClassIds: CheckClassIdsResultRow;
+    checkDataSchema: CheckDataSchemaResultRow;
+    checkSchemaLoad: CheckSchemaLoadResultRow;
+    checkMissingChildRows: CheckMissingChildRowsResultRow;
+}
+/** Checks the Map to give the return type of a specific integrity check */
+type IntegrityCheckResultRow<K extends IntegrityCheckKey> = IntegrityCheckResultTypeMap[K];
+/**
+ * Return type for quick integrity check
+ */
+export interface QuickIntegrityCheckResultRow {
+    check: string;
+    passed: boolean;
+    elapsedSeconds: string;
+}
+/**
+ * Return type for Check Data Columns integrity check
+ */
+export interface CheckDataColumnsResultRow {
+    sno: number;
+    table: string;
+    column: string;
+}
+/**
+ * Return type for Check EC Profile integrity check
+ */
+export interface CheckECProfileResultRow {
+    sno: number;
+    type: string;
+    name: string;
+    issue: string;
+}
+/**
+ * Return type for Check Navigation Class Ids integrity check
+ */
+export interface CheckNavClassIdsResultRow {
+    sno: number;
+    id: string;
+    class: string;
+    property: string;
+    navId: string;
+    navClassId: string;
+}
+/**
+ * Return type for Check Navigation Ids integrity check
+ */
+export interface CheckNavIdsResultRow {
+    sno: number;
+    id: string;
+    class: string;
+    property: string;
+    navId: string;
+    primaryClass: string;
+}
+/**
+ * Return type for Check Link Table Foreign Key Class Ids integrity check
+ */
+export interface CheckLinkTableFkClassIdsResultRow {
+    sno: number;
+    id: string;
+    relationship: string;
+    property: string;
+    keyId: string;
+    keyClassId: string;
+}
+/**
+ * Return type for Check Link Table Foreign Key Ids integrity check
+ */
+export interface CheckLinkTableFkIdsResultRow {
+    sno: number;
+    id: string;
+    relationship: string;
+    property: string;
+    keyId: string;
+    primaryClass: string;
+}
+/**
+ * Return type for Check Class Ids integrity check
+ */
+export interface CheckClassIdsResultRow {
+    sno: number;
+    class: string;
+    id: string;
+    classId: string;
+    type: string;
+}
+/**
+ * Return type for Check Data Schema integrity check
+ */
+export interface CheckDataSchemaResultRow {
+    sno: number;
+    type: string;
+    name: string;
+}
+/**
+ * Return type for Check Schema Load integrity check
+ */
+export interface CheckSchemaLoadResultRow {
+    sno: number;
+    schema: string;
+}
+/**
+ * Return type for Check Missing Child Rows integrity check
+ */
+export interface CheckMissingChildRowsResultRow {
+    sno: number;
+    class: string;
+    id: string;
+    classId: string;
+    missingRowInTables: string;
+}
+/**
+ * Return type for integrity check results, including the check name, whether it passed, and the specific results (if any)
+ */
+export interface IntegrityCheckResult {
+    /** The name of the integrity check that was performed */
+    check: string;
+    /** Whether the integrity check passed (i.e. no issues were found = true) */
+    passed: boolean;
+    /** The specific results returned by the integrity check, which may include details about any issues that were found.
+     * In the case where issues are found, this will be an array of result rows specific to the type of check that was performed,
+     * or an array of quick integrity check results if it was a quick check. */
+    results: IntegrityCheckResultRow<IntegrityCheckKey>[] | QuickIntegrityCheckResultRow[];
+}
+/**
+ * Gets the user-friendly name of an integrity check based on its key or SQL command.
+ * It first attempts to find a direct match for the key in the integrityCheckTypeMap. If not found, it searches for a match based on the SQL command.
+ * If still not found, it returns the original check string.
+ * @param check - The integrity check key or SQL command to get the name of
+ * @returns The user-friendly name of the integrity check, or the original check string if no match is found
+ * @internal
+ */
+export declare function getIntegrityCheckName(check: string): string;
+/**
+ * Performs a quick integrity check on the given iModel.
+ * @param iModel The IModelDb instance to perform the integrity check on
+ * @returns An array of results for each check performed, including the check name, whether it passed, and the elapsed time in seconds
+ * @internal
+ */
+export declare function performQuickIntegrityCheck(iModel: IModelDb): Promise<QuickIntegrityCheckResultRow[]>;
+/**
+ * Performs a specific integrity check on the given iModel based on the provided check key, and returns the results specific to that check type.
+ * @param iModel The IModelDb instance to perform the integrity check on
+ * @param check The key of the specific integrity check to perform
+ * @return An array of results specific to the integrity check that was performed. The type of the result rows will depend on the check that was executed.
+ * @throws IModelError with status BadRequest if an unknown integrity check key is provided
+ * @internal
+ */
+export declare function performSpecificIntegrityCheck(iModel: IModelDb, check: "checkDataColumns"): Promise<IntegrityCheckResultRow<"checkDataColumns">[]>;
+export declare function performSpecificIntegrityCheck(iModel: IModelDb, check: "checkECProfile"): Promise<IntegrityCheckResultRow<"checkECProfile">[]>;
+export declare function performSpecificIntegrityCheck(iModel: IModelDb, check: "checkNavigationClassIds"): Promise<IntegrityCheckResultRow<"checkNavigationClassIds">[]>;
+export declare function performSpecificIntegrityCheck(iModel: IModelDb, check: "checkNavigationIds"): Promise<IntegrityCheckResultRow<"checkNavigationIds">[]>;
+export declare function performSpecificIntegrityCheck(iModel: IModelDb, check: "checkLinktableForeignKeyClassIds"): Promise<IntegrityCheckResultRow<"checkLinktableForeignKeyClassIds">[]>;
+export declare function performSpecificIntegrityCheck(iModel: IModelDb, check: "checkLinktableForeignKeyIds"): Promise<IntegrityCheckResultRow<"checkLinktableForeignKeyIds">[]>;
+export declare function performSpecificIntegrityCheck(iModel: IModelDb, check: "checkClassIds"): Promise<IntegrityCheckResultRow<"checkClassIds">[]>;
+export declare function performSpecificIntegrityCheck(iModel: IModelDb, check: "checkDataSchema"): Promise<IntegrityCheckResultRow<"checkDataSchema">[]>;
+export declare function performSpecificIntegrityCheck(iModel: IModelDb, check: "checkSchemaLoad"): Promise<IntegrityCheckResultRow<"checkSchemaLoad">[]>;
+export declare function performSpecificIntegrityCheck(iModel: IModelDb, check: "checkMissingChildRows"): Promise<IntegrityCheckResultRow<"checkMissingChildRows">[]>;
+export declare function performSpecificIntegrityCheck<K extends IntegrityCheckKey>(iModel: IModelDb, check: K): Promise<IntegrityCheckResultRow<K>[]>;
+export {};
+//# sourceMappingURL=IntegrityCheck.d.ts.map

package/lib/cjs/internal/IntegrityCheck.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"IntegrityCheck.d.ts","sourceRoot":"","sources":["../../../src/internal/IntegrityCheck.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAEvC;;;GAGG;AACH,eAAO,MAAM,qBAAqB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA6DxB,CAAC;AAEX;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG,MAAM,OAAO,qBAAqB,CAAC;AAEnE,4DAA4D;AAC5D,UAAU,2BAA2B;IACnC,gBAAgB,EAAE,yBAAyB,CAAC;IAC5C,cAAc,EAAE,uBAAuB,CAAC;IACxC,uBAAuB,EAAE,yBAAyB,CAAC;IACnD,kBAAkB,EAAE,oBAAoB,CAAC;IACzC,gCAAgC,EAAE,iCAAiC,CAAC;IACpE,2BAA2B,EAAE,4BAA4B,CAAC;IAC1D,aAAa,EAAE,sBAAsB,CAAC;IACtC,eAAe,EAAE,wBAAwB,CAAC;IAC1C,eAAe,EAAE,wBAAwB,CAAC;IAC1C,qBAAqB,EAAE,8BAA8B,CAAC;CACvD;AAED,2EAA2E;AAC3E,KAAK,uBAAuB,CAAC,CAAC,SAAS,iBAAiB,IAAI,2BAA2B,CAAC,CAAC,CAAC,CAAC;AAE3F;;GAEG;AACH,MAAM,WAAW,4BAA4B;IAC3C,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,OAAO,CAAC;IAChB,cAAc,EAAE,MAAM,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC,GAAG,EAAE,MAAM,CAAC;IACZ,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE,MAAM,CAAC;IACd,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,GAAG,EAAE,MAAM,CAAC;IACZ,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE,MAAM,CAAC;IACd,YAAY,EAAE,MAAM,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,iCAAiC;IAChD,GAAG,EAAE,MAAM,CAAC;IACZ,EAAE,EAAE,MAAM,CAAC;IACX,YAAY,EAAE,MAAM,CAAC;IACrB,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE,MAAM,CAAC;IACd,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,4BAA4B;IAC3C,GAAG,EAAE,MAAM,CAAC;IACZ,EAAE,EAAE,MAAM,CAAC;IACX,YAAY,EAAE,MAAM,CAAC;IACrB,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE,MAAM,CAAC;IACd,YAAY,EAAE,MAAM,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,MAAM,CAAC;IACd,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,8BAA8B;IAC7C,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,MAAM,CAAC;IACd,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,EAAE,MAAM,CAAC;IAChB,kBAAkB,EAAE,MAAM,CAAC;CAC5B;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,yDAAyD;IACzD,KAAK,EAAE,MAAM,CAAC;IACd,4EAA4E;IAC5E,MAAM,EAAE,OAAO,CAAC;IAChB;;+EAE2E;IAC3E,OAAO,EAAE,uBAAuB,CAAC,iBAAiB,CAAC,EAAE,GAAG,4BAA4B,EAAE,CAAC;CACxF;AAED;;;;;;;GAOG;AACH,wBAAgB,qBAAqB,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAc3D;AAED;;;;;GAKG;AACH,wBAAsB,0BAA0B,CAAC,MAAM,EAAE,QAAQ,GAAG,OAAO,CAAC,4BAA4B,EAAE,CAAC,CAO1G;AAED;;;;;;;GAOG;AACH,wBAAsB,6BAA6B,CAAC,MAAM,EAAE,QAAQ,EAAE,KAAK,EAAE,kBAAkB,GAAG,OAAO,CAAC,uBAAuB,CAAC,kBAAkB,CAAC,EAAE,CAAC,CAAC;AACzJ,wBAAsB,6BAA6B,CAAC,MAAM,EAAE,QAAQ,EAAE,KAAK,EAAE,gBAAgB,GAAG,OAAO,CAAC,uBAAuB,CAAC,gBAAgB,CAAC,EAAE,CAAC,CAAC;AACrJ,wBAAsB,6BAA6B,CAAC,MAAM,EAAE,QAAQ,EAAE,KAAK,EAAE,yBAAyB,GAAG,OAAO,CAAC,uBAAuB,CAAC,yBAAyB,CAAC,EAAE,CAAC,CAAC;AACvK,wBAAsB,6BAA6B,CAAC,MAAM,EAAE,QAAQ,EAAE,KAAK,EAAE,oBAAoB,GAAG,OAAO,CAAC,uBAAuB,CAAC,oBAAoB,CAAC,EAAE,CAAC,CAAC;AAC7J,wBAAsB,6BAA6B,CAAC,MAAM,EAAE,QAAQ,EAAE,KAAK,EAAE,kCAAkC,GAAG,OAAO,CAAC,uBAAuB,CAAC,kCAAkC,CAAC,EAAE,CAAC,CAAC;AACzL,wBAAsB,6BAA6B,CAAC,MAAM,EAAE,QAAQ,EAAE,KAAK,EAAE,6BAA6B,GAAG,OAAO,CAAC,uBAAuB,CAAC,6BAA6B,CAAC,EAAE,CAAC,CAAC;AAC/K,wBAAsB,6BAA6B,CAAC,MAAM,EAAE,QAAQ,EAAE,KAAK,EAAE,eAAe,GAAG,OAAO,CAAC,uBAAuB,CAAC,eAAe,CAAC,EAAE,CAAC,CAAC;AACnJ,wBAAsB,6BAA6B,CAAC,MAAM,EAAE,QAAQ,EAAE,KAAK,EAAE,iBAAiB,GAAG,OAAO,CAAC,uBAAuB,CAAC,iBAAiB,CAAC,EAAE,CAAC,CAAC;AACvJ,wBAAsB,6BAA6B,CAAC,MAAM,EAAE,QAAQ,EAAE,KAAK,EAAE,iBAAiB,GAAG,OAAO,CAAC,uBAAuB,CAAC,iBAAiB,CAAC,EAAE,CAAC,CAAC;AACvJ,wBAAsB,6BAA6B,CAAC,MAAM,EAAE,QAAQ,EAAE,KAAK,EAAE,uBAAuB,GAAG,OAAO,CAAC,uBAAuB,CAAC,uBAAuB,CAAC,EAAE,CAAC,CAAC;AACnK,wBAAsB,6BAA6B,CAAC,CAAC,SAAS,iBAAiB,EAAE,MAAM,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC,GAAG,OAAO,CAAC,uBAAuB,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC"}

package/lib/cjs/internal/IntegrityCheck.js

@@ -0,0 +1,193 @@
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.integrityCheckTypeMap = void 0;
+exports.getIntegrityCheckName = getIntegrityCheckName;
+exports.performQuickIntegrityCheck = performQuickIntegrityCheck;
+exports.performSpecificIntegrityCheck = performSpecificIntegrityCheck;
+const core_bentley_1 = require("@itwin/core-bentley");
+const core_common_1 = require("@itwin/core-common");
+/**
+ * Information about each integrity check type, including the name, expected result type, and SQL query to execute
+ * @internal
+ */
+exports.integrityCheckTypeMap = {
+    checkDataColumns: {
+        name: "Check Data Columns",
+        resultType: "CheckDataColumnsResultRow",
+        sqlCommand: "check_data_columns",
+        sqlQuery: `PRAGMA integrity_check(check_data_columns) options enable_experimental_features`,
+    },
+    checkECProfile: {
+        name: "Check EC Profile",
+        resultType: "CheckECProfileResultRow",
+        sqlCommand: "check_ec_profile",
+        sqlQuery: `PRAGMA integrity_check(check_ec_profile) options enable_experimental_features`,
+    },
+    checkNavigationClassIds: {
+        name: "Check Navigation Class Ids",
+        resultType: "CheckNavClassIdsResultRow",
+        sqlCommand: "check_nav_class_ids",
+        sqlQuery: `PRAGMA integrity_check(check_nav_class_ids) options enable_experimental_features`,
+    },
+    checkNavigationIds: {
+        name: "Check Navigation Ids",
+        resultType: "CheckNavIdsResultRow",
+        sqlCommand: "check_nav_ids",
+        sqlQuery: `PRAGMA integrity_check(check_nav_ids) options enable_experimental_features`,
+    },
+    checkLinktableForeignKeyClassIds: {
+        name: "Check Link Table Foreign Key Class Ids",
+        resultType: "CheckLinkTableFkClassIdsResultRow",
+        sqlCommand: "check_linktable_fk_class_ids",
+        sqlQuery: `PRAGMA integrity_check(check_linktable_fk_class_ids) options enable_experimental_features`,
+    },
+    checkLinktableForeignKeyIds: {
+        name: "Check Link Table Foreign Key Ids",
+        resultType: "CheckLinkTableFkIdsResultRow",
+        sqlCommand: "check_linktable_fk_ids",
+        sqlQuery: `PRAGMA integrity_check(check_linktable_fk_ids) options enable_experimental_features`,
+    },
+    checkClassIds: {
+        name: "Check Class Ids",
+        resultType: "CheckClassIdsResultRow",
+        sqlCommand: "check_class_ids",
+        sqlQuery: `PRAGMA integrity_check(check_class_ids) options enable_experimental_features`,
+    },
+    checkDataSchema: {
+        name: "Check Data Schema",
+        resultType: "CheckDataSchemaResultRow",
+        sqlCommand: "check_data_schema",
+        sqlQuery: `PRAGMA integrity_check(check_data_schema) options enable_experimental_features`,
+    },
+    checkSchemaLoad: {
+        name: "Check Schema Load",
+        resultType: "CheckSchemaLoadResultRow",
+        sqlCommand: "check_schema_load",
+        sqlQuery: `PRAGMA integrity_check(check_schema_load) options enable_experimental_features`,
+    },
+    checkMissingChildRows: {
+        name: "Check Missing Child Rows",
+        resultType: "CheckMissingChildRowsResultRow",
+        sqlCommand: "check_missing_child_rows",
+        sqlQuery: `PRAGMA integrity_check(check_missing_child_rows) options enable_experimental_features`,
+    },
+};
+/**
+ * Gets the user-friendly name of an integrity check based on its key or SQL command.
+ * It first attempts to find a direct match for the key in the integrityCheckTypeMap. If not found, it searches for a match based on the SQL command.
+ * If still not found, it returns the original check string.
+ * @param check - The integrity check key or SQL command to get the name of
+ * @returns The user-friendly name of the integrity check, or the original check string if no match is found
+ * @internal
+ */
+function getIntegrityCheckName(check) {
+    // First try direct lookup by key
+    const directLookup = exports.integrityCheckTypeMap[check];
+    if (directLookup) {
+        return directLookup.name;
+    }
+    // If not found, search by sqlCommand
+    for (const [, value] of Object.entries(exports.integrityCheckTypeMap)) {
+        if (value.sqlCommand === check) {
+            return value.name;
+        }
+    }
+    // Fallback to the original check string
+    return check;
+}
+/**
+ * Performs a quick integrity check on the given iModel.
+ * @param iModel The IModelDb instance to perform the integrity check on
+ * @returns An array of results for each check performed, including the check name, whether it passed, and the elapsed time in seconds
+ * @internal
+ */
+async function performQuickIntegrityCheck(iModel) {
+    const integrityCheckQuery = "PRAGMA integrity_check options enable_experimental_features";
+    const integrityCheckResults = [];
+    for await (const row of iModel.createQueryReader(integrityCheckQuery)) {
+        integrityCheckResults.push({ check: getIntegrityCheckName(row.check), passed: row.result, elapsedSeconds: row.elapsed_sec });
+    }
+    ;
+    return integrityCheckResults;
+}
+async function performSpecificIntegrityCheck(iModel, check) {
+    switch (check) {
+        case "checkDataColumns": {
+            const results = [];
+            for await (const row of iModel.createQueryReader(exports.integrityCheckTypeMap.checkDataColumns.sqlQuery)) {
+                results.push({ sno: row.sno, table: row.table, column: row.column });
+            }
+            return results;
+        }
+        case "checkECProfile": {
+            const results = [];
+            for await (const row of iModel.createQueryReader(exports.integrityCheckTypeMap.checkECProfile.sqlQuery)) {
+                results.push({ sno: row.sno, type: row.type, name: row.name, issue: row.issue });
+            }
+            return results;
+        }
+        case "checkNavigationClassIds": {
+            const results = [];
+            for await (const row of iModel.createQueryReader(exports.integrityCheckTypeMap.checkNavigationClassIds.sqlQuery)) {
+                results.push({ sno: row.sno, id: row.id, class: row.class, property: row.property, navId: row.nav_id, navClassId: row.nav_classId });
+            }
+            return results;
+        }
+        case "checkNavigationIds": {
+            const results = [];
+            for await (const row of iModel.createQueryReader(exports.integrityCheckTypeMap.checkNavigationIds.sqlQuery)) {
+                results.push({ sno: row.sno, id: row.id, class: row.class, property: row.property, navId: row.nav_id, primaryClass: row.primary_class });
+            }
+            return results;
+        }
+        case "checkLinktableForeignKeyClassIds": {
+            const results = [];
+            for await (const row of iModel.createQueryReader(exports.integrityCheckTypeMap.checkLinktableForeignKeyClassIds.sqlQuery)) {
+                results.push({ sno: row.sno, id: row.id, relationship: row.relationship, property: row.property, keyId: row.key_id, keyClassId: row.key_classId });
+            }
+            return results;
+        }
+        case "checkLinktableForeignKeyIds": {
+            const results = [];
+            for await (const row of iModel.createQueryReader(exports.integrityCheckTypeMap.checkLinktableForeignKeyIds.sqlQuery)) {
+                results.push({ sno: row.sno, id: row.id, relationship: row.relationship, property: row.property, keyId: row.key_id, primaryClass: row.primary_class });
+            }
+            return results;
+        }
+        case "checkClassIds": {
+            const results = [];
+            for await (const row of iModel.createQueryReader(exports.integrityCheckTypeMap.checkClassIds.sqlQuery)) {
+                results.push({ sno: row.sno, class: row.class, id: row.id, classId: row.class_id, type: row.type });
+            }
+            return results;
+        }
+        case "checkDataSchema": {
+            const results = [];
+            for await (const row of iModel.createQueryReader(exports.integrityCheckTypeMap.checkDataSchema.sqlQuery)) {
+                results.push({ sno: row.sno, type: row.type, name: row.name });
+            }
+            return results;
+        }
+        case "checkSchemaLoad": {
+            const results = [];
+            for await (const row of iModel.createQueryReader(exports.integrityCheckTypeMap.checkSchemaLoad.sqlQuery)) {
+                results.push({ sno: row.sno, schema: row.schema });
+            }
+            return results;
+        }
+        case "checkMissingChildRows": {
+            const results = [];
+            for await (const row of iModel.createQueryReader(exports.integrityCheckTypeMap.checkMissingChildRows.sqlQuery)) {
+                results.push({ sno: row.sno, class: row.class, id: row.id, classId: row.class_id, missingRowInTables: row.MissingRowInTables });
+            }
+            return results;
+        }
+        default:
+            throw new core_common_1.IModelError(core_bentley_1.IModelStatus.BadRequest, `Unknown integrity check type: ${check}`);
+    }
+}
+//# sourceMappingURL=IntegrityCheck.js.map

package/lib/cjs/internal/IntegrityCheck.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IntegrityCheck.js","sourceRoot":"","sources":["../../../src/internal/IntegrityCheck.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;;;AAwO/F,sDAcC;AAQD,gEAOC;AAqBD,sEA2EC;AAnWD,sDAAmD;AACnD,oDAAiD;AAGjD;;;GAGG;AACU,QAAA,qBAAqB,GAAG;IACnC,gBAAgB,EAAE;QAChB,IAAI,EAAE,oBAAoB;QAC1B,UAAU,EAAE,2BAA2B;QACvC,UAAU,EAAE,oBAAoB;QAChC,QAAQ,EAAE,iFAAiF;KAC5F;IACD,cAAc,EAAE;QACd,IAAI,EAAE,kBAAkB;QACxB,UAAU,EAAE,yBAAyB;QACrC,UAAU,EAAE,kBAAkB;QAC9B,QAAQ,EAAE,+EAA+E;KAC1F;IACD,uBAAuB,EAAE;QACvB,IAAI,EAAE,4BAA4B;QAClC,UAAU,EAAE,2BAA2B;QACvC,UAAU,EAAE,qBAAqB;QACjC,QAAQ,EAAE,kFAAkF;KAC7F;IACD,kBAAkB,EAAE;QAClB,IAAI,EAAE,sBAAsB;QAC5B,UAAU,EAAE,sBAAsB;QAClC,UAAU,EAAE,eAAe;QAC3B,QAAQ,EAAE,4EAA4E;KACvF;IACD,gCAAgC,EAAE;QAChC,IAAI,EAAE,wCAAwC;QAC9C,UAAU,EAAE,mCAAmC;QAC/C,UAAU,EAAE,8BAA8B;QAC1C,QAAQ,EAAE,2FAA2F;KACtG;IACD,2BAA2B,EAAE;QAC3B,IAAI,EAAE,kCAAkC;QACxC,UAAU,EAAE,8BAA8B;QAC1C,UAAU,EAAE,wBAAwB;QACpC,QAAQ,EAAE,qFAAqF;KAChG;IACD,aAAa,EAAE;QACb,IAAI,EAAE,iBAAiB;QACvB,UAAU,EAAE,wBAAwB;QACpC,UAAU,EAAE,iBAAiB;QAC7B,QAAQ,EAAE,8EAA8E;KACzF;IACD,eAAe,EAAE;QACf,IAAI,EAAE,mBAAmB;QACzB,UAAU,EAAE,0BAA0B;QACtC,UAAU,EAAE,mBAAmB;QAC/B,QAAQ,EAAE,gFAAgF;KAC3F;IACD,eAAe,EAAE;QACf,IAAI,EAAE,mBAAmB;QACzB,UAAU,EAAE,0BAA0B;QACtC,UAAU,EAAE,mBAAmB;QAC/B,QAAQ,EAAE,gFAAgF;KAC3F;IACD,qBAAqB,EAAE;QACrB,IAAI,EAAE,0BAA0B;QAChC,UAAU,EAAE,gCAAgC;QAC5C,UAAU,EAAE,0BAA0B;QACtC,QAAQ,EAAE,uFAAuF;KAClG;CACO,CAAC;AAyJX;;;;;;;GAOG;AACH,SAAgB,qBAAqB,CAAC,KAAa;IACjD,iCAAiC;IACjC,MAAM,YAAY,GAAG,6BAAqB,CAAC,KAA0B,CAAC,CAAC;IACvE,IAAI,YAAY,EAAE,CAAC;QACjB,OAAO,YAAY,CAAC,IAAI,CAAC;IAC3B,CAAC;IACD,qCAAqC;IACrC,KAAK,MAAM,CAAC,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,6BAAqB,CAAC,EAAE,CAAC;QAC9D,IAAI,KAAK,CAAC,UAAU,KAAK,KAAK,EAAE,CAAC;YAC/B,OAAO,KAAK,CAAC,IAAI,CAAC;QACpB,CAAC;IACH,CAAC;IACD,wCAAwC;IACxC,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;;;;GAKG;AACI,KAAK,UAAU,0BAA0B,CAAC,MAAgB;IAC/D,MAAM,mBAAmB,GAAG,6DAA6D,CAAC;IAC1F,MAAM,qBAAqB,GAAmC,EAAE,CAAC;IACjE,IAAI,KAAK,EAAE,MAAM,GAAG,IAAI,MAAM,CAAC,iBAAiB,CAAC,mBAAmB,CAAC,EAAE,CAAC;QACtE,qBAAqB,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,qBAAqB,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,MAAM,EAAE,GAAG,CAAC,MAAM,EAAE,cAAc,EAAE,GAAG,CAAC,WAAW,EAAC,CAAC,CAAC;IAC9H,CAAC;IAAA,CAAC;IACF,OAAO,qBAAqB,CAAC;AAC/B,CAAC;AAqBM,KAAK,UAAU,6BAA6B,CAAC,MAAgB,EAAE,KAAwB;IAC5F,QAAQ,KAAK,EAAE,CAAC;QACd,KAAK,kBAAkB,CAAC,CAAC,CAAC;YACxB,MAAM,OAAO,GAAgC,EAAE,CAAC;YAChD,IAAI,KAAK,EAAE,MAAM,GAAG,IAAI,MAAM,CAAC,iBAAiB,CAAC,6BAAqB,CAAC,gBAAgB,CAAC,QAAQ,CAAC,EAAE,CAAC;gBAClG,OAAO,CAAC,IAAI,CAAC,EAAE,GAAG,EAAE,GAAG,CAAC,GAAG,EAAE,KAAK,EAAE,GAAG,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,CAAC,MAAM,EAAE,CAAC,CAAC;YACvE,CAAC;YACD,OAAO,OAAO,CAAC;QACjB,CAAC;QACD,KAAK,gBAAgB,CAAC,CAAC,CAAC;YACtB,MAAM,OAAO,GAA8B,EAAE,CAAC;YAC9C,IAAI,KAAK,EAAE,MAAM,GAAG,IAAI,MAAM,CAAC,iBAAiB,CAAC,6BAAqB,CAAC,cAAc,CAAC,QAAQ,CAAC,EAAE,CAAC;gBAChG,OAAO,CAAC,IAAI,CAAC,EAAE,GAAG,EAAE,GAAG,CAAC,GAAG,EAAE,IAAI,EAAE,GAAG,CAAC,IAAI,EAAE,IAAI,EAAE,GAAG,CAAC,IAAI,EAAE,KAAK,EAAE,GAAG,CAAC,KAAK,EAAE,CAAC,CAAC;YACnF,CAAC;YACD,OAAO,OAAO,CAAC;QACjB,CAAC;QACD,KAAK,yBAAyB,CAAC,CAAC,CAAC;YAC/B,MAAM,OAAO,GAAgC,EAAE,CAAC;YAChD,IAAI,KAAK,EAAE,MAAM,GAAG,IAAI,MAAM,CAAC,iBAAiB,CAAC,6BAAqB,CAAC,uBAAuB,CAAC,QAAQ,CAAC,EAAE,CAAC;gBACzG,OAAO,CAAC,IAAI,CAAC,EAAE,GAAG,EAAE,GAAG,CAAC,GAAG,EAAE,EAAE,EAAE,GAAG,CAAC,EAAE,EAAE,KAAK,EAAE,GAAG,CAAC,KAAK,EAAE,QAAQ,EAAE,GAAG,CAAC,QAAQ,EAAE,KAAK,EAAE,GAAG,CAAC,MAAM,EAAE,UAAU,EAAE,GAAG,CAAC,WAAW,EAAE,CAAC,CAAC;YACvI,CAAC;YACD,OAAO,OAAO,CAAC;QACjB,CAAC;QACD,KAAK,oBAAoB,CAAC,CAAC,CAAC;YAC1B,MAAM,OAAO,GAA2B,EAAE,CAAC;YAC3C,IAAI,KAAK,EAAE,MAAM,GAAG,IAAI,MAAM,CAAC,iBAAiB,CAAC,6BAAqB,CAAC,kBAAkB,CAAC,QAAQ,CAAC,EAAE,CAAC;gBACpG,OAAO,CAAC,IAAI,CAAC,EAAE,GAAG,EAAE,GAAG,CAAC,GAAG,EAAE,EAAE,EAAE,GAAG,CAAC,EAAE,EAAE,KAAK,EAAE,GAAG,CAAC,KAAK,EAAE,QAAQ,EAAE,GAAG,CAAC,QAAQ,EAAE,KAAK,EAAE,GAAG,CAAC,MAAM,EAAE,YAAY,EAAE,GAAG,CAAC,aAAa,EAAE,CAAC,CAAC;YAC3I,CAAC;YACD,OAAO,OAAO,CAAC;QACjB,CAAC;QACD,KAAK,kCAAkC,CAAC,CAAC,CAAC;YACxC,MAAM,OAAO,GAAwC,EAAE,CAAC;YACxD,IAAI,KAAK,EAAE,MAAM,GAAG,IAAI,MAAM,CAAC,iBAAiB,CAAC,6BAAqB,CAAC,gCAAgC,CAAC,QAAQ,CAAC,EAAE,CAAC;gBAClH,OAAO,CAAC,IAAI,CAAC,EAAE,GAAG,EAAE,GAAG,CAAC,GAAG,EAAE,EAAE,EAAE,GAAG,CAAC,EAAE,EAAE,YAAY,EAAE,GAAG,CAAC,YAAY,EAAE,QAAQ,EAAE,GAAG,CAAC,QAAQ,EAAE,KAAK,EAAE,GAAG,CAAC,MAAM,EAAE,UAAU,EAAE,GAAG,CAAC,WAAW,EAAE,CAAC,CAAC;YACrJ,CAAC;YACD,OAAO,OAAO,CAAC;QACjB,CAAC;QACD,KAAK,6BAA6B,CAAC,CAAC,CAAC;YACnC,MAAM,OAAO,GAAmC,EAAE,CAAC;YACnD,IAAI,KAAK,EAAE,MAAM,GAAG,IAAI,MAAM,CAAC,iBAAiB,CAAC,6BAAqB,CAAC,2BAA2B,CAAC,QAAQ,CAAC,EAAE,CAAC;gBAC7G,OAAO,CAAC,IAAI,CAAC,EAAE,GAAG,EAAE,GAAG,CAAC,GAAG,EAAE,EAAE,EAAE,GAAG,CAAC,EAAE,EAAE,YAAY,EAAE,GAAG,CAAC,YAAY,EAAE,QAAQ,EAAE,GAAG,CAAC,QAAQ,EAAE,KAAK,EAAE,GAAG,CAAC,MAAM,EAAE,YAAY,EAAE,GAAG,CAAC,aAAa,EAAE,CAAC,CAAC;YACzJ,CAAC;YACD,OAAO,OAAO,CAAC;QACjB,CAAC;QACD,KAAK,eAAe,CAAC,CAAC,CAAC;YACrB,MAAM,OAAO,GAA6B,EAAE,CAAC;YAC7C,IAAI,KAAK,EAAE,MAAM,GAAG,IAAI,MAAM,CAAC,iBAAiB,CAAC,6BAAqB,CAAC,aAAa,CAAC,QAAQ,CAAC,EAAE,CAAC;gBAC/F,OAAO,CAAC,IAAI,CAAC,EAAE,GAAG,EAAE,GAAG,CAAC,GAAG,EAAE,KAAK,EAAE,GAAG,CAAC,KAAK,EAAE,EAAE,EAAE,GAAG,CAAC,EAAE,EAAE,OAAO,EAAE,GAAG,CAAC,QAAQ,EAAE,IAAI,EAAE,GAAG,CAAC,IAAI,EAAE,CAAC,CAAC;YACtG,CAAC;YACD,OAAO,OAAO,CAAC;QACjB,CAAC;QACD,KAAK,iBAAiB,CAAC,CAAC,CAAC;YACvB,MAAM,OAAO,GAA+B,EAAE,CAAC;YAC/C,IAAI,KAAK,EAAE,MAAM,GAAG,IAAI,MAAM,CAAC,iBAAiB,CAAC,6BAAqB,CAAC,eAAe,CAAC,QAAQ,CAAC,EAAE,CAAC;gBACjG,OAAO,CAAC,IAAI,CAAC,EAAE,GAAG,EAAE,GAAG,CAAC,GAAG,EAAE,IAAI,EAAE,GAAG,CAAC,IAAI,EAAE,IAAI,EAAE,GAAG,CAAC,IAAI,EAAE,CAAC,CAAC;YACjE,CAAC;YACD,OAAO,OAAO,CAAC;QACjB,CAAC;QACD,KAAK,iBAAiB,CAAC,CAAC,CAAC;YACvB,MAAM,OAAO,GAA+B,EAAE,CAAC;YAC/C,IAAI,KAAK,EAAE,MAAM,GAAG,IAAI,MAAM,CAAC,iBAAiB,CAAC,6BAAqB,CAAC,eAAe,CAAC,QAAQ,CAAC,EAAE,CAAC;gBACjG,OAAO,CAAC,IAAI,CAAC,EAAE,GAAG,EAAE,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,CAAC,MAAM,EAAE,CAAC,CAAC;YACrD,CAAC;YACD,OAAO,OAAO,CAAC;QACjB,CAAC;QACD,KAAK,uBAAuB,CAAC,CAAC,CAAC;YAC7B,MAAM,OAAO,GAAqC,EAAE,CAAC;YACrD,IAAI,KAAK,EAAE,MAAM,GAAG,IAAI,MAAM,CAAC,iBAAiB,CAAC,6BAAqB,CAAC,qBAAqB,CAAC,QAAQ,CAAC,EAAE,CAAC;gBACvG,OAAO,CAAC,IAAI,CAAC,EAAE,GAAG,EAAE,GAAG,CAAC,GAAG,EAAE,KAAK,EAAE,GAAG,CAAC,KAAK,EAAE,EAAE,EAAE,GAAG,CAAC,EAAE,EAAE,OAAO,EAAE,GAAG,CAAC,QAAQ,EAAE,kBAAkB,EAAE,GAAG,CAAC,kBAAkB,EAAE,CAAC,CAAC;YAClI,CAAC;YACD,OAAO,OAAO,CAAC;QACjB,CAAC;QACD;YACE,MAAM,IAAI,yBAAW,CAAC,2BAAY,CAAC,UAAU,EAAE,iCAAiC,KAAK,EAAE,CAAC,CAAC;IAC7F,CAAC;AACH,CAAC","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\r\nimport { IModelStatus } from \"@itwin/core-bentley\";\r\nimport { IModelError } from \"@itwin/core-common\";\r\nimport { IModelDb } from \"../IModelDb\";\r\n\r\n/**\r\n * Information about each integrity check type, including the name, expected result type, and SQL query to execute\r\n * @internal\r\n */\r\nexport const integrityCheckTypeMap = {\r\n  checkDataColumns: {\r\n    name: \"Check Data Columns\",\r\n    resultType: \"CheckDataColumnsResultRow\",\r\n    sqlCommand: \"check_data_columns\",\r\n    sqlQuery: `PRAGMA integrity_check(check_data_columns) options enable_experimental_features`,\r\n  },\r\n  checkECProfile: {\r\n    name: \"Check EC Profile\",\r\n    resultType: \"CheckECProfileResultRow\",\r\n    sqlCommand: \"check_ec_profile\",\r\n    sqlQuery: `PRAGMA integrity_check(check_ec_profile) options enable_experimental_features`,\r\n  },\r\n  checkNavigationClassIds: {\r\n    name: \"Check Navigation Class Ids\",\r\n    resultType: \"CheckNavClassIdsResultRow\",\r\n    sqlCommand: \"check_nav_class_ids\",\r\n    sqlQuery: `PRAGMA integrity_check(check_nav_class_ids) options enable_experimental_features`,\r\n  },\r\n  checkNavigationIds: {\r\n    name: \"Check Navigation Ids\",\r\n    resultType: \"CheckNavIdsResultRow\",\r\n    sqlCommand: \"check_nav_ids\",\r\n    sqlQuery: `PRAGMA integrity_check(check_nav_ids) options enable_experimental_features`,\r\n  },\r\n  checkLinktableForeignKeyClassIds: {\r\n    name: \"Check Link Table Foreign Key Class Ids\",\r\n    resultType: \"CheckLinkTableFkClassIdsResultRow\",\r\n    sqlCommand: \"check_linktable_fk_class_ids\",\r\n    sqlQuery: `PRAGMA integrity_check(check_linktable_fk_class_ids) options enable_experimental_features`,\r\n  },\r\n  checkLinktableForeignKeyIds: {\r\n    name: \"Check Link Table Foreign Key Ids\",\r\n    resultType: \"CheckLinkTableFkIdsResultRow\",\r\n    sqlCommand: \"check_linktable_fk_ids\",\r\n    sqlQuery: `PRAGMA integrity_check(check_linktable_fk_ids) options enable_experimental_features`,\r\n  },\r\n  checkClassIds: {\r\n    name: \"Check Class Ids\",\r\n    resultType: \"CheckClassIdsResultRow\",\r\n    sqlCommand: \"check_class_ids\",\r\n    sqlQuery: `PRAGMA integrity_check(check_class_ids) options enable_experimental_features`,\r\n  },\r\n  checkDataSchema: {\r\n    name: \"Check Data Schema\",\r\n    resultType: \"CheckDataSchemaResultRow\",\r\n    sqlCommand: \"check_data_schema\",\r\n    sqlQuery: `PRAGMA integrity_check(check_data_schema) options enable_experimental_features`,\r\n  },\r\n  checkSchemaLoad: {\r\n    name: \"Check Schema Load\",\r\n    resultType: \"CheckSchemaLoadResultRow\",\r\n    sqlCommand: \"check_schema_load\",\r\n    sqlQuery: `PRAGMA integrity_check(check_schema_load) options enable_experimental_features`,\r\n  },\r\n  checkMissingChildRows: {\r\n    name: \"Check Missing Child Rows\",\r\n    resultType: \"CheckMissingChildRowsResultRow\",\r\n    sqlCommand: \"check_missing_child_rows\",\r\n    sqlQuery: `PRAGMA integrity_check(check_missing_child_rows) options enable_experimental_features`,\r\n  },\r\n} as const;\r\n\r\n/**\r\n * Type representing the keys of the integrityCheckType map, which correspond to the different types of integrity checks that can be performed.\r\n */\r\nexport type IntegrityCheckKey = keyof typeof integrityCheckTypeMap;\r\n\r\n/** Map of integrity check keys to their result row types */\r\ninterface IntegrityCheckResultTypeMap {\r\n  checkDataColumns: CheckDataColumnsResultRow;\r\n  checkECProfile: CheckECProfileResultRow;\r\n  checkNavigationClassIds: CheckNavClassIdsResultRow;\r\n  checkNavigationIds: CheckNavIdsResultRow;\r\n  checkLinktableForeignKeyClassIds: CheckLinkTableFkClassIdsResultRow;\r\n  checkLinktableForeignKeyIds: CheckLinkTableFkIdsResultRow;\r\n  checkClassIds: CheckClassIdsResultRow;\r\n  checkDataSchema: CheckDataSchemaResultRow;\r\n  checkSchemaLoad: CheckSchemaLoadResultRow;\r\n  checkMissingChildRows: CheckMissingChildRowsResultRow;\r\n}\r\n\r\n/** Checks the Map to give the return type of a specific integrity check */\r\ntype IntegrityCheckResultRow<K extends IntegrityCheckKey> = IntegrityCheckResultTypeMap[K];\r\n\r\n/**\r\n * Return type for quick integrity check\r\n */\r\nexport interface QuickIntegrityCheckResultRow {\r\n  check: string;\r\n  passed: boolean;\r\n  elapsedSeconds: string;\r\n}\r\n\r\n/**\r\n * Return type for Check Data Columns integrity check\r\n */\r\nexport interface CheckDataColumnsResultRow {\r\n  sno: number;\r\n  table: string;\r\n  column: string;\r\n}\r\n\r\n/**\r\n * Return type for Check EC Profile integrity check\r\n */\r\nexport interface CheckECProfileResultRow {\r\n  sno: number;\r\n  type: string;\r\n  name: string;\r\n  issue: string;\r\n}\r\n\r\n/**\r\n * Return type for Check Navigation Class Ids integrity check\r\n */\r\nexport interface CheckNavClassIdsResultRow {\r\n  sno: number;\r\n  id: string;\r\n  class: string;\r\n  property: string;\r\n  navId: string;\r\n  navClassId: string;\r\n}\r\n\r\n/**\r\n * Return type for Check Navigation Ids integrity check\r\n */\r\nexport interface CheckNavIdsResultRow {\r\n  sno: number;\r\n  id: string;\r\n  class: string;\r\n  property: string;\r\n  navId: string;\r\n  primaryClass: string;\r\n}\r\n\r\n/**\r\n * Return type for Check Link Table Foreign Key Class Ids integrity check\r\n */\r\nexport interface CheckLinkTableFkClassIdsResultRow {\r\n  sno: number;\r\n  id: string;\r\n  relationship: string;\r\n  property: string;\r\n  keyId: string;\r\n  keyClassId: string;\r\n}\r\n\r\n/**\r\n * Return type for Check Link Table Foreign Key Ids integrity check\r\n */\r\nexport interface CheckLinkTableFkIdsResultRow {\r\n  sno: number;\r\n  id: string;\r\n  relationship: string;\r\n  property: string;\r\n  keyId: string;\r\n  primaryClass: string;\r\n}\r\n\r\n/**\r\n * Return type for Check Class Ids integrity check\r\n */\r\nexport interface CheckClassIdsResultRow {\r\n  sno: number;\r\n  class: string;\r\n  id: string;\r\n  classId: string;\r\n  type: string;\r\n}\r\n\r\n/**\r\n * Return type for Check Data Schema integrity check\r\n */\r\nexport interface CheckDataSchemaResultRow {\r\n  sno: number;\r\n  type: string;\r\n  name: string;\r\n}\r\n\r\n/**\r\n * Return type for Check Schema Load integrity check\r\n */\r\nexport interface CheckSchemaLoadResultRow {\r\n  sno: number;\r\n  schema: string;\r\n}\r\n\r\n/**\r\n * Return type for Check Missing Child Rows integrity check\r\n */\r\nexport interface CheckMissingChildRowsResultRow {\r\n  sno: number;\r\n  class: string;\r\n  id: string;\r\n  classId: string;\r\n  missingRowInTables: string;\r\n}\r\n\r\n/**\r\n * Return type for integrity check results, including the check name, whether it passed, and the specific results (if any)\r\n */\r\nexport interface IntegrityCheckResult {\r\n  /** The name of the integrity check that was performed */\r\n  check: string;\r\n  /** Whether the integrity check passed (i.e. no issues were found = true) */\r\n  passed: boolean;\r\n  /** The specific results returned by the integrity check, which may include details about any issues that were found.\r\n   * In the case where issues are found, this will be an array of result rows specific to the type of check that was performed,\r\n   * or an array of quick integrity check results if it was a quick check. */\r\n  results: IntegrityCheckResultRow<IntegrityCheckKey>[] | QuickIntegrityCheckResultRow[];\r\n}\r\n\r\n/**\r\n * Gets the user-friendly name of an integrity check based on its key or SQL command.\r\n * It first attempts to find a direct match for the key in the integrityCheckTypeMap. If not found, it searches for a match based on the SQL command.\r\n * If still not found, it returns the original check string.\r\n * @param check - The integrity check key or SQL command to get the name of\r\n * @returns The user-friendly name of the integrity check, or the original check string if no match is found\r\n * @internal\r\n */\r\nexport function getIntegrityCheckName(check: string): string {\r\n  // First try direct lookup by key\r\n  const directLookup = integrityCheckTypeMap[check as IntegrityCheckKey];\r\n  if (directLookup) {\r\n    return directLookup.name;\r\n  }\r\n  // If not found, search by sqlCommand\r\n  for (const [, value] of Object.entries(integrityCheckTypeMap)) {\r\n    if (value.sqlCommand === check) {\r\n      return value.name;\r\n    }\r\n  }\r\n  // Fallback to the original check string\r\n  return check;\r\n}\r\n\r\n/**\r\n * Performs a quick integrity check on the given iModel.\r\n * @param iModel The IModelDb instance to perform the integrity check on\r\n * @returns An array of results for each check performed, including the check name, whether it passed, and the elapsed time in seconds\r\n * @internal\r\n */\r\nexport async function performQuickIntegrityCheck(iModel: IModelDb): Promise<QuickIntegrityCheckResultRow[]> {\r\n  const integrityCheckQuery = \"PRAGMA integrity_check options enable_experimental_features\";\r\n  const integrityCheckResults: QuickIntegrityCheckResultRow[] = [];\r\n  for await (const row of iModel.createQueryReader(integrityCheckQuery)) {\r\n    integrityCheckResults.push({ check: getIntegrityCheckName(row.check), passed: row.result, elapsedSeconds: row.elapsed_sec});\r\n  };\r\n  return integrityCheckResults;\r\n}\r\n\r\n/**\r\n * Performs a specific integrity check on the given iModel based on the provided check key, and returns the results specific to that check type.\r\n * @param iModel The IModelDb instance to perform the integrity check on\r\n * @param check The key of the specific integrity check to perform\r\n * @return An array of results specific to the integrity check that was performed. The type of the result rows will depend on the check that was executed.\r\n * @throws IModelError with status BadRequest if an unknown integrity check key is provided\r\n * @internal\r\n */\r\nexport async function performSpecificIntegrityCheck(iModel: IModelDb, check: \"checkDataColumns\"): Promise<IntegrityCheckResultRow<\"checkDataColumns\">[]>;\r\nexport async function performSpecificIntegrityCheck(iModel: IModelDb, check: \"checkECProfile\"): Promise<IntegrityCheckResultRow<\"checkECProfile\">[]>;\r\nexport async function performSpecificIntegrityCheck(iModel: IModelDb, check: \"checkNavigationClassIds\"): Promise<IntegrityCheckResultRow<\"checkNavigationClassIds\">[]>;\r\nexport async function performSpecificIntegrityCheck(iModel: IModelDb, check: \"checkNavigationIds\"): Promise<IntegrityCheckResultRow<\"checkNavigationIds\">[]>;\r\nexport async function performSpecificIntegrityCheck(iModel: IModelDb, check: \"checkLinktableForeignKeyClassIds\"): Promise<IntegrityCheckResultRow<\"checkLinktableForeignKeyClassIds\">[]>;\r\nexport async function performSpecificIntegrityCheck(iModel: IModelDb, check: \"checkLinktableForeignKeyIds\"): Promise<IntegrityCheckResultRow<\"checkLinktableForeignKeyIds\">[]>;\r\nexport async function performSpecificIntegrityCheck(iModel: IModelDb, check: \"checkClassIds\"): Promise<IntegrityCheckResultRow<\"checkClassIds\">[]>;\r\nexport async function performSpecificIntegrityCheck(iModel: IModelDb, check: \"checkDataSchema\"): Promise<IntegrityCheckResultRow<\"checkDataSchema\">[]>;\r\nexport async function performSpecificIntegrityCheck(iModel: IModelDb, check: \"checkSchemaLoad\"): Promise<IntegrityCheckResultRow<\"checkSchemaLoad\">[]>;\r\nexport async function performSpecificIntegrityCheck(iModel: IModelDb, check: \"checkMissingChildRows\"): Promise<IntegrityCheckResultRow<\"checkMissingChildRows\">[]>;\r\nexport async function performSpecificIntegrityCheck<K extends IntegrityCheckKey>(iModel: IModelDb, check: K): Promise<IntegrityCheckResultRow<K>[]>;\r\nexport async function performSpecificIntegrityCheck(iModel: IModelDb, check: IntegrityCheckKey): Promise<IntegrityCheckResultRow<IntegrityCheckKey>[]> {\r\n  switch (check) {\r\n    case \"checkDataColumns\": {\r\n      const results: CheckDataColumnsResultRow[] = [];\r\n      for await (const row of iModel.createQueryReader(integrityCheckTypeMap.checkDataColumns.sqlQuery)) {\r\n        results.push({ sno: row.sno, table: row.table, column: row.column });\r\n      }\r\n      return results;\r\n    }\r\n    case \"checkECProfile\": {\r\n      const results: CheckECProfileResultRow[] = [];\r\n      for await (const row of iModel.createQueryReader(integrityCheckTypeMap.checkECProfile.sqlQuery)) {\r\n        results.push({ sno: row.sno, type: row.type, name: row.name, issue: row.issue });\r\n      }\r\n      return results;\r\n    }\r\n    case \"checkNavigationClassIds\": {\r\n      const results: CheckNavClassIdsResultRow[] = [];\r\n      for await (const row of iModel.createQueryReader(integrityCheckTypeMap.checkNavigationClassIds.sqlQuery)) {\r\n        results.push({ sno: row.sno, id: row.id, class: row.class, property: row.property, navId: row.nav_id, navClassId: row.nav_classId });\r\n      }\r\n      return results;\r\n    }\r\n    case \"checkNavigationIds\": {\r\n      const results: CheckNavIdsResultRow[] = [];\r\n      for await (const row of iModel.createQueryReader(integrityCheckTypeMap.checkNavigationIds.sqlQuery)) {\r\n        results.push({ sno: row.sno, id: row.id, class: row.class, property: row.property, navId: row.nav_id, primaryClass: row.primary_class });\r\n      }\r\n      return results;\r\n    }\r\n    case \"checkLinktableForeignKeyClassIds\": {\r\n      const results: CheckLinkTableFkClassIdsResultRow[] = [];\r\n      for await (const row of iModel.createQueryReader(integrityCheckTypeMap.checkLinktableForeignKeyClassIds.sqlQuery)) {\r\n        results.push({ sno: row.sno, id: row.id, relationship: row.relationship, property: row.property, keyId: row.key_id, keyClassId: row.key_classId });\r\n      }\r\n      return results;\r\n    }\r\n    case \"checkLinktableForeignKeyIds\": {\r\n      const results: CheckLinkTableFkIdsResultRow[] = [];\r\n      for await (const row of iModel.createQueryReader(integrityCheckTypeMap.checkLinktableForeignKeyIds.sqlQuery)) {\r\n        results.push({ sno: row.sno, id: row.id, relationship: row.relationship, property: row.property, keyId: row.key_id, primaryClass: row.primary_class });\r\n      }\r\n      return results;\r\n    }\r\n    case \"checkClassIds\": {\r\n      const results: CheckClassIdsResultRow[] = [];\r\n      for await (const row of iModel.createQueryReader(integrityCheckTypeMap.checkClassIds.sqlQuery)) {\r\n        results.push({ sno: row.sno, class: row.class, id: row.id, classId: row.class_id, type: row.type });\r\n      }\r\n      return results;\r\n    }\r\n    case \"checkDataSchema\": {\r\n      const results: CheckDataSchemaResultRow[] = [];\r\n      for await (const row of iModel.createQueryReader(integrityCheckTypeMap.checkDataSchema.sqlQuery)) {\r\n        results.push({ sno: row.sno, type: row.type, name: row.name });\r\n      }\r\n      return results;\r\n    }\r\n    case \"checkSchemaLoad\": {\r\n      const results: CheckSchemaLoadResultRow[] = [];\r\n      for await (const row of iModel.createQueryReader(integrityCheckTypeMap.checkSchemaLoad.sqlQuery)) {\r\n        results.push({ sno: row.sno, schema: row.schema });\r\n      }\r\n      return results;\r\n    }\r\n    case \"checkMissingChildRows\": {\r\n      const results: CheckMissingChildRowsResultRow[] = [];\r\n      for await (const row of iModel.createQueryReader(integrityCheckTypeMap.checkMissingChildRows.sqlQuery)) {\r\n        results.push({ sno: row.sno, class: row.class, id: row.id, classId: row.class_id, missingRowInTables: row.MissingRowInTables });\r\n      }\r\n      return results;\r\n    }\r\n    default:\r\n      throw new IModelError(IModelStatus.BadRequest, `Unknown integrity check type: ${check}`);\r\n  }\r\n}"]}

package/lib/esm/IModelDb.d.ts

@@ -34,6 +34,7 @@ import { _cache, _instanceKeyCache, _nativeDb, _resetIModelDb } from "./internal
 import { ECVersion, SchemaContext } from "@itwin/ecschema-metadata";
 import { SchemaMap } from "./Schema";
 import { ElementLRUCache, InstanceKeyLRUCache } from "./internal/ElementLRUCache";
+import { IntegrityCheckResult } from "./internal/IntegrityCheck";
 /** Options for [[IModelDb.Models.updateModel]]
  * @note To mark *only* the geometry as changed, use [[IModelDb.Models.updateGeometryGuid]] instead.
  * @public
@@ -82,6 +83,37 @@ export interface ComputedProjectExtents {
     /** If requested by caller, the Ids of outlier elements excluded from the computed extents. */
     outliers?: Id64Array;
 }
+/**
+ * Options for performing integrity checks on an iModel.
+ * @beta
+ */
+export interface IntegrityCheckOptions {
+    /** If true, perform a quick integrity check that only reports whether each check passed or failed, without detailed results. */
+    quickCheck?: boolean;
+    /** Options for performing specific integrity checks with detailed results. */
+    specificChecks?: {
+        /** If true, checks if all the required columns exist in data tables. Issues are returned as a list of those tables/columns. */
+        checkDataColumns?: boolean;
+        /** If true, checks if the profile table, indexes, and triggers are present. Does not check be_* tables. Issues are returned as a list of tables/indexes/triggers which were not found or have different DDL. */
+        checkECProfile?: boolean;
+        /** If true, checks if RelClassId of a Navigation property is a valid ECClassId. It does not check the value to match the relationship class. */
+        checkNavigationClassIds?: boolean;
+        /** If true, checks if Id of a Navigation property matches a valid row primary class. */
+        checkNavigationIds?: boolean;
+        /** If true, checks if SourceECClassId or TargetECClassId of a link table matches a valid ECClassId. */
+        checkLinktableForeignKeyClassIds?: boolean;
+        /** If true, checks if SourceECInstanceId or TargetECInstanceId of a link table matches a valid row in primary class. */
+        checkLinktableForeignKeyIds?: boolean;
+        /** If true, checks persisted ECClassId in all data tables and makes sure they are valid. */
+        checkClassIds?: boolean;
+        /** If true, checks if all the required data tables and indexes exist for mapped classes. Issues are returned as a list of tables/columns which were not found or have different DDL. */
+        checkDataSchema?: boolean;
+        /** If true, checks if all schemas can be loaded into memory. */
+        checkSchemaLoad?: boolean;
+        /** If true, checks if all child rows have a corresponding parent row. */
+        checkMissingChildRows?: boolean;
+    };
+}
 /**
  * Options for the importing of schemas
  * @public
@@ -385,6 +417,31 @@ export declare abstract class IModelDb extends IModel {
      * @beta
      */
     analyze(): void;
+    /**
+     * Performs integrity checks on this iModel.
+     * Types of integrity checks that can be performed are:
+     *
+     * Default Check:
+     * - Quick Check: Runs all integrity checks below and returns whether each check passed or failed, without detailed results.
+     *
+     * Specific Checks:
+     * - Data Columns Check: Checks if all the required columns exist in data tables. Issues are returned as a list of those tables/columns.
+     * - EC Profile Check: Checks if the profile table, indexes, and triggers are present. Does not check be_* tables. Issues are returned as a list of tables/indexes/triggers which were not found or have different DDL.
+     * - Navigation Class Ids Check: Checks if RelClassId of a Navigation property is a valid ECClassId. It does not check the value to match the relationship class.
+     * - Navigation Ids Check: Checks if Id of a Navigation property matches a valid row primary class.
+     * - Linktable Foreign Key Class Ids Check: Checks if SourceECClassId or TargetECClassId of a link table matches a valid ECClassId.
+     * - Linktable Foreign Key Ids Check: Checks if SourceECInstanceId or TargetECInstanceId of a link table matches a valid row in primary class.
+     * - Class Ids Check: Checks persisted ECClassId in all data tables and makes sure they are valid.
+     * - Data Schema Check: Checks if all the required data tables and indexes exist for mapped classes. Issues are returned as a list of tables/columns which were not found or have different DDL.
+     * - Schema Load Check: Checks if all schemas can be loaded into memory.
+     * - Missing Child Rows Check: Checks if all child rows have a corresponding parent row.
+     *
+     * @param options Options specifying which integrity checks to perform. If no options are provided or all options are false, a quick check will be performed by default.
+     * @returns An array of integrity check results.
+     * @throws [[IModelError]] if the iModel is not open.
+     * @beta
+     */
+    integrityCheck(options?: IntegrityCheckOptions): Promise<IntegrityCheckResult[]>;
     /** @internal */
     refreshContainerForRpc(_userAccessToken: AccessToken): Promise<void>;
     /** Event called when the iModel is about to be closed. */