@itwin/ecschema-metadata 5.1.0-dev.9 → 5.1.0

package/lib/cjs/IncrementalLoading/ECSqlSchemaLocater.d.ts

@@ -0,0 +1,211 @@
+import { SchemaContext } from "../Context";
+import { ConstantProps, CustomAttributeClassProps, EntityClassProps, EnumerationProps, InvertedUnitProps, KindOfQuantityProps, MixinProps, PhenomenonProps, PropertyCategoryProps, RelationshipClassProps, SchemaItemFormatProps, SchemaItemUnitProps, SchemaProps, StructClassProps, UnitSystemProps } from "../Deserialization/JsonProps";
+import { SchemaInfo } from "../Interfaces";
+import { SchemaKey } from "../SchemaKey";
+import { IncrementalSchemaLocater, SchemaLocaterOptions } from "./IncrementalSchemaLocater";
+import { PerformanceLogger } from "./PerformanceLogger";
+interface QueryParameters {
+    [parameterName: string]: string | number;
+}
+/**
+ * Query options used by the ECSqlSchemaLocater.
+ * @internal
+ */
+export interface ECSqlQueryOptions {
+    parameters?: QueryParameters;
+    limit?: number;
+}
+/**
+ * Defines the [[ECSqlSchemaLocater]] options which determine how each
+ * schema is to be loaded. All options are optional.
+ * @internal
+ */
+export interface ECSqlSchemaLocaterOptions extends SchemaLocaterOptions {
+    /** Query for Schemas using multiple queries. Defaults to false. */
+    readonly useMultipleQueries?: boolean;
+    /** Collects query execution performance data. Defaults to false. */
+    readonly performanceLogger?: PerformanceLogger;
+}
+/**
+ * An abstract [[IncrementalSchemaLocater]] implementation for loading
+ * EC [Schema] instances from an iModelDb using ECSql queries.
+ * @internal
+ */
+export declare abstract class ECSqlSchemaLocater extends IncrementalSchemaLocater {
+    /**
+     * Gets the [[ECSqlSchemaLocaterOptions]] used by this locater.
+     */
+    protected get options(): ECSqlSchemaLocaterOptions;
+    /**
+     * Initializes a new ECSqlSchemaLocater instance.
+     * @param options The options used by this Schema locater.
+     */
+    constructor(options?: ECSqlSchemaLocaterOptions);
+    /**
+     * Executes the given ECSql query and returns the resulting rows.
+     * @param query   The ECSql query to execute.
+     * @param options Optional arguments to control the query result.
+     * @returns       A promise that resolves to the resulting rows.
+     */
+    protected abstract executeQuery<TRow>(query: string, options?: ECSqlQueryOptions): Promise<ReadonlyArray<TRow>>;
+    /**
+     * Gets the [[SchemaProps]] for the given schema key.
+     * @param schemaKey The schema key of the schema to be resolved.
+     */
+    protected abstract getSchemaProps(schemaKey: SchemaKey): Promise<SchemaProps | undefined>;
+    /**
+     * Gets the [[SchemaProps]] for the given schema key. This is the full schema json with all elements that are defined
+     * in the schema. The schema locater calls this after the stub has been loaded to fully load the schema in the background.
+     * @param schemaKey   The [[SchemaKey]] of the schema to be resolved.
+     * @param context     The [[SchemaContext]] to use for resolving references.
+     * @internal
+     */
+    getSchemaJson(schemaKey: SchemaKey, context: SchemaContext): Promise<SchemaProps | undefined>;
+    /**
+     * Gets the [[SchemaProps]] without schemaItems.
+     */
+    /**
+     * Gets the [[SchemaProps]] without schemaItems for the given schema name.
+     * @param schemaName The name of the Schema.
+     * @param context The [[SchemaContext]] to use for resolving references.
+     * @returns
+     * @internal
+     */
+    getSchemaNoItems(schemaName: string, context: SchemaContext): Promise<SchemaProps | undefined>;
+    /**
+     * Checks if the [[SchemaContext]] has the right Meta Schema version to support the incremental schema loading.
+     * @param context   The schema context to lookup the meta schema.
+     * @returns         true if the context has a supported meta schema version, false otherwise.
+     */
+    protected supportPartialSchemaLoading(context: SchemaContext): Promise<boolean>;
+    /**
+     * Gets all the Schema's Entity classes as [[EntityClassProps]] JSON objects.
+     * @param schemaName The name of the Schema.
+     * @param context The [[SchemaContext]] to which the schema belongs.
+     * @returns A promise that resolves to a EntityClassProps array. Maybe empty of no entities are found.
+     * @internal
+     */
+    getEntities(schema: string, context: SchemaContext, queryOverride?: string): Promise<EntityClassProps[]>;
+    /**
+     * Gets all the Schema's Mixin classes as [[MixinProps]] JSON objects.
+     * @param schemaName The name of the Schema.
+     * @param context The SchemaContext to which the schema belongs.
+     * @returns A promise that resolves to a MixinProps array. Maybe empty of no entities are found.
+     * @internal
+     */
+    getMixins(schema: string, context: SchemaContext, queryOverride?: string): Promise<MixinProps[]>;
+    /**
+     * Gets all the Schema's Relationship classes as [[RelationshipClassProps]] JSON objects.
+     * @param schemaName The name of the Schema.
+     * @param context The SchemaContext to which the schema belongs.
+     * @returns A promise that resolves to a RelationshipClassProps array. Maybe empty if no items are found.
+     * @internal
+     */
+    getRelationships(schema: string, context: SchemaContext, queryOverride?: string): Promise<RelationshipClassProps[]>;
+    /**
+     * Gets all the Schema's CustomAttributeClass items as [[CustomAttributeClassProps]] JSON objects.
+     * @param schemaName The name of the Schema.
+     * @param context The SchemaContext to which the schema belongs.
+     * @returns A promise that resolves to a CustomAttributeClassProps array. Maybe empty if not items are found.
+     * @internal
+     */
+    getCustomAttributeClasses(schema: string, context: SchemaContext, queryOverride?: string): Promise<CustomAttributeClassProps[]>;
+    /**
+     * Gets all the Schema's StructClass items as [[StructClassProps]] JSON objects.
+     * @param schemaName The name of the Schema.
+     * @param context The SchemaContext to which the schema belongs.
+     * @returns A promise that resolves to a StructClassProps array. Maybe empty if not items are found.
+     * @internal
+     */
+    getStructs(schema: string, context: SchemaContext, queryOverride?: string): Promise<StructClassProps[]>;
+    /**
+     * Gets all the Schema's KindOfQuantity items as [[KindOfQuantityProps]] JSON objects.
+     * @param schema The name of the Schema.
+     * @param context The SchemaContext to which the schema belongs.
+     * @returns A promise that resolves to a KindOfQuantityProps array. Maybe empty if not items are found.
+     * @internal
+     */
+    getKindOfQuantities(schema: string, context: SchemaContext): Promise<KindOfQuantityProps[]>;
+    /**
+     * Gets all the Schema's PropertyCategory items as [[PropertyCategoryProps]] JSON objects.
+     * @param schema The name of the Schema.
+     * @param context The SchemaContext to which the schema belongs.
+     * @returns A promise that resolves to a PropertyCategoryProps array. Maybe empty if not items are found.
+     * @internal
+     */
+    getPropertyCategories(schema: string, context: SchemaContext): Promise<PropertyCategoryProps[]>;
+    /**
+     * Gets all the Schema's Enumeration items as [[EnumerationProps]] JSON objects.
+     * @param schema The name of the Schema.
+     * @param context The SchemaContext to which the schema belongs.
+     * @returns A promise that resolves to a EnumerationProps array. Maybe empty if not items are found.
+     * @internal
+     */
+    getEnumerations(schema: string, context: SchemaContext): Promise<EnumerationProps[]>;
+    /**
+     * Gets all the Schema's Unit items as [[SchemaItemUnitProps]] JSON objects.
+     * @param schema The name of the Schema.
+     * @param context The SchemaContext to which the schema belongs.
+     * @returns A promise that resolves to a SchemaItemUnitProps array. Maybe empty if not items are found.
+     * @internal
+     */
+    getUnits(schema: string, context: SchemaContext): Promise<SchemaItemUnitProps[]>;
+    /**
+     * Gets all the Schema's InvertedUnit items as [[InvertedUnitProps]] JSON objects.
+     * @param schema The name of the Schema.
+     * @param context The SchemaContext to which the schema belongs.
+     * @returns A promise that resolves to a InvertedUnitProps array. Maybe empty if not items are found.
+     * @internal
+     */
+    getInvertedUnits(schema: string, context: SchemaContext): Promise<InvertedUnitProps[]>;
+    /**
+     * Gets all the Schema's Constant items as [[ConstantProps]] JSON objects.
+     * @param schema The name of the Schema.
+     * @param context The SchemaContext to which the schema belongs.
+     * @returns A promise that resolves to a ConstantProps array. Maybe empty if not items are found.
+     * @internal
+     */
+    getConstants(schema: string, context: SchemaContext): Promise<ConstantProps[]>;
+    /**
+     * Gets all the Schema's UnitSystem items as [[UnitSystemProps]] JSON objects.
+     * @param schema The name of the Schema.
+     * @param context The SchemaContext to which the schema belongs.
+     * @returns A promise that resolves to a UnitSystemProps array. Maybe empty if not items are found.
+     * @internal
+     */
+    getUnitSystems(schema: string, context: SchemaContext): Promise<UnitSystemProps[]>;
+    /**
+     * Gets all the Schema's Phenomenon items as [[PhenomenonProps]] JSON objects.
+     * @param schema The name of the Schema.
+     * @param context The SchemaContext to which the schema belongs.
+     * @returns A promise that resolves to a PhenomenonProps array. Maybe empty if not items are found.
+     * @internal
+     */
+    getPhenomenon(schema: string, context: SchemaContext): Promise<PhenomenonProps[]>;
+    /**
+     * Gets all the Schema's Format items as [[SchemaItemFormatProps]] JSON objects.
+     * @param schema The name of the Schema.
+     * @param context The SchemaContext to which the schema belongs.
+     * @returns A promise that resolves to a SchemaItemFormatProps array. Maybe empty if not items are found.
+     * @internal
+     */
+    getFormats(schema: string, context: SchemaContext): Promise<SchemaItemFormatProps[]>;
+    /**
+     * Gets [[SchemaInfo]] objects for all schemas including their direct schema references.
+     * @internal
+     */
+    loadSchemaInfos(): Promise<ReadonlyArray<SchemaInfo>>;
+    /**
+     * Gets the [[SchemaProps]] to create the basic schema skeleton. Depending on which options are set, the schema items or class hierarchy
+     * can be included in the initial fetch.
+     * @param schemaKey The [[SchemaKey]] of the schema to be resolved.
+     * @returns A promise that resolves to the schema partials, which is an array of [[SchemaProps]].
+     * @internal
+     */
+    getSchemaPartials(schemaKey: SchemaKey, context: SchemaContext): Promise<ReadonlyArray<SchemaProps> | undefined>;
+    private querySchemaItem;
+    private getFullSchema;
+    private getFullSchemaMultipleQueries;
+}
+export {};
+//# sourceMappingURL=ECSqlSchemaLocater.d.ts.map

package/lib/cjs/IncrementalLoading/ECSqlSchemaLocater.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ECSqlSchemaLocater.d.ts","sourceRoot":"","sources":["../../../src/IncrementalLoading/ECSqlSchemaLocater.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AAC3C,OAAO,EAAE,aAAa,EAAE,yBAAyB,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,iBAAiB,EAAE,mBAAmB,EAAE,UAAU,EACvI,eAAe,EAAE,qBAAqB,EAAE,sBAAsB,EAAE,qBAAqB,EAAmB,mBAAmB,EAAE,WAAW,EACxI,gBAAgB,EAAE,eAAe,EAAE,MAAM,8BAA8B,CAAC;AAE1E,OAAO,EAAE,UAAU,EAAiB,MAAM,eAAe,CAAC;AAC1D,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AAEzC,OAAO,EAAE,wBAAwB,EAAE,oBAAoB,EAAE,MAAM,4BAA4B,CAAC;AAC5F,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AA8DxD,UAAU,eAAe;IACvB,CAAC,aAAa,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;CAC1C;AAED;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IAChC,UAAU,CAAC,EAAE,eAAe,CAAC;IAC7B,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;;;GAIG;AACH,MAAM,WAAW,yBAA0B,SAAQ,oBAAoB;IACrE,mEAAmE;IACnE,QAAQ,CAAC,kBAAkB,CAAC,EAAE,OAAO,CAAC;IACtC,oEAAoE;IACpE,QAAQ,CAAC,iBAAiB,CAAC,EAAE,iBAAiB,CAAC;CAChD;AAED;;;;GAIG;AACH,8BAAsB,kBAAmB,SAAQ,wBAAwB;IACvE;;OAEG;IACH,cAAuB,OAAO,IAAI,yBAAyB,CAE1D;IAED;;;OAGG;gBACS,OAAO,CAAC,EAAE,yBAAyB;IAI/C;;;;;OAKG;IACH,SAAS,CAAC,QAAQ,CAAC,YAAY,CAAC,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,iBAAiB,GAAG,OAAO,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;IAE/G;;;OAGG;IACH,SAAS,CAAC,QAAQ,CAAC,cAAc,CAAC,SAAS,EAAE,SAAS,GAAG,OAAO,CAAC,WAAW,GAAG,SAAS,CAAC;IAEzF;;;;;;OAMG;IACU,aAAa,CAAC,SAAS,EAAE,SAAS,EAAE,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,WAAW,GAAG,SAAS,CAAC;IAiB1G;;OAEG;IACH;;;;;;OAMG;IACU,gBAAgB,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,WAAW,GAAG,SAAS,CAAC;IAU3G;;;;OAIG;cACa,2BAA2B,CAAC,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,OAAO,CAAC;IAMrF;;;;;;OAMG;IACU,WAAW,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,aAAa,EAAE,aAAa,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,gBAAgB,EAAE,CAAC;IAKrH;;;;;;OAMG;IACU,SAAS,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,aAAa,EAAE,aAAa,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,EAAE,CAAC;IAK7G;;;;;;OAMG;IACU,gBAAgB,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,aAAa,EAAE,aAAa,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,sBAAsB,EAAE,CAAC;IAKhI;;;;;;OAMG;IACU,yBAAyB,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,aAAa,EAAE,aAAa,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,yBAAyB,EAAE,CAAC;IAM5I;;;;;;OAMG;IACU,UAAU,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,aAAa,EAAE,aAAa,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,gBAAgB,EAAE,CAAC;IAKpH;;;;;;OAMG;IACU,mBAAmB,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,mBAAmB,EAAE,CAAC;IAIxG;;;;;;OAMG;IACU,qBAAqB,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,qBAAqB,EAAE,CAAC;IAI5G;;;;;;OAMG;IACU,eAAe,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,gBAAgB,EAAE,CAAC;IAIjG;;;;;;OAMG;IACU,QAAQ,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,mBAAmB,EAAE,CAAC;IAI7F;;;;;;OAMG;IACU,gBAAgB,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,iBAAiB,EAAE,CAAC;IAInG;;;;;;OAMG;IACU,YAAY,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,aAAa,EAAE,CAAC;IAI3F;;;;;;OAMG;IACU,cAAc,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,eAAe,EAAE,CAAC;IAI/F;;;;;;OAMG;IACU,aAAa,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,eAAe,EAAE,CAAC;IAI9F;;;;;;OAMG;IACU,UAAU,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,qBAAqB,EAAE,CAAC;IAIjG;;;OAGG;IACU,eAAe,IAAI,OAAO,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC;IAWlE;;;;;;OAMG;IACU,iBAAiB,CAAC,SAAS,EAAE,SAAS,EAAE,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,aAAa,CAAC,WAAW,CAAC,GAAG,SAAS,CAAC;YAqD/G,eAAe;YAef,aAAa;YAeb,4BAA4B;CA8B3C"}

package/lib/cjs/IncrementalLoading/ECSqlSchemaLocater.js

@@ -0,0 +1,387 @@
+"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.ECSqlSchemaLocater = void 0;
+const ECObjects_1 = require("../ECObjects");
+const SchemaKey_1 = require("../SchemaKey");
+const FullSchemaQueries_1 = require("./FullSchemaQueries");
+const IncrementalSchemaLocater_1 = require("./IncrementalSchemaLocater");
+const SchemaItemQueries_1 = require("./SchemaItemQueries");
+const SchemaParser_1 = require("./SchemaParser");
+const SchemaStubQueries_1 = require("./SchemaStubQueries");
+/**
+ * An abstract [[IncrementalSchemaLocater]] implementation for loading
+ * EC [Schema] instances from an iModelDb using ECSql queries.
+ * @internal
+ */
+class ECSqlSchemaLocater extends IncrementalSchemaLocater_1.IncrementalSchemaLocater {
+    /**
+     * Gets the [[ECSqlSchemaLocaterOptions]] used by this locater.
+     */
+    get options() {
+        return super.options;
+    }
+    /**
+     * Initializes a new ECSqlSchemaLocater instance.
+     * @param options The options used by this Schema locater.
+     */
+    constructor(options) {
+        super(options);
+    }
+    /**
+     * Gets the [[SchemaProps]] for the given schema key. This is the full schema json with all elements that are defined
+     * in the schema. The schema locater calls this after the stub has been loaded to fully load the schema in the background.
+     * @param schemaKey   The [[SchemaKey]] of the schema to be resolved.
+     * @param context     The [[SchemaContext]] to use for resolving references.
+     * @internal
+     */
+    async getSchemaJson(schemaKey, context) {
+        // If the meta schema is an earlier version than 4.0.3, we can't use the ECSql query interface to get the schema
+        // information required to load the schema entirely. In this case, we fallback to use the ECSchema RPC interface
+        // to fetch the whole schema json.
+        if (!await this.supportPartialSchemaLoading(context))
+            return this.getSchemaProps(schemaKey);
+        const start = Date.now();
+        const schemaProps = this.options.useMultipleQueries
+            ? await this.getFullSchemaMultipleQueries(schemaKey, context)
+            : await this.getFullSchema(schemaKey, context);
+        this.options.performanceLogger?.logSchema(start, schemaKey.name);
+        return schemaProps;
+    }
+    ;
+    /**
+     * Gets the [[SchemaProps]] without schemaItems.
+     */
+    /**
+     * Gets the [[SchemaProps]] without schemaItems for the given schema name.
+     * @param schemaName The name of the Schema.
+     * @param context The [[SchemaContext]] to use for resolving references.
+     * @returns
+     * @internal
+     */
+    async getSchemaNoItems(schemaName, context) {
+        const schemaRows = await this.executeQuery(FullSchemaQueries_1.FullSchemaQueries.schemaNoItemsQuery, { parameters: { schemaName } });
+        const schemaRow = schemaRows[0];
+        if (schemaRow === undefined)
+            return undefined;
+        const schema = JSON.parse(schemaRow.schema);
+        return SchemaParser_1.SchemaParser.parse(schema, context);
+    }
+    /**
+     * Checks if the [[SchemaContext]] has the right Meta Schema version to support the incremental schema loading.
+     * @param context   The schema context to lookup the meta schema.
+     * @returns         true if the context has a supported meta schema version, false otherwise.
+     */
+    async supportPartialSchemaLoading(context) {
+        const metaSchemaKey = new SchemaKey_1.SchemaKey("ECDbMeta", 4, 0, 3);
+        const metaSchemaInfo = await context.getSchemaInfo(metaSchemaKey, ECObjects_1.SchemaMatchType.LatestWriteCompatible);
+        return metaSchemaInfo !== undefined;
+    }
+    ;
+    /**
+     * Gets all the Schema's Entity classes as [[EntityClassProps]] JSON objects.
+     * @param schemaName The name of the Schema.
+     * @param context The [[SchemaContext]] to which the schema belongs.
+     * @returns A promise that resolves to a EntityClassProps array. Maybe empty of no entities are found.
+     * @internal
+     */
+    async getEntities(schema, context, queryOverride) {
+        const query = queryOverride ?? FullSchemaQueries_1.FullSchemaQueries.entityQuery;
+        return this.querySchemaItem(context, schema, query, "EntityClass");
+    }
+    /**
+     * Gets all the Schema's Mixin classes as [[MixinProps]] JSON objects.
+     * @param schemaName The name of the Schema.
+     * @param context The SchemaContext to which the schema belongs.
+     * @returns A promise that resolves to a MixinProps array. Maybe empty of no entities are found.
+     * @internal
+     */
+    async getMixins(schema, context, queryOverride) {
+        const query = queryOverride ?? FullSchemaQueries_1.FullSchemaQueries.mixinQuery;
+        return this.querySchemaItem(context, schema, query, "Mixin");
+    }
+    /**
+     * Gets all the Schema's Relationship classes as [[RelationshipClassProps]] JSON objects.
+     * @param schemaName The name of the Schema.
+     * @param context The SchemaContext to which the schema belongs.
+     * @returns A promise that resolves to a RelationshipClassProps array. Maybe empty if no items are found.
+     * @internal
+     */
+    async getRelationships(schema, context, queryOverride) {
+        const query = queryOverride ?? FullSchemaQueries_1.FullSchemaQueries.relationshipClassQuery;
+        return this.querySchemaItem(context, schema, query, "RelationshipClass");
+    }
+    /**
+     * Gets all the Schema's CustomAttributeClass items as [[CustomAttributeClassProps]] JSON objects.
+     * @param schemaName The name of the Schema.
+     * @param context The SchemaContext to which the schema belongs.
+     * @returns A promise that resolves to a CustomAttributeClassProps array. Maybe empty if not items are found.
+     * @internal
+     */
+    async getCustomAttributeClasses(schema, context, queryOverride) {
+        const query = queryOverride ?? FullSchemaQueries_1.FullSchemaQueries.customAttributeQuery;
+        return this.querySchemaItem(context, schema, query, "CustomAttributeClass");
+    }
+    /**
+     * Gets all the Schema's StructClass items as [[StructClassProps]] JSON objects.
+     * @param schemaName The name of the Schema.
+     * @param context The SchemaContext to which the schema belongs.
+     * @returns A promise that resolves to a StructClassProps array. Maybe empty if not items are found.
+     * @internal
+     */
+    async getStructs(schema, context, queryOverride) {
+        const query = queryOverride ?? FullSchemaQueries_1.FullSchemaQueries.structQuery;
+        return this.querySchemaItem(context, schema, query, "StructClass");
+    }
+    /**
+     * Gets all the Schema's KindOfQuantity items as [[KindOfQuantityProps]] JSON objects.
+     * @param schema The name of the Schema.
+     * @param context The SchemaContext to which the schema belongs.
+     * @returns A promise that resolves to a KindOfQuantityProps array. Maybe empty if not items are found.
+     * @internal
+     */
+    async getKindOfQuantities(schema, context) {
+        return this.querySchemaItem(context, schema, SchemaItemQueries_1.SchemaItemQueries.kindOfQuantity(true), "KindOfQuantity");
+    }
+    /**
+     * Gets all the Schema's PropertyCategory items as [[PropertyCategoryProps]] JSON objects.
+     * @param schema The name of the Schema.
+     * @param context The SchemaContext to which the schema belongs.
+     * @returns A promise that resolves to a PropertyCategoryProps array. Maybe empty if not items are found.
+     * @internal
+     */
+    async getPropertyCategories(schema, context) {
+        return this.querySchemaItem(context, schema, SchemaItemQueries_1.SchemaItemQueries.propertyCategory(true), "PropertyCategory");
+    }
+    /**
+     * Gets all the Schema's Enumeration items as [[EnumerationProps]] JSON objects.
+     * @param schema The name of the Schema.
+     * @param context The SchemaContext to which the schema belongs.
+     * @returns A promise that resolves to a EnumerationProps array. Maybe empty if not items are found.
+     * @internal
+     */
+    async getEnumerations(schema, context) {
+        return this.querySchemaItem(context, schema, SchemaItemQueries_1.SchemaItemQueries.enumeration(true), "Enumeration");
+    }
+    /**
+     * Gets all the Schema's Unit items as [[SchemaItemUnitProps]] JSON objects.
+     * @param schema The name of the Schema.
+     * @param context The SchemaContext to which the schema belongs.
+     * @returns A promise that resolves to a SchemaItemUnitProps array. Maybe empty if not items are found.
+     * @internal
+     */
+    async getUnits(schema, context) {
+        return this.querySchemaItem(context, schema, SchemaItemQueries_1.SchemaItemQueries.unit(true), "Unit");
+    }
+    /**
+     * Gets all the Schema's InvertedUnit items as [[InvertedUnitProps]] JSON objects.
+     * @param schema The name of the Schema.
+     * @param context The SchemaContext to which the schema belongs.
+     * @returns A promise that resolves to a InvertedUnitProps array. Maybe empty if not items are found.
+     * @internal
+     */
+    async getInvertedUnits(schema, context) {
+        return this.querySchemaItem(context, schema, SchemaItemQueries_1.SchemaItemQueries.invertedUnit(true), "InvertedUnit");
+    }
+    /**
+     * Gets all the Schema's Constant items as [[ConstantProps]] JSON objects.
+     * @param schema The name of the Schema.
+     * @param context The SchemaContext to which the schema belongs.
+     * @returns A promise that resolves to a ConstantProps array. Maybe empty if not items are found.
+     * @internal
+     */
+    async getConstants(schema, context) {
+        return this.querySchemaItem(context, schema, SchemaItemQueries_1.SchemaItemQueries.constant(true), "Constant");
+    }
+    /**
+     * Gets all the Schema's UnitSystem items as [[UnitSystemProps]] JSON objects.
+     * @param schema The name of the Schema.
+     * @param context The SchemaContext to which the schema belongs.
+     * @returns A promise that resolves to a UnitSystemProps array. Maybe empty if not items are found.
+     * @internal
+     */
+    async getUnitSystems(schema, context) {
+        return this.querySchemaItem(context, schema, SchemaItemQueries_1.SchemaItemQueries.unitSystem(true), "UnitSystem");
+    }
+    /**
+     * Gets all the Schema's Phenomenon items as [[PhenomenonProps]] JSON objects.
+     * @param schema The name of the Schema.
+     * @param context The SchemaContext to which the schema belongs.
+     * @returns A promise that resolves to a PhenomenonProps array. Maybe empty if not items are found.
+     * @internal
+     */
+    async getPhenomenon(schema, context) {
+        return this.querySchemaItem(context, schema, SchemaItemQueries_1.SchemaItemQueries.phenomenon(true), "Phenomenon");
+    }
+    /**
+     * Gets all the Schema's Format items as [[SchemaItemFormatProps]] JSON objects.
+     * @param schema The name of the Schema.
+     * @param context The SchemaContext to which the schema belongs.
+     * @returns A promise that resolves to a SchemaItemFormatProps array. Maybe empty if not items are found.
+     * @internal
+     */
+    async getFormats(schema, context) {
+        return this.querySchemaItem(context, schema, SchemaItemQueries_1.SchemaItemQueries.format(true), "Format");
+    }
+    /**
+     * Gets [[SchemaInfo]] objects for all schemas including their direct schema references.
+     * @internal
+     */
+    async loadSchemaInfos() {
+        const schemaRows = await this.executeQuery(SchemaStubQueries_1.ecsqlQueries.schemaInfoQuery);
+        return schemaRows.map((schemaRow) => ({
+            alias: schemaRow.alias,
+            schemaKey: SchemaKey_1.SchemaKey.parseString(`${schemaRow.name}.${schemaRow.version}`),
+            references: Array.from(JSON.parse(schemaRow.references), parseSchemaReference),
+        }));
+    }
+    /**
+     * Gets the [[SchemaProps]] to create the basic schema skeleton. Depending on which options are set, the schema items or class hierarchy
+     * can be included in the initial fetch.
+     * @param schemaKey The [[SchemaKey]] of the schema to be resolved.
+     * @returns A promise that resolves to the schema partials, which is an array of [[SchemaProps]].
+     * @internal
+     */
+    async getSchemaPartials(schemaKey, context) {
+        const [schemaRow] = await this.executeQuery(SchemaStubQueries_1.ecsqlQueries.schemaStubQuery, {
+            parameters: { schemaName: schemaKey.name },
+            limit: 1
+        });
+        if (!schemaRow)
+            return undefined;
+        const schemaPartials = [];
+        const addSchema = async (key) => {
+            const stub = await this.createSchemaProps(key, context);
+            schemaPartials.push(stub);
+            if (stub.references) {
+                for (const referenceProps of stub.references) {
+                    if (!schemaPartials.some((schema) => schema.name === referenceProps.name)) {
+                        await addSchema(SchemaKey_1.SchemaKey.parseString(`${referenceProps.name}.${referenceProps.version}`));
+                    }
+                }
+            }
+            return stub;
+        };
+        const addItems = async (schemaName, itemInfo) => {
+            let schemaStub = schemaPartials.find((schema) => schema.name === schemaName);
+            if (!schemaStub) {
+                schemaStub = await addSchema(SchemaKey_1.SchemaKey.parseString(`${schemaName}.0.0.0`));
+            }
+            if (!schemaStub.items) {
+                Object.assign(schemaStub, { items: {} });
+            }
+            const existingItem = schemaStub.items[itemInfo.name] || {};
+            Object.assign(schemaStub.items, { [itemInfo.name]: Object.assign(existingItem, itemInfo) });
+        };
+        const reviver = (_key, value) => {
+            if (value === null) {
+                return undefined;
+            }
+            return value;
+        };
+        await addSchema(schemaKey);
+        await parseSchemaItemStubs(schemaKey.name, context, JSON.parse(schemaRow.items, reviver), addItems);
+        return schemaPartials;
+    }
+    async querySchemaItem(context, schemaName, query, schemaType) {
+        const start = Date.now();
+        const itemRows = await this.executeQuery(query, { parameters: { schemaName } });
+        this.options.performanceLogger?.logSchemaItem(start, schemaName, schemaType, itemRows.length);
+        if (itemRows.length === 0)
+            return [];
+        const items = itemRows.map((itemRow) => {
+            return "string" === typeof itemRow.item ? JSON.parse(itemRow.item) : itemRow.item;
+        });
+        return await SchemaParser_1.SchemaParser.parseSchemaItems(items, schemaName, context) ?? [];
+    }
+    async getFullSchema(schemaKey, context) {
+        const schemaRows = await this.executeQuery(FullSchemaQueries_1.FullSchemaQueries.schemaQuery, { parameters: { schemaName: schemaKey.name } });
+        const schemaRow = schemaRows[0];
+        if (schemaRow === undefined)
+            return undefined;
+        // Map SchemaItemRow array, [{item: SchemaItemProps}], to array of SchemaItemProps.
+        const schema = JSON.parse(schemaRow.schema);
+        if (schema.items) {
+            schema.items = schema.items.map((itemRow) => { return itemRow.item; });
+        }
+        return SchemaParser_1.SchemaParser.parse(schema, context);
+    }
+    async getFullSchemaMultipleQueries(schemaKey, context) {
+        const schema = await this.getSchemaNoItems(schemaKey.name, context);
+        if (!schema)
+            return undefined;
+        schema.items = {};
+        await Promise.all([
+            this.getEntities(schemaKey.name, context),
+            this.getMixins(schemaKey.name, context),
+            this.getStructs(schemaKey.name, context),
+            this.getRelationships(schemaKey.name, context),
+            this.getCustomAttributeClasses(schemaKey.name, context),
+            this.getKindOfQuantities(schemaKey.name, context),
+            this.getPropertyCategories(schemaKey.name, context),
+            this.getEnumerations(schemaKey.name, context),
+            this.getUnits(schemaKey.name, context),
+            this.getInvertedUnits(schemaKey.name, context),
+            this.getUnitSystems(schemaKey.name, context),
+            this.getConstants(schemaKey.name, context),
+            this.getPhenomenon(schemaKey.name, context),
+            this.getFormats(schemaKey.name, context)
+        ]).then((itemResults) => {
+            const flatItemList = itemResults.reduce((acc, item) => acc.concat(item));
+            flatItemList.forEach((schemaItem) => {
+                schema.items[schemaItem.name] = schemaItem;
+            });
+        });
+        return schema;
+    }
+}
+exports.ECSqlSchemaLocater = ECSqlSchemaLocater;
+function parseSchemaReference(referenceName) {
+    return { schemaKey: SchemaKey_1.SchemaKey.parseString(referenceName) };
+}
+async function parseSchemaItemStubs(schemaName, context, itemRows, addItemsHandler) {
+    if (!itemRows || itemRows.length === 0) {
+        return;
+    }
+    const parseBaseClasses = async (baseClasses) => {
+        if (!baseClasses || baseClasses.length < 2)
+            return;
+        for (let index = baseClasses.length - 1; index >= 0;) {
+            const currentItem = baseClasses[index--];
+            const baseClassItem = baseClasses[index];
+            const baseClassName = baseClassItem ? `${baseClassItem.schema}.${baseClassItem.name}` : undefined;
+            const schemaItem = await SchemaParser_1.SchemaParser.parseItem(currentItem, currentItem.schema, context);
+            await addItemsHandler(currentItem.schema, {
+                ...schemaItem,
+                name: schemaItem.name,
+                schemaItemType: (0, ECObjects_1.parseSchemaItemType)(schemaItem.schemaItemType),
+                baseClass: baseClassName,
+            });
+        }
+    };
+    for (const itemRow of itemRows) {
+        const schemaItem = await SchemaParser_1.SchemaParser.parseItem(itemRow, schemaName, context);
+        await addItemsHandler(schemaName, {
+            ...schemaItem,
+            name: schemaItem.name,
+            schemaItemType: (0, ECObjects_1.parseSchemaItemType)(schemaItem.schemaItemType),
+            mixins: itemRow.mixins
+                ? itemRow.mixins.map(mixin => { return `${mixin.schema}.${mixin.name}`; })
+                : undefined,
+        });
+        await parseBaseClasses(itemRow.baseClasses);
+        for (const mixinRow of itemRow.mixins || []) {
+            const mixinItem = await SchemaParser_1.SchemaParser.parseItem(mixinRow, mixinRow.schema, context);
+            await addItemsHandler(mixinRow.schema, {
+                ...mixinItem,
+                name: mixinItem.name,
+                schemaItemType: (0, ECObjects_1.parseSchemaItemType)(mixinItem.schemaItemType),
+            });
+            await parseBaseClasses(mixinRow.baseClasses);
+        }
+    }
+}
+//# sourceMappingURL=ECSqlSchemaLocater.js.map