@itwin/imodel-transformer 2.0.0-dev.5 → 2.0.0-dev.7

package/lib/cjs/IModelExporter.js

@@ -48,7 +48,7 @@ class IModelExportHandler {
      */
     onExportModel(_model, _isUpdate) { }
     /** Called when a model should be deleted. */
-    onDeleteModel(_modelId) { }
+    async onDeleteModel(_modelId) { }
     /** If `true` is returned, then the element will be exported.
      * @note This method can optionally be overridden to exclude an individual Element (and its children and ElementAspects) from the export. The base implementation always returns `true`.
      */
@@ -64,7 +64,7 @@ class IModelExportHandler {
      * @param isUpdate If defined, then `true` indicates an UPDATE operation while `false` indicates an INSERT operation. If not defined, then INSERT vs. UPDATE is not known.
      * @note This should be overridden to actually do the export.
      */
-    onExportElement(_element, _isUpdate) { }
+    async onExportElement(_element, _isUpdate) { }
     /**
      * Do any asynchronous actions before exporting an element
      * @note Do not implement this handler manually, it is internal, it will be removed.
@@ -85,11 +85,11 @@ class IModelExportHandler {
      * @param isUpdate If defined, then `true` indicates an UPDATE operation while `false` indicates an INSERT operation. If not defined, then INSERT vs. UPDATE is not known.
      * @note This should be overridden to actually do the export.
      */
-    onExportElementUniqueAspect(_aspect, _isUpdate) { }
+    async onExportElementUniqueAspect(_aspect, _isUpdate) { }
     /** Called when ElementMultiAspects should be exported.
      * @note This should be overridden to actually do the export.
      */
-    onExportElementMultiAspects(_aspects) { }
+    async onExportElementMultiAspects(_aspects) { }
     /** If `true` is returned, then the relationship will be exported.
      * @note This method can optionally be overridden to exclude an individual CodeSpec from the export. The base implementation always returns `true`.
      */
@@ -101,7 +101,7 @@ class IModelExportHandler {
      * @param isUpdate If defined, then `true` indicates an UPDATE operation while `false` indicates an INSERT operation. If not defined, then INSERT vs. UPDATE is not known.
      * @note This should be overridden to actually do the export.
      */
-    onExportRelationship(_relationship, _isUpdate) { }
+    async onExportRelationship(_relationship, _isUpdate) { }
     /** Called when a relationship should be deleted. */
     onDeleteRelationship(_relInstanceId) { }
     /** If `true` is returned, then the schema will be exported.
@@ -198,8 +198,8 @@ class IModelExporter {
     constructor(sourceDb, elementAspectsStrategy = ExportElementAspectsWithElementsStrategy_1.ExportElementAspectsWithElementsStrategy) {
         this.sourceDb = sourceDb;
         this._exportElementAspectsStrategy = new elementAspectsStrategy(this.sourceDb, {
-            onExportElementMultiAspects: (aspects) => this.handler.onExportElementMultiAspects(aspects),
-            onExportElementUniqueAspect: (aspect, isUpdate) => this.handler.onExportElementUniqueAspect(aspect, isUpdate),
+            onExportElementMultiAspects: async (aspects) => this.handler.onExportElementMultiAspects(aspects),
+            onExportElementUniqueAspect: async (aspect, isUpdate) => this.handler.onExportElementUniqueAspect(aspect, isUpdate),
             shouldExportElementAspect: (aspect) => this.handler.shouldExportElementAspect(aspect),
             trackProgress: async () => this.trackProgress(),
         });
@@ -297,7 +297,7 @@ class IModelExporter {
         if (this.visitElements) {
             // must delete models first since they have a constraint on the submodeling element which may also be deleted
             for (const modelId of this._sourceDbChanges.model.deleteIds) {
-                this.handler.onDeleteModel(modelId);
+                await this.handler.onDeleteModel(modelId);
             }
             for (const elementId of this._sourceDbChanges.element.deleteIds) {
                 // We don't know how the handler wants to handle deletions, and we don't have enough information
@@ -346,19 +346,16 @@ class IModelExporter {
       ORDER BY ECInstanceId
     `;
         const schemaNamesToExport = [];
-        // eslint-disable-next-line @itwin/no-internal, @typescript-eslint/no-deprecated
-        this.sourceDb.withPreparedStatement(sql, (statement) => {
-            while (core_bentley_1.DbResult.BE_SQLITE_ROW === statement.step()) {
-                const schemaName = statement.getValue(0).getString();
-                const versionMajor = statement.getValue(1).getInteger();
-                const versionWrite = statement.getValue(2).getInteger();
-                const versionMinor = statement.getValue(3).getInteger();
-                const schemaKey = new ecschema_metadata_1.SchemaKey(schemaName, new ecschema_metadata_1.ECVersion(versionMajor, versionWrite, versionMinor));
-                if (this.handler.shouldExportSchema(schemaKey)) {
-                    schemaNamesToExport.push(schemaName);
-                }
+        for await (const row of this.sourceDb.createQueryReader(sql)) {
+            const schemaName = row[0];
+            const versionMajor = row[1];
+            const versionWrite = row[2];
+            const versionMinor = row[3];
+            const schemaKey = new ecschema_metadata_1.SchemaKey(schemaName, new ecschema_metadata_1.ECVersion(versionMajor, versionWrite, versionMinor));
+            if (this.handler.shouldExportSchema(schemaKey)) {
+                schemaNamesToExport.push(schemaName);
             }
-        });
+        }
         if (schemaNamesToExport.length === 0)
             return;
         const schemaLoader = new ecschema_metadata_1.SchemaLoader((name) => this.sourceDb.getSchemaProps(name));
@@ -378,15 +375,9 @@ class IModelExporter {
     async exportCodeSpecs() {
         core_bentley_1.Logger.logTrace(loggerCategory, "exportCodeSpecs()");
         const sql = "SELECT Name FROM BisCore:CodeSpec ORDER BY ECInstanceId";
-        // eslint-disable-next-line @itwin/no-internal, @typescript-eslint/no-deprecated
-        await this.sourceDb.withPreparedStatement(sql, 
-        // eslint-disable-next-line @itwin/no-internal, @typescript-eslint/no-deprecated
-        async (statement) => {
-            while (core_bentley_1.DbResult.BE_SQLITE_ROW === statement.step()) {
-                const codeSpecName = statement.getValue(0).getString();
-                await this.exportCodeSpecByName(codeSpecName);
-            }
-        });
+        for await (const row of this.sourceDb.createQueryReader(sql)) {
+            await this.exportCodeSpecByName(row.name);
+        }
     }
     /** Export a single CodeSpec from the source iModel.
      * @note This method is called from [[exportChanges]] and [[exportAll]], so it only needs to be called directly when exporting a subset of an iModel.
@@ -430,18 +421,39 @@ class IModelExporter {
      */
     async exportFonts() {
         core_bentley_1.Logger.logTrace(loggerCategory, "exportFonts()");
-        for (const font of this.sourceDb.fontMap.fonts.values()) {
-            await this.exportFontByNumber(font.id);
+        for (const font of this.sourceDb.fonts.queryMappedFamilies()) {
+            await this.exportFontByFontProps(font);
         }
     }
     /** Export a single font from the source iModel.
-     * @note This method is called from [[exportChanges]] and [[exportAll]], so it only needs to be called directly when exporting a subset of an iModel.
+     * @note multiple fonts can have the same font name, if a font with a specific type is needed use exportFontByFontFamilyDescriptor.
+     * If not this will only export the first font with this type in the db.
      */
     async exportFontByName(fontName) {
         core_bentley_1.Logger.logTrace(loggerCategory, `exportFontByName(${fontName})`);
-        const font = this.sourceDb.fontMap.getFont(fontName);
-        if (undefined !== font) {
-            await this.exportFontByNumber(font.id);
+        const fontId = this.sourceDb.fonts.findId({
+            name: fontName,
+        });
+        if (undefined !== fontId) {
+            await this.exportFontByNumber(fontId);
+        }
+    }
+    /** Export a single font from the source iModel.
+     * @note This method is called from [[exportChanges]] and [[exportAll]], so it only needs to be called directly when exporting a subset of an iModel.
+     */
+    async exportFontByFontProps(fontProps) {
+        core_bentley_1.Logger.logTrace(loggerCategory, `exportFontByFamily(${fontProps.name}, ${fontProps.type})`);
+        this.handler.onExportFont(fontProps, true);
+        return this.trackProgress();
+    }
+    /** Export a single font from the source iModel.
+     * @note This method is called from [[exportChanges]] and [[exportAll]], so it only needs to be called directly when exporting a subset of an iModel.
+     */
+    async exportFontByFontFamilyDescriptor(fontFamily) {
+        core_bentley_1.Logger.logTrace(loggerCategory, `exportFontByFamilyDescriptor(${fontFamily.name}, ${fontFamily.type})`);
+        const fontId = await this.sourceDb.fonts.acquireId(fontFamily);
+        if (undefined !== fontId) {
+            await this.exportFontByFontProps({ ...fontFamily, id: fontId });
         }
     }
     /** Export a single font from the source iModel.
@@ -453,12 +465,10 @@ class IModelExporter {
          * It is very rare and even problematic for the font table to reach a large size, so it is not a bottleneck in transforming changes.
          * See https://github.com/iTwin/imodel-transformer/pull/135 for removed code.
          */
-        const isUpdate = true;
         core_bentley_1.Logger.logTrace(loggerCategory, `exportFontById(${fontNumber})`);
-        const font = this.sourceDb.fontMap.getFont(fontNumber);
+        const font = this.sourceDb.fonts.findDescriptor(fontNumber);
         if (undefined !== font) {
-            this.handler.onExportFont(font, isUpdate);
-            return this.trackProgress();
+            await this.exportFontByFontFamilyDescriptor(font);
         }
     }
     /** Export the model container, contents, and sub-models from the source iModel.
@@ -533,19 +543,16 @@ class IModelExporter {
         else {
             sql = `SELECT ECInstanceId FROM ${elementClassFullName} WHERE Parent.Id IS NULL AND Model.Id=:modelId ORDER BY ECInstanceId`;
         }
-        // eslint-disable-next-line @itwin/no-internal, @typescript-eslint/no-deprecated
-        await this.sourceDb.withPreparedStatement(sql, 
-        // eslint-disable-next-line @itwin/no-internal, @typescript-eslint/no-deprecated
-        async (statement) => {
-            statement.bindId("modelId", modelId);
-            if (skipRootSubject) {
-                statement.bindId("rootSubjectId", core_common_1.IModel.rootSubjectId);
-            }
-            while (core_bentley_1.DbResult.BE_SQLITE_ROW === statement.step()) {
-                await this.exportElement(statement.getValue(0).getId());
-                await this._yieldManager.allowYield();
-            }
-        });
+        const params = new core_common_1.QueryBinder().bindId("modelId", modelId);
+        if (skipRootSubject) {
+            params.bindId("rootSubjectId", core_common_1.IModel.rootSubjectId);
+        }
+        for await (const row of this.sourceDb.createQueryReader(sql, params, {
+            usePrimaryConn: true,
+        })) {
+            await this.exportElement(row.id);
+            await this._yieldManager.allowYield();
+        }
     }
     /** Export the sub-models directly below the specified model.
      * @note This method is called from [[exportChanges]] and [[exportAll]], so it only needs to be called directly when exporting a subset of an iModel.
@@ -555,22 +562,17 @@ class IModelExporter {
         const definitionModelIds = [];
         const otherModelIds = [];
         const sql = `SELECT ECInstanceId FROM ${core_backend_1.Model.classFullName} WHERE ParentModel.Id=:parentModelId ORDER BY ECInstanceId`;
-        // eslint-disable-next-line @itwin/no-internal, @typescript-eslint/no-deprecated
-        this.sourceDb.withPreparedStatement(sql, 
-        // eslint-disable-next-line @itwin/no-internal, @typescript-eslint/no-deprecated
-        (statement) => {
-            statement.bindId("parentModelId", parentModelId);
-            while (core_bentley_1.DbResult.BE_SQLITE_ROW === statement.step()) {
-                const modelId = statement.getValue(0).getId();
-                const model = this.sourceDb.models.getModel(modelId);
-                if (model instanceof core_backend_1.DefinitionModel) {
-                    definitionModelIds.push(modelId);
-                }
-                else {
-                    otherModelIds.push(modelId);
-                }
+        const params = new core_common_1.QueryBinder().bindId("parentModelId", parentModelId);
+        for await (const row of this.sourceDb.createQueryReader(sql, params)) {
+            const modelId = row.ecinstanceid;
+            const model = this.sourceDb.models.getModel(modelId);
+            if (model instanceof core_backend_1.DefinitionModel) {
+                definitionModelIds.push(modelId);
             }
-        });
+            else {
+                otherModelIds.push(modelId);
+            }
+        }
         // export DefinitionModels before other types of Models
         for (const definitionModelId of definitionModelIds) {
             await this.exportModel(definitionModelId);
@@ -637,7 +639,7 @@ class IModelExporter {
         // the order and `await`ing of calls beyond here is depended upon by the IModelTransformer for a current bug workaround
         if (this.shouldExportElement(element)) {
             await this.handler.preExportElement(element);
-            this.handler.onExportElement(element, isUpdate);
+            await this.handler.onExportElement(element, isUpdate);
             await this.trackProgress();
             await this._exportElementAspectsStrategy.exportElementAspectsForElement(elementId);
             return this.exportChildElements(elementId);
@@ -676,23 +678,16 @@ class IModelExporter {
             return;
         }
         core_bentley_1.Logger.logTrace(loggerCategory, `exportRelationships(${baseRelClassFullName})`);
-        const sql = `SELECT r.ECInstanceId, r.ECClassId FROM ${baseRelClassFullName} r
+        const sql = `SELECT r.ECInstanceId, ec_className(r.ECClassId, 's.c') as ClassName FROM ${baseRelClassFullName} r
                   JOIN bis.Element s ON s.ECInstanceId = r.SourceECInstanceId
                   JOIN bis.Element t ON t.ECInstanceId = r.TargetECInstanceId
                   WHERE s.ECInstanceId IS NOT NULL AND t.ECInstanceId IS NOT NULL`;
-        // eslint-disable-next-line @itwin/no-internal, @typescript-eslint/no-deprecated
-        await this.sourceDb.withPreparedStatement(sql, 
-        // eslint-disable-next-line @itwin/no-internal, @typescript-eslint/no-deprecated
-        async (statement) => {
-            while (core_bentley_1.DbResult.BE_SQLITE_ROW === statement.step()) {
-                const relationshipId = statement.getValue(0).getId();
-                const relationshipClass = statement
-                    .getValue(1)
-                    .getClassNameForClassId();
-                await this.exportRelationship(relationshipClass, relationshipId); // must call exportRelationship using the actual classFullName, not baseRelClassFullName
-                await this._yieldManager.allowYield();
-            }
-        });
+        for await (const row of this.sourceDb.createQueryReader(sql)) {
+            const relationshipId = row.ecinstanceid;
+            const relationshipClass = row.classname;
+            await this.exportRelationship(relationshipClass, relationshipId); // must call exportRelationship using the actual classFullName, not baseRelClassFullName
+            await this._yieldManager.allowYield();
+        }
     }
     /** Export a relationship from the source iModel. */
     async exportRelationship(relClassFullName, relInstanceId) {
@@ -724,7 +719,7 @@ class IModelExporter {
         }
         // relationship has passed standard exclusion rules, now give handler a chance to accept/reject export
         if (this.handler.shouldExportRelationship(relationship)) {
-            this.handler.onExportRelationship(relationship, isUpdate);
+            await this.handler.onExportRelationship(relationship, isUpdate);
             await this.trackProgress();
         }
     }