Skip to content
← All rules
Relational DatabasesDatabase correctness

relational-databases/require-transaction-scoped-client

Work inside callback transactions and manual BEGIN flows should use the transaction-scoped client rather than a global client or pool.

transactionsclientsatomicity
TypeScript
db.transaction(async tx => { await db.account.update(data); });
Finding

Require transaction-scoped database clients.

Setup

Install the package, register its plugin factory, then enable the rule.

Install the package

pnpm add -D @scruple/relational-databases

Register the plugin

In scruple.config.ts, register the factory under the relational-databases namespace used by the rule ID.

import { relationalDatabases } from "@scruple/relational-databases";

plugins: {
  "relational-databases": relationalDatabases(),
},

Enable the rule

"relational-databases/require-transaction-scoped-client": "warn"
Package
@scruple/relational-databases
Default threshold
Plugin default
Minimum confidence
Plugin default

Released under the MIT License.