Native Bulk Element Deletion API (#9052)

Author: RohitPtnkr1996

common/api/core-backend.api.md

@@ -2611,6 +2611,7 @@ export class EditTxn {
     deleteAspect(aspectInstanceIds: Id64Arg): void;
     deleteDefinitionElements(definitionElementIds: Id64Array): Id64Set;
     deleteElement(ids: Id64Arg): void;
+    deleteElements(ids: Id64Array): Id64Set;
     deleteFileProperty(prop: FilePropertyProps): void;
     deleteModel(ids: Id64Arg): void;
     deleteRelationship(props: RelationshipProps): void;

common/changes/@itwin/core-backend/rohitptnkr-bulk-element-deletion_2026-03-03-14-06.json

@@ -0,0 +1,10 @@
+{
+  "changes": [
+    {
+      "packageName": "@itwin/core-backend",
+      "comment": "Added deleteElements method for bulk element deletion with automatic cascade, constraint checking, and cleanup.",
+      "type": "none"
+    }
+  ],
+  "packageName": "@itwin/core-backend"
+}

core/backend/src/EditTxn.ts

@@ -7,7 +7,7 @@
  * @module iModels
  */
 
-import { DbResult, Id64, Id64Arg, Id64Array, Id64Set, Id64String, IModelStatus, OpenMode } from "@itwin/core-bentley";
+import { DbResult, Id64, Id64Arg, Id64Array, Id64Set, Id64String, IModelStatus, ITwinError, OpenMode } from "@itwin/core-bentley";
 import { EcefLocation, EcefLocationProps, EditTxnError, ElementAspectProps, ElementProps, FilePropertyProps, IModelError, ModelProps, RelationshipProps, SaveChangesArgs } from "@itwin/core-common";
 import { Range3d, Range3dProps } from "@itwin/core-geometry";
 import type { CloudSqlite } from "./CloudSqlite";
@@ -225,6 +225,38 @@ export class EditTxn {
     });
   }
 
+  /**
+   * Delete multiple elements from the iModel.
+   * @param ids The ids of the elements to delete. All ids must be well-formed and valid [[Id64String]]s.
+   * @returns A set of ids for any elements that could not be deleted.
+   * @throws [[ITwinError]] if any of the supplied ids are not well-formed/valid [[Id64String]]s.
+   * @beta
+   */
+  public deleteElements(ids: Id64Array): Id64Set {
+    this.verifyWriteable();
+    const invalidIds: Id64Set = new Set<Id64String>();
+    for (const id of ids) {
+      if (!Id64.isValidId64(id))
+        invalidIds.add(id);
+    }
+
+    if (invalidIds.size > 0) {
+      ITwinError.throwError({ message: `Invalid element ids: ${Array.from(invalidIds).join(", ")}`, iTwinErrorId: { scope: "imodel", key: "invalid-arguments" } });
+    }
+
+    const failedToDelete = this.iModel[_nativeDb].deleteElements(ids);
+    const failedToDeleteSet = failedToDelete ? Id64.toIdSet(failedToDelete) : new Set<Id64String>();
+
+    for (const id of ids) {
+      if (!failedToDeleteSet.has(id)) {
+        this.iModel.elements[_cache].delete({ id });
+        this.iModel.elements[_instanceKeyCache].deleteById(id);
+      }
+    }
+
+    return failedToDeleteSet;
+  }
+
   /** Insert a new aspect into the iModel.
    * @param aspectProps The properties of the new aspect.
    * @returns The newly inserted aspect Id.

core/backend/src/test/IModelTestUtils.ts

@@ -639,6 +639,12 @@ export class IModelTestUtils {
     return geometryStreamBuilder.geometryStream;
   }
 
+  public static insertTextureElement(txn: EditTxn, modelId: Id64String, textureName: string): Id64String {
+    // This is an encoded png containing a 3x3 square with white in top left pixel, blue in middle pixel, and green in bottom right pixel. The rest of the square is red.
+    const pngData = [137, 80, 78, 71, 13, 10, 26, 10, 0, 0, 0, 13, 73, 72, 68, 82, 0, 0, 0, 3, 0, 0, 0, 3, 8, 2, 0, 0, 0, 217, 74, 34, 232, 0, 0, 0, 1, 115, 82, 71, 66, 0, 174, 206, 28, 233, 0, 0, 0, 4, 103, 65, 77, 65, 0, 0, 177, 143, 11, 252, 97, 5, 0, 0, 0, 9, 112, 72, 89, 115, 0, 0, 14, 195, 0, 0, 14, 195, 1, 199, 111, 168, 100, 0, 0, 0, 24, 73, 68, 65, 84, 24, 87, 99, 248, 15, 4, 12, 12, 64, 4, 198, 64, 46, 132, 5, 162, 254, 51, 0, 0, 195, 90, 10, 246, 127, 175, 154, 145, 0, 0, 0, 0, 73, 69, 78, 68, 174, 66, 96, 130];
+    return Texture.insertTexture(txn, modelId, textureName, ImageSourceFormat.Png, Buffer.from(pngData).toString("base64"), `Description for ${textureName}`);
+  }
+
   public static createCylinder(radius: number): GeometryStreamProps {
     const pointA = Point3d.create(0, 0, 0);
     const pointB = Point3d.create(0, 0, 2 * radius);