feat: accept custom data to set set on query event

adonis-typings/querybuilder.ts

@@ -715,6 +715,7 @@ declare module '@ioc:Adonis/Lucid/DatabaseQueryBuilder' {
     debug (debug: boolean): this
     timeout (time: number, options?: { cancel: boolean }): this
     useTransaction (trx: TransactionClientContract): this
+    reporterData (data: any): this
     toQuery (): string
     exec (): Promise<Result>
     toSQL (): knex.Sql

src/Database/QueryBuilder/Database.ts

@@ -56,6 +56,7 @@ export class DatabaseQueryBuilder extends Chainable implements DatabaseQueryBuil
    */
   protected static macros = {}
   protected static getters = {}
+  private customReporterData: any
 
   /**
    * Ensures that we are not executing `update` or `del` when using read only
@@ -74,9 +75,19 @@ export class DatabaseQueryBuilder extends Chainable implements DatabaseQueryBuil
     return {
       connection: this.client.connectionName,
       inTransaction: this.client.isTransaction,
+      ...this.customReporterData,
     }
   }
 
+  /**
+   * Define custom reporter data. It will be merged with
+   * the existing data
+   */
+  public reporterData (data: any) {
+    this.customReporterData = data
+    return this
+  }
+
   /**
    * Delete rows under the current query
    */

src/Database/QueryBuilder/Insert.ts

@@ -25,6 +25,8 @@ export class InsertQueryBuilder extends Macroable implements InsertQueryBuilderC
     super()
   }
 
+  private customReporterData: any
+
   /**
    * Required by macroable
    */
@@ -38,9 +40,19 @@ export class InsertQueryBuilder extends Macroable implements InsertQueryBuilderC
     return {
       connection: this.client.connectionName,
       inTransaction: this.client.isTransaction,
+      ...this.customReporterData,
     }
   }
 
+  /**
+   * Define custom reporter data. It will be merged with
+   * the existing data
+   */
+  public reporterData (data: any) {
+    this.customReporterData = data
+    return this
+  }
+
   /**
    * Define table for performing the insert query
    */

src/Database/QueryBuilder/Raw.ts

@@ -19,6 +19,8 @@ import { QueryRunner } from '../../QueryRunner'
  * Exposes the API to execute raw queries
  */
 export class RawQueryBuilder implements RawQueryBuilderContract {
+  private customReporterData: any
+
   constructor (public knexQuery: knex.Raw, public client: QueryClientContract) {
   }
 
@@ -29,9 +31,19 @@ export class RawQueryBuilder implements RawQueryBuilderContract {
     return {
       connection: this.client.connectionName,
       inTransaction: this.client.isTransaction,
+      ...this.customReporterData,
     }
   }
 
+  /**
+   * Define custom reporter data. It will be merged with
+   * the existing data
+   */
+  public reporterData (data: any) {
+    this.customReporterData = data
+    return this
+  }
+
   /**
    * Wrap the query with before/after strings.
    */

src/Orm/QueryBuilder/index.ts

@@ -85,6 +85,11 @@ export class ModelQueryBuilder extends Chainable implements ModelQueryBuilderCon
    */
   protected wrapResultsToModelInstances: boolean = true
 
+  /**
+   * Custom reporter data
+   */
+  private customReporterData: any
+
   /**
    * Options that must be passed to all new model instances
    */
@@ -120,7 +125,8 @@ export class ModelQueryBuilder extends Chainable implements ModelQueryBuilderCon
    */
   private async execQuery () {
     const isWriteQuery = ['update', 'del', 'insert'].includes(this.knexQuery['_method'])
-    const rows = await new QueryRunner(this.client, this.getQueryData()).run(this.knexQuery)
+    const queryData = Object.assign(this.getQueryData(), this.customReporterData)
+    const rows = await new QueryRunner(this.client, queryData).run(this.knexQuery)
 
     /**
      * Return the rows as it is when query is a write query
@@ -167,6 +173,15 @@ export class ModelQueryBuilder extends Chainable implements ModelQueryBuilderCon
     }
   }
 
+  /**
+   * Define custom reporter data. It will be merged with
+   * the existing data
+   */
+  public reporterData (data: any) {
+    this.customReporterData = data
+    return this
+  }
+
   /**
    * Clone the current query builder
    */

test/orm/model-query-builder.spec.ts

@@ -332,4 +332,20 @@ test.group('Model query builder', (group) => {
     assert.equal(sql, knexSql)
     assert.deepEqual(bindings, knexBindings)
   })
+
+  test('make aggregate queries with the model query builder', async (assert) => {
+    class User extends BaseModel {
+      @column({ isPrimary: true })
+      public id: number
+
+      @column()
+      public username: string
+    }
+
+    User.boot()
+    await db.insertQuery().table('users').insert([{ username: 'virk' }, { username: 'nikk' }])
+
+    const users = await User.query().count('* as total')
+    assert.equal(Number(users[0].total), 2)
+  })
 })