@adonisjs/lucid/build/src/types/migrator.d.ts

SQL ORM built on top of Active Record pattern

import type { FileNode } from './database.js';
/**
 * Options accepted by migrator constructor
 */
export type MigratorOptions = {
    direction: 'up';
    connectionName?: string;
    schemaPath?: string;
    dryRun?: boolean;
    disableLocks?: boolean;
} | {
    direction: 'down';
    batch?: number;
    step?: number;
    connectionName?: string;
    dryRun?: boolean;
    disableLocks?: boolean;
};
/**
 * Shape of migrated file within migrator
 */
export type MigratedFileNode = {
    status: 'completed' | 'error' | 'pending';
    queries: string[];
    file: FileNode<unknown>;
    batch: number;
};
/**
 * Shape of migrated file within migrator
 */
export type MigrationListNode = {
    name: string;
    status: 'pending' | 'migrated' | 'corrupt' | 'squashed';
    batch?: number;
    migrationTime?: Date;
};
/**
 * Options accepted by the SchemaDumper constructor
 */
export type SchemaDumperOptions = {
    connectionName?: string;
    outputPath?: string;
    prune?: boolean;
};