lockRows<T extends TableRow> method

Future<void> lockRows<T extends TableRow>({
  1. required Expression where,
  2. required LockMode lockMode,
  3. required Transaction transaction,
  4. LockBehavior lockBehavior = LockBehavior.wait,
})

Acquires row-level locks on rows matching the where expression without returning the row data.

This is useful when you need to lock rows for a subsequent update without the overhead of fetching the data.

lockMode specifies the type of lock to acquire. See LockMode for available lock types.

lockBehavior controls what happens when a row is already locked. Defaults to LockBehavior.wait. See LockBehavior for options.

A transaction is required.

Implementation

Future<void> lockRows<T extends TableRow>({
  required Expression where,
  required LockMode lockMode,
  required Transaction transaction,
  LockBehavior lockBehavior = LockBehavior.wait,
}) async {
  return _databaseConnection.lockRows<T>(
    _session,
    where: where,
    lockMode: lockMode,
    lockBehavior: lockBehavior,
    transaction: transaction,
  );
}