feat: add support for creating transaction client from model

src/orm/base_model/index.ts

@@ -11,7 +11,11 @@ import { DateTime } from 'luxon'
 import Hooks from '@poppinss/hooks'
 import lodash from '@poppinss/utils/lodash'
 import { Exception, defineStaticProperty } from '@poppinss/utils'
-import { QueryClientContract, TransactionClientContract } from '../../types/database.js'
+import {
+  IsolationLevels,
+  QueryClientContract,
+  TransactionClientContract,
+} from '../../types/database.js'
 
 import {
   LucidRow,
@@ -241,6 +245,20 @@ class BaseModelImpl implements LucidRow {
     return this.$adapter.query(this, options)
   }
 
+  /**
+   * Returns the model query instance for the given model
+   */
+  static async transaction(
+    options?: ModelAdapterOptions & { isolationLevel?: IsolationLevels }
+  ): Promise<TransactionClientContract> {
+    const client = this.$adapter.modelConstructorClient(this, options)
+    if (client.isTransaction) {
+      return client as TransactionClientContract
+    }
+
+    return client.transaction()
+  }
+
   /**
    * Create a model instance from the adapter result. The result value must
    * be a valid object, otherwise `null` is returned.

src/types/model.ts

@@ -9,7 +9,12 @@
 
 import { DateTime } from 'luxon'
 import type Hooks from '@poppinss/hooks'
-import { DialectContract, QueryClientContract, TransactionClientContract } from './database.js'
+import {
+  DialectContract,
+  IsolationLevels,
+  QueryClientContract,
+  TransactionClientContract,
+} from './database.js'
 
 import {
   Update,
@@ -1143,6 +1148,14 @@ export interface LucidModel {
     options?: ModelAdapterOptions
   ): ModelQueryBuilderContract<Model, Result>
 
+  /**
+   * Returns transaction client from the model. It is same as
+   * calling "db.transaction"
+   */
+  transaction(
+    options?: ModelAdapterOptions & { isolationLevel?: IsolationLevels }
+  ): Promise<TransactionClientContract>
+
   /**
    * Truncate model table
    */

test/orm/base_model.spec.ts

@@ -8277,3 +8277,44 @@ test.group('Base Model | lockForUpdate', (group) => {
     )
   })
 })
+
+test.group('Base Model | transaction', (group) => {
+  group.setup(async () => {
+    await setup()
+  })
+
+  group.teardown(async () => {
+    await cleanupTables()
+  })
+
+  group.each.teardown(async () => {
+    await resetTables()
+  })
+
+  test('create transaction client using model', async ({ fs, assert }) => {
+    const app = new AppFactory().create(fs.baseUrl, () => {})
+    await app.init()
+    const db = getDb()
+    const adapter = ormAdapter(db)
+
+    const BaseModel = getBaseModel(adapter)
+
+    class User extends BaseModel {
+      @column({ isPrimary: true })
+      declare id: number
+
+      @column()
+      declare username: string
+
+      @column()
+      declare email: string
+    }
+
+    const client = await User.transaction()
+    await client.insertQuery().table('users').insert({ username: 'virk' })
+    await client.rollback()
+    const user = await User.find(1)
+
+    assert.isNull(user)
+  })
+})