api.transactionDatabase()

​

api.transactionDatabase()

• Commits automatically when the callback resolves.
• Rolls back automatically when the callback throws.
• The default timeout is 15,000 ms.
• Use { flexTimeout: true } when the transaction intentionally needs the enclosing execution’s remaining timeout budget.
• Long transactions reserve a database connection and may retain locks; keep waits and remote side effects outside the callback when possible.
• SERIALIZABLE is the default isolation level.
• Parallel tx.* operations are rejected; await each tx.* call sequentially.

​

Signature

static transactionDatabase<T>(
      callback: (tx: DatabaseTransactionApi) => Promise<T> | T,
      options?: DatabaseTransactionStartOptions,
    ): Promise<T>;

​

Example

await api.transactionDatabase(async (tx) => {
  const existing = await tx.getDatabaseData(
    'contracts',
    { filter: { field: 'contractId', op: 'eq', value: api.input('contractId') }, take: 1 },
    { lock: 'update' },
  );
  if (existing.results === 0) {
    await tx.insertDatabaseData('contracts', [
      { contractId: api.input('contractId') },
    ]);
  }
});