SchemaView Namespace @beta

Class

Name	Description
SchemaView.Class	Lightweight view over a class in a SchemaView.
SchemaView.Enumeration	Lightweight view over an enumeration in a SchemaView.
SchemaView.Enumerator	Thin view over an enumerator.
SchemaView.KindOfQuantity	Lightweight view over a KindOfQuantity in a SchemaView.
SchemaView.NavigationProperty	A navigation property.
SchemaView.PrimitiveArrayProperty	An array of primitive values.
SchemaView.PrimitiveProperty	A scalar primitive property.
SchemaView.Property	Lightweight view over a property in a SchemaView.
SchemaView.PropertyCategory	Lightweight view over a PropertyCategory in a SchemaView.
SchemaView.RelationshipClass	A relationship class with constraint and strength metadata.
SchemaView.RelConstraint	Lightweight view over a relationship constraint in a SchemaView.
SchemaView.Schema	Lightweight view over a schema in a SchemaView.
SchemaView.StructArrayProperty	An array of struct values.
SchemaView.StructProperty	A scalar struct property.

Interface

Name	Description
SchemaView.PresentationFormat	A parsed presentation format override from a KindOfQuantity.

Type Alias

Name	Description
SchemaView.AnyArrayProperty	Any array property (primitive or struct).
SchemaView.AnyPrimitiveProperty	Any primitive property (scalar or array).
SchemaView.AnyProperty	Union of all concrete property types.
SchemaView.AnyStructProperty	Any struct property (scalar or array).

Defined in

• ecschema-metadata/src/SchemaView.ts Line 74

SchemaView Class @beta

Read-only schema metadata view. Optimized for fast lookup and low memory usage.

All data is stored in flat arrays. View objects (SchemaView.Schema, SchemaView.Class, etc.) are stateless wrappers that hold a reference to this view plus an index. They allocate nothing and cache nothing.

The view is immutable after construction. Build it via SchemaViewBuilder or parse from a binary blob via fromBinary.

Methods

Name	Description
findClass(qualifiedName: string): SchemaView.Class | undefined	Find a class by qualified name ("SchemaName:ClassName" or "SchemaName.ClassName").
findEnumeration(qualifiedName: string): SchemaView.Enumeration | undefined	Find an enumeration by qualified name ("SchemaName:EnumName" or "SchemaName.EnumName").
findKindOfQuantity(qualifiedName: string): SchemaView.KindOfQuantity | undefined	Find a KindOfQuantity by qualified name ("SchemaName:KoqName" or "SchemaName.KoqName").
findPropertyCategory(qualifiedName: string): SchemaView.PropertyCategory | undefined	Find a PropertyCategory by qualified name ("SchemaName:CategoryName" or "SchemaName.CategoryName").
getSchema(name: string): SchemaView.Schema | undefined	Get a schema by name (case-insensitive).
getSchemaByAlias(alias: string): SchemaView.Schema | undefined	Get a schema by alias (case-insensitive).
getSchemas(): IterableIterator<SchemaView.Schema>	Iterate all schemas.
fromBinary(blob: Uint8Array, schemaToken?: string): SchemaView Static	Parse a binary blob into a SchemaView.

Properties

Name	Type	Description
classCount Accessor ReadOnly	number	Number of classes across all schemas.
isOutdated Accessor ReadOnly	boolean	True if the host (IModelDb / IModelConnection) has replaced this view with a newer one.
schemaCount Accessor ReadOnly	number	Number of schemas in the view.
schemaToken Accessor ReadOnly	string	SHA3-256 content hash of the ec_ schema tables at the time this view was built.

Defined in

• ecschema-metadata/src/SchemaView.ts Line 74