ChangeSetPersister

Index

Constructors

• constructor

Methods

• executeDeletes
• executeInserts
• executeUpdates
• mapReturnedValues

Constructors

constructor

• new ChangeSetPersister(driver: IDatabaseDriver<Connection>, metadata: MetadataStorage, hydrator: IHydrator, factory: EntityFactory, validator: EntityValidator, config: Configuration<IDatabaseDriver<Connection>, EntityManager<IDatabaseDriver<Connection>>>): ChangeSetPersister

• Parameters

  • driver: IDatabaseDriver<Connection>

  • metadata: MetadataStorage

  • hydrator: IHydrator

  • factory: EntityFactory

  • validator: EntityValidator

  • config: Configuration<IDatabaseDriver<Connection>, EntityManager<IDatabaseDriver<Connection>>>

  Returns ChangeSetPersister

Methods

executeDeletes

• executeDeletes(changeSets: ChangeSet<T>[], options?: DriverMethodOptions, withSchema?: boolean): Promise<void>

• Parameters

  • changeSets: ChangeSet<T>[]

  • optionaloptions: DriverMethodOptions

  • optionalwithSchema: boolean

  Returns Promise<void>

executeInserts

• executeInserts(changeSets: ChangeSet<T>[], options?: DriverMethodOptions, withSchema?: boolean): Promise<void>

• Parameters

  • changeSets: ChangeSet<T>[]

  • optionaloptions: DriverMethodOptions

  • optionalwithSchema: boolean

  Returns Promise<void>

executeUpdates

• executeUpdates(changeSets: ChangeSet<T>[], batched: boolean, options?: DriverMethodOptions, withSchema?: boolean): Promise<void>

• Parameters

  • changeSets: ChangeSet<T>[]

  • batched: boolean

  • optionaloptions: DriverMethodOptions

  • optionalwithSchema: boolean

  Returns Promise<void>

mapReturnedValues

• mapReturnedValues(entity: undefined | null | T, payload: EntityDictionary<T>, row: undefined | Dictionary, meta: EntityMetadata<T>, upsert?: boolean): void

• Maps values returned via returning statement (postgres) or the inserted id (other sql drivers). No need to handle composite keys here as they need to be set upfront. We do need to map to the change set payload too, as it will be used in the originalEntityData for new entities.

  ---

  Parameters

  • entity: undefined | null | T

  • payload: EntityDictionary<T>

  • row: undefined | Dictionary

  • meta: EntityMetadata<T>

  • upsert: boolean = false

  Returns void