@bentley/bis-core-schema 1.0.26-dev.1 → 1.0.26

package/BisCore.ecschema.xml

@@ -16,7 +16,7 @@
 
     <ECCustomAttributes>
         <ProductionStatus xmlns="CoreCustomAttributes.01.00.03">
-            <SupportedUse>NotForProduction</SupportedUse>
+            <SupportedUse>Production</SupportedUse>
         </ProductionStatus>
         <SchemaLayerInfo xmlns="BisCustomAttributes.01.00.00">
             <Value>Core</Value>
@@ -2471,6 +2471,11 @@
         </Target>
     </ECRelationshipClass> 
 
+    <ECEntityClass typeName="FormatSet" modifier="Sealed" displayLabel="Format Set" description="A bis:DefinitionElement that captures the settings of a set of formats in need to be maintained in BIS Repositories.">
+        <BaseClass>DefinitionElement</BaseClass>
+        <ECProperty propertyName="Settings" typeName="string" extendedTypeName="Json" displayLabel="Settings" description="The settings for the format set in a versioned JSON format." />
+    </ECEntityClass>
+
     <ECEntityClass typeName="LineStyle" modifier="Sealed" displayLabel="Line Style">
         <BaseClass>DefinitionElement</BaseClass>
         <ECCustomAttributes>

package/BisCore.remarks.md

@@ -558,6 +558,10 @@ This behavior applies to all `RoleElement` subclasses.
 
 Concrete implementations may offer a way to override the default `TextStyle` instance referenced through the _DefaultTextStyle_ navigation property accordingly.
 
+### FormatSet
+
+A [Format](https://www.itwinjs.org/reference/ecschema-metadata/metadata/format/) is used to control how unitized values shall be displayed in the user-interface. [FormatSets](https://www.itwinjs.org/reference/ecschema-metadata/metadata/formatset/) are typically maintained outside of BIS Repositories. However, there are use-cases that need FormatSets to be stored in BIS Repositories as `DefinitionElement`s (shared data). The latter cases shall use the `FormatSet` BIS class to capture their settings.
+
 ## Relationship Classes
 
 ### PhysicalTypeComposesSubTypes
@@ -578,4 +582,211 @@ The scenario presented in such example is addressed by introducing a `SpatialLoc
 
 ![Class diagram](media/SpatialLocationTypeRepresents-classes.png)
 
-![Instance diagram](media/SpatialLocationTypeRepresents-instances.png)
+![Instance diagram](media/SpatialLocationTypeRepresents-instances.png)
+
+## Sample ECSQL queries
+
+- `DrawingGraphic`s representing `GeometricElement3d`s, organized per `Drawing`
+
+```sql
+SELECT
+    dr.ECInstanceId [DrawingId],
+    d.ECInstanceId [DrawingGraphicId],
+    g.ECInstanceId [GeometricElement3dId]
+FROM
+    bis.GeometricElement3d g INNER JOIN
+    bis.DrawingGraphicRepresentsElement r ON g.ECInstanceId = r.TargetECInstanceId INNER JOIN
+    bis.DrawingGraphic d ON d.ECInstanceId = r.SourceECInstanceId INNER JOIN
+    bis.DrawingModel dm ON dm.ECInstanceId = d.Model.Id INNER JOIN
+    bis.Drawing dr ON dr.ECInstanceId = dm.ModeledElement.Id
+ORDER BY
+    dr.ECInstanceId
+```
+
+- Count of `GeometricElement3d`s that have assigned _Geometry_, per concrete _ECClass_.
+
+```sql
+SELECT
+    ec_classname(ECClassId),
+    COUNT(*)
+FROM
+    bis.GeometricElement3d
+WHERE
+    GeometryStream IS NOT NULL
+GROUP BY
+    ECClassId
+```
+
+- Count of `PhysicalElement`s per `PhysicalMaterial`.
+
+```sql
+SELECT 
+    pm.CodeValue,
+    COUNT(*)
+FROM 
+    (SELECT 
+        pe.ECInstanceId,
+        coalesce(pe.PhysicalMaterial.Id, pt.PhysicalMaterial.Id) [PhysicalMaterialId]
+    FROM bis.PhysicalElement pe
+        LEFT JOIN bis.PhysicalType pt ON pe.TypeDefinition.Id = pt.ECInstanceId) pmat
+    INNER JOIN bis.PhysicalMaterial pm ON pmat.PhysicalMaterialId = pm.ECInstanceId
+GROUP BY
+    pm.ECInstanceId
+```
+
+- Count of `Element`s per associated `RepositoryLink` (provenance).
+
+```sql
+SELECT
+    rl.CodeValue,
+    rl.UserLabel,
+    COUNT(*)
+FROM
+    bis.RepositoryLink rl INNER JOIN
+    bis.ExternalSource s ON s.Repository.Id = rl.ECInstanceId INNER JOIN
+    bis.ExternalSourceAspect xsa ON xsa.Source.Id = s.ECInstanceId
+WHERE
+    rl.ECInstanceId = :repositoryLinkId
+```
+
+- _Name_ and _Version_ of the iModel Connector that synchronized a particular Element (if any):
+
+```sql
+SELECT
+  xs.ConnectorName,
+  xs.ConnectorVersion
+FROM
+  bis.Element e
+  INNER JOIN bis.ExternalSourceAspect xsa ON e.ECInstanceId = xsa.Element.Id
+  INNER JOIN bis.ExternalSource xs ON xs.ECInstanceId = xsa.Source.Id
+WHERE
+  e.ECInstanceId = :elementId
+```
+
+- Subject hierarchy reported according to element-creation order.
+
+```sql
+SELECT 
+    ECInstanceId, 
+    CodeValue, 
+    Parent.Id, 
+    ec_classname(ECClassId), 
+    UserLabel, 
+    JsonProperties 
+FROM 
+    bis.Element
+WHERE 
+    ECClassId IS (bis.Subject, bis.InformationPartitionElement) 
+ORDER BY 
+    ECInstanceId
+```
+
+- Subject hierarchy (elements in the Repository Model) traversed recursively (i.e. Depth-First search) starting at the _Root Subject_.
+
+```sql
+WITH RECURSIVE elementsInHierarchy(id) AS (
+    VALUES(0x1) 
+UNION ALL 
+    SELECT 
+        ECInstanceId 
+    FROM 
+        bis.Element e, 
+        elementsInHierarchy h 
+    WHERE 
+        e.Parent.Id = h.id) 
+SELECT 
+    e.ECInstanceId, 
+    e.CodeValue, 
+    e.UserLabel, 
+    ec_classname(e.ECClassId) 
+FROM 
+    elementsInHierarchy h, 
+    bis.Element e 
+WHERE 
+    e.ECInstanceId = h.id
+```
+
+- All elements under a particular `Subject`, queried recursively.
+
+```sql
+WITH RECURSIVE elementsInHierarchy(id) AS (
+    VALUES(:subjectId) 
+UNION ALL 
+    SELECT 
+        e.ECInstanceId 
+    FROM 
+        bis.Element e, 
+        elementsInHierarchy h, 
+        bis.Element he 
+    WHERE 
+        (he.ECInstanceId = h.id) AND ((he.ECClassId IS (bis.IParentElement) AND e.Parent.Id = h.id) 
+        OR (he.ECClassId IS (bis.ISubModeledElement) AND e.Model.Id = h.id))) 
+SELECT 
+    e.ECInstanceId, 
+    e.CodeValue, 
+    e.UserLabel, 
+    ec_classname(e.ECClassId) 
+FROM 
+    elementsInHierarchy h, 
+    bis.Element e 
+WHERE 
+    e.ECInstanceId = h.id
+```
+
+- Query for the _Channel_ (Key and Version) in which a particular _Element_ is in. Returns '<shared>' if the _Element_ is not in any Channel explicitely.
+
+```sql
+WITH RECURSIVE ancestors(id) AS (
+    VALUES(:elementId) 
+UNION ALL 
+    SELECT 
+        coalesce(p.ECInstanceId, m.ECInstanceId) 
+    FROM 
+        bis.Element e, 
+        bis.Element m, 
+        ancestors a 
+        LEFT JOIN bis.Element p ON e.Parent.Id = p.ECInstanceId         
+    WHERE 
+        e.ECInstanceId = a.id AND e.Model.Id = m.ECInstanceId AND e.Model.id <> e.ECInstanceId) 
+SELECT 
+    coalesce(cra.Owner, '<shared>') [Channel Key],
+    coalesce(cra.Version, NULL) [Channel Version]
+FROM 
+    bis.Subject e LEFT JOIN bis.ChannelRootAspect cra ON cra.Element.Id = e.ECInstanceId,
+    ancestors a 
+WHERE 
+    e.ECInstanceId = a.id AND (cra.ECInstanceId IS NOT NULL OR e.ECInstanceId = 0x1)
+ORDER BY 
+    e.ECInstanceId DESC
+LIMIT 
+    1
+```
+
+- Query for all _Channels_ and return its _channel key_, _channel version_ and count of elements on each. Returns '<shared>' to account for any elements that are not in any particular _Channel_.
+
+```sql
+WITH RECURSIVE descendents(id, channelId) AS (
+    VALUES(0x1, 0x1)
+UNION ALL
+    SELECT 
+        e.ECInstanceId,
+        coalesce(cra.Element.Id, d.channelId)
+    FROM 
+        bis.Element e, 
+        descendents d, 
+        bis.Element he LEFT JOIN bis.ChannelRootAspect cra ON cra.Element.Id = he.ECInstanceId
+    WHERE 
+        (he.ECInstanceId = d.id) AND ((he.ECClassId IS (bis.IParentElement) AND e.Parent.Id = d.id) 
+        OR (he.ECClassId IS (bis.ISubModeledElement) AND e.Model.Id = d.id))) 
+SELECT
+    coalesce(channel.Owner, '<shared>') [Channel Key],
+    coalesce(channel.Version, NULL) [Channel Version],
+    COUNT(*)
+FROM
+   bis.Subject s LEFT JOIN bis.ChannelRootAspect channel ON s.ECInstanceId = channel.Element.Id,
+   descendents d
+WHERE
+    d.channelId = s.ECInstanceId
+GROUP BY
+    s.ECInstanceId
+```

package/LICENSE.md

@@ -1,6 +1,6 @@
 # MIT License
 
-Copyright © 2017-2025 Bentley Systems, Incorporated. All rights reserved.
+Copyright © 2017-2026 Bentley Systems, Incorporated. All rights reserved.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@bentley/bis-core-schema",
   "license": "MIT",
-  "version": "1.0.26-dev.1",
+  "version": "1.0.26",
   "homepage": "https://www.itwinjs.org/",
   "keywords": [
     "Bentley",
@@ -12,5 +12,9 @@
   "author": {
     "name": "Bentley Systems, Inc.",
     "url": "http://www.bentley.com"
+  },
+  "exports" : {
+     "./BisCore.ecschema.xml": "./BisCore.ecschema.xml",
+     "./BisCore.ecschema.json": "./BisCore.ecschema.json"
   }
 }