UnitOfWork

Index

Constructors

• constructor

Methods

• cancelOrphanRemoval
• clear
• clearActionsQueue
• commit
• computeChangeSet
• computeChangeSets
• getById
• getChangeSetPersister
• getChangeSets
• getCollectionUpdates
• getExtraUpdates
• getIdentityMap
• getOriginalEntityData
• getOrphanRemoveStack
• getPersistStack
• getRemoveStack
• lock
• merge
• persist
• recomputeSingleChangeSet
• remove
• scheduleExtraUpdate
• scheduleOrphanRemoval
• shouldAutoFlush
• tryGetById
• unsetIdentity

Constructors

constructor

• new UnitOfWork(em: EntityManager<IDatabaseDriver<Connection>>): UnitOfWork

• Parameters

  • em: EntityManager<IDatabaseDriver<Connection>>

  Returns UnitOfWork

Methods

cancelOrphanRemoval

• cancelOrphanRemoval(entity: Partial<any>, visited?: Set<Partial<any>>): void

• Parameters

  • entity: Partial<any>

  • optionalvisited: Set<Partial<any>>

  Returns void

clear

• clear(): void

• Returns void

clearActionsQueue

• clearActionsQueue(): void

• Returns void

commit

• commit(): Promise<void>

• Returns Promise<void>

computeChangeSet

• computeChangeSet<T>(entity: T, type?: ChangeSetType): void

• Type parameters

  • T: object

  Parameters

  • entity: T

  • optionaltype: ChangeSetType

  Returns void

computeChangeSets

• computeChangeSets(): void

• Returns void

getById

• getById<T>(entityName: string, id: (T extends { [PrimaryKeyProp]?: PK } ? PK extends keyof T ? ReadonlyPrimary<UnwrapPrimary<T[PK]>> : PK extends keyof T[] ? ReadonlyPrimary<PrimaryPropToType<T, PK>> : PK : T extends { _id?: PK } ? string | ReadonlyPrimary<PK> : T extends { uuid?: PK } ? ReadonlyPrimary<PK> : T extends { id?: PK } ? ReadonlyPrimary<PK> : T) | (T extends { [PrimaryKeyProp]?: PK } ? PK extends keyof T ? ReadonlyPrimary<UnwrapPrimary<T[PK]>> : PK extends keyof T[] ? ReadonlyPrimary<PrimaryPropToType<T, PK>> : PK : T extends { _id?: PK } ? string | ReadonlyPrimary<PK> : T extends { uuid?: PK } ? ReadonlyPrimary<PK> : T extends { id?: PK } ? ReadonlyPrimary<PK> : T)[], schema?: string): undefined | T

• Returns entity from the identity map. For composite keys, you need to pass an array of PKs in the same order as they are defined in meta.primaryKeys.

  ---

  Type parameters

  • T: object

  Parameters

  • entityName: string

  • id: (T extends { [PrimaryKeyProp]?: PK } ? PK extends keyof T ? ReadonlyPrimary<UnwrapPrimary<T[PK]>> : PK extends keyof T[] ? ReadonlyPrimary<PrimaryPropToType<T, PK>> : PK : T extends { _id?: PK } ? string | ReadonlyPrimary<PK> : T extends { uuid?: PK } ? ReadonlyPrimary<PK> : T extends { id?: PK } ? ReadonlyPrimary<PK> : T) | (T extends { [PrimaryKeyProp]?: PK } ? PK extends keyof T ? ReadonlyPrimary<UnwrapPrimary<T[PK]>> : PK extends keyof T[] ? ReadonlyPrimary<PrimaryPropToType<T, PK>> : PK : T extends { _id?: PK } ? string | ReadonlyPrimary<PK> : T extends { uuid?: PK } ? ReadonlyPrimary<PK> : T extends { id?: PK } ? ReadonlyPrimary<PK> : T)[]

  • optionalschema: string

  Returns undefined | T

getChangeSetPersister

• getChangeSetPersister(): ChangeSetPersister

• Returns ChangeSetPersister

getChangeSets

• getChangeSets(): ChangeSet<Partial<any>>[]

• Returns ChangeSet<Partial<any>>[]

getCollectionUpdates

• getCollectionUpdates(): Collection<Partial<any>, object>[]

• Returns Collection<Partial<any>, object>[]

getExtraUpdates

• getExtraUpdates(): Set<[Partial<any>, string | string[], Reference<any> | Partial<any> | Collection<any, object> | Partial<any>[], undefined | ChangeSet<any>]>

• Returns Set<[Partial<any>, string | string[], Reference<any> | Partial<any> | Collection<any, object> | Partial<any>[], undefined | ChangeSet<any>]>

getIdentityMap

• getIdentityMap(): IdentityMap

• Returns map of all managed entities.

  ---

  Returns IdentityMap

getOriginalEntityData

• getOriginalEntityData<T>(entity: T): undefined | EntityData<T>

• Returns stored snapshot of entity state that is used for change set computation.

  ---

  Type parameters

  • T: object

  Parameters

  • entity: T

  Returns undefined | EntityData<T>

getOrphanRemoveStack

• getOrphanRemoveStack(): Set<Partial<any>>

• Returns Set<Partial<any>>

getPersistStack

• getPersistStack(): Set<Partial<any>>

• Returns Set<Partial<any>>

getRemoveStack

• getRemoveStack(): Set<Partial<any>>

• Returns Set<Partial<any>>

lock

• lock<T>(entity: T, options: LockOptions): Promise<void>

• Type parameters

  • T: object

  Parameters

  • entity: T

  • options: LockOptions

  Returns Promise<void>

merge

• merge<T>(entity: T, visited?: Set<Partial<any>>): void

• Type parameters

  • T: object

  Parameters

  • entity: T

  • optionalvisited: Set<Partial<any>>

  Returns void

persist

• persist<T>(entity: T, visited?: Set<Partial<any>>, options?: { cascade?: boolean; checkRemoveStack?: boolean }): void

• Type parameters

  • T: object

  Parameters

  • entity: T

  • optionalvisited: Set<Partial<any>>

  • options: { cascade?: boolean; checkRemoveStack?: boolean } = {}

  Returns void

recomputeSingleChangeSet

• recomputeSingleChangeSet<T>(entity: T): void

• Type parameters

  • T: object

  Parameters

  • entity: T

  Returns void

remove

• remove<T>(entity: T, visited?: Set<Partial<any>>, options?: { cascade?: boolean }): void

• Type parameters

  • T: object

  Parameters

  • entity: T

  • optionalvisited: Set<Partial<any>>

  • options: { cascade?: boolean } = {}

  Returns void

scheduleExtraUpdate

• scheduleExtraUpdate<T>(changeSet: ChangeSet<T>, props: EntityProperty<T, any>[]): void

• Type parameters

  • T: object

  Parameters

  • changeSet: ChangeSet<T>

  • props: EntityProperty<T, any>[]

  Returns void

scheduleOrphanRemoval

• scheduleOrphanRemoval(entity?: Partial<any>, visited?: Set<Partial<any>>): void

• Parameters

  • optionalentity: Partial<any>

  • optionalvisited: Set<Partial<any>>

  Returns void

shouldAutoFlush

• shouldAutoFlush<T>(meta: EntityMetadata<T>): boolean

• Type parameters

  • T: object

  Parameters

  • meta: EntityMetadata<T>

  Returns boolean

tryGetById

• tryGetById<T>(entityName: string, where: FilterQuery<T>, schema?: string, strict?: boolean): null | T

• Type parameters

  • T: object

  Parameters

  • entityName: string

  • where: FilterQuery<T>

  • optionalschema: string

  • strict: boolean = true

  Returns null | T

unsetIdentity

• unsetIdentity(entity: Partial<any>): void

• Parameters

  • entity: Partial<any>

  Returns void