Class: BulkUpdateBuilder<T>

Defined in: src/bulk/BulkUpdateBuilder.ts:36

High-performance batch update engine that processes large numbers of entity mutations in transactions.

Automatically updates @UpdatedAt timestamps and validates key columns.

Usecase

Ideal for mass status updates, bulk price adjustments, and inventory synchronization.

Example

PostgreSQL / MySQL / SQLite / MSSQL:

const bulkUpdater = new BulkUpdateBuilder(adapter, 'orders', metadata);
const updatedCount = await bulkUpdater.execute(modifiedOrders, {
  keys: ['id'],
  update: ['status', 'processedAt'],
  batchSize: 500,
});

Type Parameters

Type Parameter
T extends object

Constructors

Constructor

new BulkUpdateBuilder<T>(adapter, tableName, metadata?, transaction?): BulkUpdateBuilder<T>

Defined in: src/bulk/BulkUpdateBuilder.ts:37

Parameters

Parameter	Type
adapter	IDbAdapter
tableName	string
metadata?	EntityMetadata
transaction?	DbTransaction

Returns

BulkUpdateBuilder<T>

Methods

execute()

execute(entities, options): Promise<number>

Defined in: src/bulk/BulkUpdateBuilder.ts:51

Executes the bulk update across the provided entities.

Parameters

Parameter	Type	Description
entities	Partial<T>[]	Array of entities containing update values and identifying keys.
options	BulkUpdateOptions<T>	Bulk update configuration.

Returns

Promise<number>

Total number of rows updated.