refactor: deprecate useTransaction method usage on query builder

adonisjs · Dec 14, 2023 · 223db39 · 223db39
1 parent b44d15e
commit 223db39
Show file tree

Hide file tree

Showing 5 changed files with 36 additions and 4 deletions.
diff --git a/src/database/query_builder/database.ts b/src/database/query_builder/database.ts
@@ -268,7 +268,13 @@ export class DatabaseQueryBuilder extends Chainable implements DatabaseQueryBuil
   }
 
   /**
-   * Run query inside the given transaction
+   * @deprecated
+   * Do not use this method. Instead create a query using the
+   * transaction client directly.
+   *
+   * ```ts
+   * trx.query()
+   * ```
    */
   useTransaction(transaction: TransactionClientContract): this {
     this.knexQuery.transacting(transaction.knexClient)

diff --git a/src/database/query_builder/insert.ts b/src/database/query_builder/insert.ts
@@ -180,7 +180,13 @@ export class InsertQueryBuilder extends Macroable implements InsertQueryBuilderC
   }
 
   /**
-   * Run query inside the given transaction
+   * @deprecated
+   * Do not use this method. Instead create a query using the
+   * transaction client directly.
+   *
+   * ```ts
+   * trx.insertQuery()
+   * ```
    */
   useTransaction(transaction: TransactionClientContract) {
     this.knexQuery.transacting(transaction.knexClient)

diff --git a/src/database/query_builder/raw.ts b/src/database/query_builder/raw.ts
@@ -88,7 +88,13 @@ export class RawQueryBuilder implements RawQueryBuilderContract {
   }
 
   /**
-   * Run query inside the given transaction
+   * @deprecated
+   * Do not use this method. Instead create a query using the
+   * transaction client directly.
+   *
+   * ```ts
+   * trx.rawQuery()
+   * ```
    */
   useTransaction(transaction: TransactionClientContract) {
     this.knexQuery.transacting(transaction.knexClient)

diff --git a/src/orm/query_builder/index.ts b/src/orm/query_builder/index.ts
@@ -742,7 +742,12 @@ export class ModelQueryBuilder
   }
 
   /**
-   * Run query inside the given transaction
+   * @deprecated
+   * Do not use this method. Instead create a query with options.client
+   *
+   * ```ts
+   * Model.query({ client: trx })
+   * ```
    */
   useTransaction(transaction: TransactionClientContract) {
     this.knexQuery.transacting(transaction.knexClient)

diff --git a/src/types/querybuilder.ts b/src/types/querybuilder.ts
@@ -895,6 +895,15 @@ export interface InsertQueryBuilderContract<Result = any>
 export interface ExcutableQueryBuilderContract<Result> extends Promise<Result> {
   debug(debug: boolean): this
   timeout(time: number, options?: { cancel: boolean }): this
+  /**
+   * @deprecated
+   * Do not use this method. Instead create a query with options.client
+   *
+   * ```ts
+   * Model.query({ client: trx })
+   * Database.query({ client: trx })
+   * ```
+   */
   useTransaction(trx: TransactionClientContract): this
   reporterData(data: any): this
   toQuery(): string