feat: add cascade support to truncate methods

Author: thetutlage

adonis-typings/database.ts

@@ -44,6 +44,7 @@ declare module '@ioc:Adonis/Lucid/Database' {
     readonly name: 'mssql' | 'mysql' | 'oracledb' | 'postgres' | 'redshift' | 'sqlite3'
     readonly supportsAdvisoryLocks: boolean
     readonly dateTimeFormat: string
+    truncate (table: string, cascade?: boolean): Promise<void>
     getAdvisoryLock (key: string | number, timeout?: number): Promise<boolean>
     releaseAdvisoryLock (key: string | number): Promise<boolean>
   }
@@ -125,7 +126,7 @@ declare module '@ioc:Adonis/Lucid/Database' {
     /**
      * Truncate a given table
      */
-    truncate (table: string): Promise<void>,
+    truncate (table: string, cascade?: boolean): Promise<void>,
 
     /**
      * Returns columns info for a given table

src/Dialects/Mssql.ts

@@ -9,7 +9,7 @@
 
 /// <reference path="../../adonis-typings/index.ts" />
 
-import { DialectContract } from '@ioc:Adonis/Lucid/Database'
+import { DialectContract, QueryClientContract } from '@ioc:Adonis/Lucid/Database'
 
 export class MssqlDialect implements DialectContract {
   public readonly name = 'mssql'
@@ -21,6 +21,16 @@ export class MssqlDialect implements DialectContract {
    */
   public readonly dateTimeFormat = 'yyyy-MM-dd\'T\'HH:mm:ss.SSSZZ'
 
+  constructor (private client: QueryClientContract) {
+  }
+
+  /**
+   * Truncate mssql table
+   */
+  public async truncate (table: string, _: boolean) {
+    return this.client.knexQuery().table(table).truncate()
+  }
+
   public getAdvisoryLock (): Promise<boolean> {
     throw new Error('Support for advisory locks is not implemented for mssql. Create a PR to add the feature')
   }

src/Dialects/Mysql.ts

@@ -24,6 +24,29 @@ export class MysqlDialect implements DialectContract {
   constructor (private client: QueryClientContract) {
   }
 
+  /**
+   * Truncate mysql table with option to cascade
+   */
+  public async truncate (table: string, cascade: boolean = false) {
+    if (!cascade) {
+      return this.client.knexQuery().table(table).truncate()
+    }
+
+    /**
+     * Cascade and truncate
+     */
+    const trx = await this.client.transaction()
+    try {
+      await trx.rawQuery('SET FOREIGN_KEY_CHECKS=0;')
+      await trx.knexQuery().table(table).truncate()
+      await trx.rawQuery('SET FOREIGN_KEY_CHECKS=1;')
+      await trx.commit()
+    } catch (error) {
+      await trx.rollback()
+      throw error
+    }
+  }
+
   /**
    * Attempts to add advisory lock to the database and
    * returns it's status.

src/Dialects/Oracle.ts

@@ -9,7 +9,7 @@
 
 /// <reference path="../../adonis-typings/index.ts" />
 
-import { DialectContract } from '@ioc:Adonis/Lucid/Database'
+import { DialectContract, QueryClientContract } from '@ioc:Adonis/Lucid/Database'
 
 export class OracleDialect implements DialectContract {
   public readonly name = 'oracledb'
@@ -21,6 +21,18 @@ export class OracleDialect implements DialectContract {
    */
   public readonly dateTimeFormat = 'yyyy-MM-dd HH:mm:ss'
 
+  constructor (private client: QueryClientContract) {
+  }
+
+  /**
+   * Truncate pg table with option to cascade and restart identity
+   */
+  public async truncate (table: string, cascade: boolean = false) {
+    return cascade
+      ? this.client.rawQuery(`TRUNCATE ${table} CASCADE;`)
+      : this.client.rawQuery(`TRUNCATE ${table};`)
+  }
+
   public getAdvisoryLock (): Promise<boolean> {
     throw new Error('Support for advisory locks is not implemented for oracledb. Create a PR to add the feature')
   }

src/Dialects/Pg.ts

@@ -24,6 +24,15 @@ export class PgDialect implements DialectContract {
   constructor (private client: QueryClientContract) {
   }
 
+  /**
+   * Truncate pg table with option to cascade and restart identity
+   */
+  public async truncate (table: string, cascade: boolean = false) {
+    return cascade
+      ? this.client.rawQuery(`TRUNCATE ${table} RESTART IDENTITY CASCADE;`)
+      : this.client.rawQuery(`TRUNCATE ${table};`)
+  }
+
   /**
    * Attempts to add advisory lock to the database and
    * returns it's status.

src/Dialects/Redshift.ts

@@ -9,7 +9,7 @@
 
 /// <reference path="../../adonis-typings/index.ts" />
 
-import { DialectContract } from '@ioc:Adonis/Lucid/Database'
+import { DialectContract, QueryClientContract } from '@ioc:Adonis/Lucid/Database'
 
 export class RedshiftDialect implements DialectContract {
   public readonly name = 'redshift'
@@ -21,6 +21,20 @@ export class RedshiftDialect implements DialectContract {
    */
   public readonly dateTimeFormat = 'yyyy-MM-dd\'T\'HH:mm:ss.SSSZZ'
 
+  constructor (private client: QueryClientContract) {
+  }
+
+  /**
+   * Truncate redshift table with option to cascade and restart identity.
+   *
+   * NOTE: ASSUMING FEATURE PARITY WITH POSTGRESQL HERE (NOT TESTED)
+   */
+  public async truncate (table: string, cascade: boolean = false) {
+    return cascade
+      ? this.client.rawQuery(`TRUNCATE ${table} RESTART IDENTITY CASCADE;`)
+      : this.client.rawQuery(`TRUNCATE ${table};`)
+  }
+
   /**
    * Redshift doesn't support advisory locks. Learn more:
    * https://tableplus.com/blog/2018/10/redshift-vs-postgres-database-comparison.html

src/Dialects/Sqlite.ts

@@ -9,7 +9,7 @@
 
 /// <reference path="../../adonis-typings/index.ts" />
 
-import { DialectContract } from '@ioc:Adonis/Lucid/Database'
+import { DialectContract, QueryClientContract } from '@ioc:Adonis/Lucid/Database'
 
 export class SqliteDialect implements DialectContract {
   public readonly name = 'sqlite3'
@@ -21,6 +21,16 @@ export class SqliteDialect implements DialectContract {
    */
   public readonly dateTimeFormat = 'yyyy-MM-dd HH:mm:ss'
 
+  constructor (private client: QueryClientContract) {
+  }
+
+  /**
+   * Truncate SQLITE tables
+   */
+  public async truncate (table: string, _: boolean) {
+    return this.client.knexQuery().table(table).truncate()
+  }
+
   /**
    * Attempts to add advisory lock to the database and
    * returns it's status.

src/QueryClient/index.ts

@@ -98,8 +98,8 @@ export class QueryClient implements QueryClientContract {
   /**
    * Truncate table
    */
-  public async truncate (table: string): Promise<void> {
-    await this.getWriteClient().table(table).truncate()
+  public async truncate (table: string, cascade: boolean = false): Promise<void> {
+    await this.dialect.truncate(table, cascade)
   }
 
   /**

src/TransactionClient/index.ts

@@ -81,8 +81,8 @@ export class TransactionClient extends EventEmitter implements TransactionClient
   /**
    * Truncate tables inside a transaction
    */
-  public async truncate (table: string): Promise<void> {
-    await this.knexClient.table(table).truncate()
+  public async truncate (table: string, cascade: boolean = false): Promise<void> {
+    await this.dialect.truncate(table, cascade)
   }
 
   /**

test/database/query-client.spec.ts

@@ -80,12 +80,42 @@ test.group('Query client', (group) => {
 
     const client = new QueryClient('write', connection)
     const column = await client.columnsInfo('users', 'id')
-    assert.deepEqual(column, {
-      type: 'integer',
-      maxLength: null,
-      nullable: false,
-      defaultValue: null,
+    assert.equal(column.type, 'integer')
+  })
+
+  test('truncate table with cascade', async (_assert) => {
+    const connection = new Connection('primary', getConfig(), getLogger())
+    connection.connect()
+
+    /**
+     * Create tables
+     */
+    await connection.client?.schema.createTableIfNotExists('test_users', (table) => {
+      table.increments('id').primary()
+      table.string('username')
     })
+    await connection.client?.schema.createTableIfNotExists('test_profiles', (table) => {
+      table.increments('id').primary()
+      table.integer('user_id').references('test_users.id').onDelete('CASCADE')
+    })
+
+    /**
+     * Insert table
+     */
+    const returnValues = await connection.client?.table('test_users').insert({ username: 'virk' })
+    await connection.client?.table('test_profiles').insert({ user_id: returnValues![0] })
+
+    /**
+     * Truncate
+     */
+    const client = new QueryClient('write', connection)
+    await client.truncate('test_users', true)
+
+    /**
+     * Drop tables
+     */
+    await connection.client?.schema.dropTable('test_profiles')
+    await connection.client?.schema.dropTable('test_users')
   })
 })