Class DatabaseReferenceScanner

Scans the database for existing records that reference records marked for deletion This helps identify:

Database-only records that will prevent deletion
Records that should be included in the deletion plan

Index

Constructors

Methods

getMetadataReferences getOrphanedReferences scanForReferences

Constructors

constructor

new DatabaseReferenceScanner(
metadata: Metadata,
contextUser: UserInfo,
): DatabaseReferenceScanner
Parameters
- metadata: Metadata
- contextUser: UserInfo
Returns DatabaseReferenceScanner
- Defined in packages/MetadataSync/src/lib/database-reference-scanner.ts:34

Methods

getMetadataReferences

getMetadataReferences(references: DatabaseReference[]): DatabaseReference[]
Get metadata references (records in metadata that reference deletion targets) These should already be marked for deletion if the user set things up correctly
Parameters
- references: DatabaseReference[]
Returns DatabaseReference[]
- Defined in packages/MetadataSync/src/lib/database-reference-scanner.ts:324

getOrphanedReferences

getOrphanedReferences(references: DatabaseReference[]): DatabaseReference[]
Get orphaned references (database-only records not in metadata) These will prevent deletion unless handled
Parameters
- references: DatabaseReference[]
Returns DatabaseReference[]
- Defined in packages/MetadataSync/src/lib/database-reference-scanner.ts:316

scanForReferences

scanForReferences(
    recordsToDelete: FlattenedRecord[],
    reverseFKMap: Map<string, ReverseFKInfo[]>,
    allMetadataRecords: FlattenedRecord[],
): Promise<DatabaseReference[]>
Scan database for records that reference records marked for deletion

Queries are batched: all delete-target primary keys of a given entity are checked against each referencing foreign key in a single IN (...) query, rather than one query per (record × referencing field). Metadata membership is resolved via a pre-built key set instead of re-scanning every metadata record for each reference found.
Parameters
- recordsToDelete: FlattenedRecord[]
  Records that will be deleted
- reverseFKMap: Map<string, ReverseFKInfo[]>
  Map of entity -> entities that reference it
- allMetadataRecords: FlattenedRecord[]
  All records from metadata (for checking if DB record exists in metadata)
Returns Promise<DatabaseReference[]>
Array of database references found
- Defined in packages/MetadataSync/src/lib/database-reference-scanner.ts:52