@adonisjs/lucid/build/commands/schema_dump.d.ts

SQL ORM built on top of Active Record pattern

import { BaseCommand } from '@adonisjs/core/ace';
import { type CommandOptions } from '@adonisjs/core/types/ace';
/**
 * Dump the current database schema to a SQL file. The dump also embeds the
 * migrations bookkeeping tables, so that future runs can bootstrap from the
 * SQL snapshot and treat older migrations as already executed.
 */
export default class SchemaDump extends BaseCommand {
    static commandName: string;
    static description: string;
    static options: CommandOptions;
    /**
     * Custom connection for dumping the schema.
     */
    connection: string;
    /**
     * Custom path for storing the generated SQL dump.
     */
    path: string;
    /**
     * Delete all migration files after creating the dump.
     */
    prune: boolean;
    private dumper?;
    /**
     * Handle command execution
     */
    run(): Promise<void>;
    /**
     * Close database connections only when executed as the main command
     */
    completed(): Promise<void>;
}