@riao/dbal/migration/migration-runner.d.ts

riao database

import { Database } from '../database';
import { Migration } from './migration';
import { MigrationPackage } from './migration-package';
/**
 * Runs migrations
 */
export declare class MigrationRunner {
    protected db: Database;
    constructor(db: Database);
    /**
     * Run migrations
     * @deprecated This method will change parameters in a future release.
     * 	Switch to runWithOptions() to prepare for this change.
     *
     * @param migrations (Optional) Folder to find migrations in. Default is
     * 	db.getMigraitonDirectory()
     * @param log (Optional) Log function. Defaults to console.log
     * @param direction (Optional) Run migrations up or down?
     * @param steps (Optional) Run a certain number of steps?
     */
    run(migrations?: string | Record<string, Migration | MigrationPackage>, log?: (...args: any[]) => void, direction?: 'up' | 'down', steps?: number): Promise<void>;
    runWithOptions(options: {
        migrations?: string | Record<string, Migration | MigrationPackage>;
        log?: (...args: any[]) => void;
        direction?: 'up' | 'down';
        steps?: number;
        package?: string;
    }): Promise<void>;
    protected getMigrationName(filename: string): string;
    protected loadMigration(dir: string, filename: string): Migration;
    protected loadMigrationsFromDirectory(dir: string): Record<string, Migration>;
    protected runRiaoDbalMigrations(): Promise<void>;
}