Skip to main content

@idpass/data-collect-core / EntityStorageAdapter

Interface: EntityStorageAdapter

Defined in: interfaces/types.ts:617

Storage adapter interface for entity persistence.

Provides the low-level storage operations for entities. Implementations include IndexedDbEntityStorageAdapter and PostgresEntityStorageAdapter.

Methods​

initialize()​

initialize(): Promise<void>

Defined in: interfaces/types.ts:619

Initialize the storage adapter (create tables, indexes, etc.)

Returns​

Promise<void>


saveEntity()​

saveEntity(entity): Promise<void>

Defined in: interfaces/types.ts:621

Save an entity pair to storage

Parameters​

entity​

EntityPair

Returns​

Promise<void>


getEntity()​

getEntity(id): Promise<EntityPair | null>

Defined in: interfaces/types.ts:623

Get entity by internal ID

Parameters​

id​

string

Returns​

Promise<EntityPair | null>


getEntityByExternalId()​

getEntityByExternalId(externalId): Promise<EntityPair | null>

Defined in: interfaces/types.ts:625

Get entity by external system ID

Parameters​

externalId​

string

Returns​

Promise<EntityPair | null>


searchEntities()​

searchEntities(criteria): Promise<EntityPair[]>

Defined in: interfaces/types.ts:627

Search entities using query criteria

Parameters​

criteria​

SearchCriteria

Returns​

Promise<EntityPair[]>


getAllEntities()​

getAllEntities(): Promise<EntityPair[]>

Defined in: interfaces/types.ts:629

Get all entities from storage

Returns​

Promise<EntityPair[]>


getModifiedEntitiesSince()​

getModifiedEntitiesSince(timestamp): Promise<EntityPair[]>

Defined in: interfaces/types.ts:631

Get entities modified since a timestamp (for sync)

Parameters​

timestamp​

string

Returns​

Promise<EntityPair[]>


deleteEntity()​

deleteEntity(id): Promise<void>

Defined in: interfaces/types.ts:633

Delete an entity by ID

Parameters​

id​

string

Returns​

Promise<void>


savePotentialDuplicates()​

savePotentialDuplicates(duplicates): Promise<void>

Defined in: interfaces/types.ts:635

Save potential duplicate entity pairs for review

Parameters​

duplicates​

object[]

Returns​

Promise<void>


getPotentialDuplicates()​

getPotentialDuplicates(): Promise<object[]>

Defined in: interfaces/types.ts:637

Get all potential duplicate pairs

Returns​

Promise<object[]>


resolvePotentialDuplicates()​

resolvePotentialDuplicates(duplicates): Promise<void>

Defined in: interfaces/types.ts:639

Resolve potential duplicate pairs (mark as reviewed)

Parameters​

duplicates​

object[]

Returns​

Promise<void>


clearStore()​

clearStore(): Promise<void>

Defined in: interfaces/types.ts:641

Clear all data from storage (for testing)

Returns​

Promise<void>


closeConnection()​

closeConnection(): Promise<void>

Defined in: interfaces/types.ts:643

Close database connections and cleanup resources

Returns​

Promise<void>