API Reference › imodel-transformer› All

imodel-transformer

Classes

Name Description
ChangedElementForest The minimal parent-child forest containing changed or excluded elements and their ancestors.  
ChangedInstanceIds Class for discovering modified elements between 2 versions of an iModel.  
ChangedInstanceOps Class for holding change information.  
DynamicSchemaUnionStrategy Processes ordinary schemas with newer-version selection and unions compatible  
IModelExporter Base class for exporting data from an iModel.  
IModelExportHandler Handles the events generated by IModelExporter.  
IModelImporter Base class for importing data into an iModel.  
IModelTransformer Base class used to transform a source iModel into a different target iModel.  
NewerVersionSchemaImportStrategy Selects source schemas that are absent from the target or have a newer version.  
TemplateModelCloner IModelTransformer that clones the contents of a template model.  

Constants

Name Description
IModelTransformerErrorScope Scope shared by errors originating from @itwin/imodel-transformer.  
transformerPackageMetadata  

Enumerations

Name Description
IModelTransformerError Errors originating from @itwin/imodel-transformer.  
TransformerLoggerCategory Logger categories used by this package  

Interfaces

Name Description
ChangeRecord A change to one EC instance, for recording changes that don't come from a changeset reader.  
CollectedChanges Changes read for collectChanges.  
DeletionBatch Deleted source instances from one batch of changes.  
DeletionRecordBase Identity shared by all deletion records.  
ElementAspectExportProcessorHandler  
ElementBulkDeleteError Error thrown when native bulk deletion fails to delete one or more requested element trees.  
ElementDeletionRecord A deleted source element.  
ExportSchemaResult The (optional) result of onExportSchema  
ExternalSourceAspectDeletionRecord A deleted source ExternalSourceAspect, used to find the target of an element deleted in the same batch.  
IModelImportOptions Options provided to the IModelImporter constructor.  
IModelTransformArgs Required arguments for the IModelTransformer constructor.  
IModelTransformContext The supported transformation context exposed by an IModelTransformer.  
IModelTransformOptions Options provided to the IModelTransformer constructor.  
InitOptions Arguments you can pass to initialize  
OptimizeGeometryOptions Options provided to optimizeGeometry specifying post-processing optimizations to be applied to the iModel's geometry.  
ProcessSchemasOptions Options for processSchemas.  
ReadonlySchemaAccessor Read-only access to schemas already present in the target iModel.  
RelationshipDeletionRecord A deleted source relationship derived from BisCore:ElementRefersToElements, excluding BisCore:ElementDrivesElement.  
RelationshipEndpointFederationGuids The FederationGuids of a relationship's source and target elements, read by IModelExporter while it reads the relationship.  
RelationshipPropsForDelete  
SchemaProcessingContext Context supplied to a SchemaProcessingStrategy.  
SchemaProcessingStrategy Selects source schemas and produces definitions for import into a target iModel.  
TargetScopeProvenanceJsonProps Data type for persisting change version information within provenance Scope ExternalSourceAspect.  

Type Aliases

Name Description
ChangedInstanceIdsInitOptions Arguments for initialize  
ElementAspectExportPreparation  
ExportChangesOptions Arguments for exportChanges  
ExporterInitOptions Arguments for initialize, usually in case you want to query changedata early  
ModelDeletionRecord A deleted source model.  
ProcessChangesOptions Arguments used during process if provided in argsForProcessChanges.  
SchemaProcessingResult The result of processing one schema.  

Last Updated: 06 November, 2026