@adonisjs/lucid/build/commands/migration/rollback.js

SQL ORM built on top of Active Record pattern

/*
 * @adonisjs/lucid
 *
 * (c) Harminder Virk <virk@adonisjs.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */
var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
    return c > 3 && r && Object.defineProperty(target, key, r), r;
};
import { flags } from '@adonisjs/core/ace';
import MigrationsBase from './_base.js';
import { MigrationRunner } from '../../src/migration/runner.js';
/**
 * The command is meant to migrate the database by executing migrations
 * in `down` direction.
 */
export default class Rollback extends MigrationsBase {
    static commandName = 'migration:rollback';
    static description = 'Rollback migrations to a specific batch number';
    static options = {
        startApp: true,
    };
    migrator;
    /**
     * Instantiating the migrator instance
     */
    async instantiateMigrator() {
        const db = await this.app.container.make('lucid.db');
        this.migrator = new MigrationRunner(db, this.app, {
            direction: 'down',
            connectionName: this.connection,
            batch: this.batch,
            step: this.step,
            dryRun: this.dryRun,
            disableLocks: this.disableLocks,
        });
    }
    /**
     * Run as a subcommand. Never close database connections or exit
     * process inside this method
     */
    async runAsSubCommand() {
        const db = await this.app.container.make('lucid.db');
        this.connection = this.connection || db.primaryConnectionName;
        /**
         * Continue with migrations when not in prod or force flag
         * is passed
         */
        let continueMigrations = !this.app.inProduction || this.force;
        if (!continueMigrations) {
            continueMigrations = await this.takeProductionConsent();
        }
        /**
         * Do not continue when in prod and the prompt was cancelled
         */
        if (!continueMigrations) {
            return;
        }
        /**
         * Invalid database connection
         */
        if (!db.manager.has(this.connection)) {
            this.printNotAValidConnection(this.connection);
            this.exitCode = 1;
            return;
        }
        await this.instantiateMigrator();
        await this.runMigrations(this.migrator, this.connection);
    }
    /**
     * Branching out, so that if required we can implement
     * "runAsMain" separately from "runAsSubCommand".
     *
     * For now, they both are the same
     */
    runAsMain() {
        return this.runAsSubCommand();
    }
    /**
     * Handle command
     */
    async run() {
        if (this.isMain) {
            await this.runAsMain();
        }
        else {
            await this.runAsSubCommand();
        }
    }
    /**
     * Lifecycle method invoked by ace after the "run"
     * method.
     */
    async completed() {
        if (this.migrator && this.isMain) {
            await this.migrator.close();
        }
    }
}
__decorate([
    flags.string({ description: 'Define a custom database connection', alias: 'c' })
], Rollback.prototype, "connection", void 0);
__decorate([
    flags.boolean({ description: 'Explicitly force to run migrations in production' })
], Rollback.prototype, "force", void 0);
__decorate([
    flags.boolean({ description: 'Do not run actual queries. Instead view the SQL output' })
], Rollback.prototype, "dryRun", void 0);
__decorate([
    flags.number({
        description: 'Define custom batch number for rollback. Use 0 to rollback to initial state',
    })
], Rollback.prototype, "batch", void 0);
__decorate([
    flags.number({
        description: 'The number of migrations to be reverted',
    })
], Rollback.prototype, "step", void 0);
__decorate([
    flags.boolean({ description: 'A compact single-line output' })
], Rollback.prototype, "compactOutput", void 0);
__decorate([
    flags.boolean({ description: 'Disable locks acquired to run migrations safely' })
], Rollback.prototype, "disableLocks", void 0);