feat: add disable-locks flag (#932)

Author: Reptiluka

adonis-typings/migrator.ts

@@ -20,12 +20,14 @@ declare module '@ioc:Adonis/Lucid/Migrator' {
         direction: 'up'
         connectionName?: string
         dryRun?: boolean
+        disableLocks?: boolean
       }
     | {
         direction: 'down'
         batch?: number
         connectionName?: string
         dryRun?: boolean
+        disableLocks?: boolean
       }
 
   /**
@@ -53,6 +55,7 @@ declare module '@ioc:Adonis/Lucid/Migrator' {
    */
   export interface MigratorContract extends EventEmitter {
     dryRun: boolean
+    disableLocks: boolean
     version: number
     direction: 'up' | 'down'
     status: 'completed' | 'skipped' | 'pending' | 'error'

commands/Migration/Refresh.ts

@@ -44,6 +44,12 @@ export default class Refresh extends BaseCommand {
   @flags.boolean({ description: 'Run seeders' })
   public seed: boolean
 
+  /**
+   * Disable advisory locks
+   */
+  @flags.boolean({ description: 'Disable advisory locks' })
+  public disableLocks: boolean
+
   /**
    * Converting command properties to arguments
    */
@@ -61,6 +67,10 @@ export default class Refresh extends BaseCommand {
       args.push('--dry-run')
     }
 
+    if (this.disableLocks) {
+      args.push('--disable-locks')
+    }
+
     return args
   }
 

commands/Migration/Reset.ts

@@ -38,6 +38,12 @@ export default class Reset extends BaseCommand {
   @flags.boolean({ description: 'Do not run actual queries. Instead view the SQL output' })
   public dryRun: boolean
 
+  /**
+   * Disable advisory locks
+   */
+  @flags.boolean({ description: 'Disable advisory locks' })
+  public disableLocks: boolean
+
   /**
    * Converting command properties to arguments
    */
@@ -55,6 +61,10 @@ export default class Reset extends BaseCommand {
       args.push('--dry-run')
     }
 
+    if (this.disableLocks) {
+      args.push('--disable-locks')
+    }
+
     return args
   }
 

commands/Migration/Rollback.ts

@@ -57,6 +57,12 @@ export default class Migrate extends MigrationsBase {
   @flags.boolean({ description: 'A compact single-line output' })
   public compactOutput: boolean = false
 
+  /**
+   * Disable advisory locks
+   */
+  @flags.boolean({ description: 'Disable advisory locks' })
+  public disableLocks: boolean
+
   /**
    * Instantiating the migrator instance
    */
@@ -69,6 +75,7 @@ export default class Migrate extends MigrationsBase {
       connectionName: this.connection,
       batch: this.batch,
       dryRun: this.dryRun,
+      disableLocks: this.disableLocks
     })
   }
 

commands/Migration/Run.ts

@@ -48,6 +48,12 @@ export default class Migrate extends MigrationsBase {
   @flags.boolean({ description: 'A compact single-line output' })
   public compactOutput: boolean = false
 
+  /**
+   * Disable advisory locks
+   */
+  @flags.boolean({ description: 'Disable advisory locks' })
+  public disableLocks: boolean
+
   /**
    * Instantiating the migrator instance
    */
@@ -59,6 +65,7 @@ export default class Migrate extends MigrationsBase {
       direction: 'up',
       connectionName: this.connection,
       dryRun: this.dryRun,
+      disableLocks: this.disableLocks,
     })
   }
 

src/Migrator/index.ts

@@ -80,6 +80,11 @@ export class Migrator extends EventEmitter implements MigratorContract {
    */
   public dryRun: boolean = !!this.options.dryRun
 
+  /**
+   * Disable advisory locks
+   */
+  public disableLocks: boolean = !!this.options.disableLocks
+
   /**
    * An array of files we have successfully migrated. The files are
    * collected regardless of `up` or `down` methods
@@ -252,7 +257,7 @@ export class Migrator extends EventEmitter implements MigratorContract {
    * to the real execution cycle
    */
   private async acquireLock() {
-    if (!this.client.dialect.supportsAdvisoryLocks) {
+    if (!this.client.dialect.supportsAdvisoryLocks || this.disableLocks) {
       return
     }
 
@@ -268,7 +273,7 @@ export class Migrator extends EventEmitter implements MigratorContract {
    * `Mysql`, `PostgreSQL` and `MariaDb` for now.
    */
   private async releaseLock() {
-    if (!this.client.dialect.supportsAdvisoryLocks) {
+    if (!this.client.dialect.supportsAdvisoryLocks || this.disableLocks) {
       return
     }