typeorm/commands/MigrationGenerateCommand.d.ts

Data-Mapper ORM for TypeScript and ES2023+. Supports MySQL/MariaDB, PostgreSQL, MS SQL Server, Oracle, SAP HANA, SQLite, MongoDB databases.

import type yargs from "yargs";
/**
 * Generates a new migration file with sql needs to be executed to update schema.
 */
export declare class MigrationGenerateCommand implements yargs.CommandModule {
    command: string;
    describe: string;
    builder(args: yargs.Argv): yargs.Argv<{
        path: string;
    } & {
        dataSource: string;
    } & {
        p: boolean;
    } & {
        o: boolean;
    } & {
        esm: boolean;
    } & {
        dr: boolean;
    } & {
        ch: boolean;
    } & {
        t: number | boolean;
    }>;
    handler(args: yargs.Arguments<any & {
        path: string;
    }>): Promise<void>;
    /**
     * Formats query parameters for migration queries if parameters actually exist
     *
     * @param parameters
     */
    protected static queryParams(parameters: any[] | undefined): string;
    /**
     * Gets contents of the migration file.
     *
     * @param name
     * @param timestamp
     * @param upSqls
     * @param downSqls
     */
    protected static getTemplate(name: string, timestamp: number, upSqls: string[], downSqls: string[]): string;
    /**
     * Gets contents of the migration file in Javascript.
     *
     * @param name
     * @param timestamp
     * @param upSqls
     * @param downSqls
     * @param esm
     */
    protected static getJavascriptTemplate(name: string, timestamp: number, upSqls: string[], downSqls: string[], esm: boolean): string;
    /**
     * Escapes a SQL string for safe embedding inside a JavaScript template literal.
     * Prevents backslash consumption, backtick breakout, and `${...}` interpolation
     * from DB-introspected schema metadata (e.g. column COMMENT, DEFAULT).
     *
     * @param query
     */
    protected static escapeTemplateLiteral(query: string): string;
    /**
     *
     * @param query
     */
    protected static prettifyQuery(query: string): string;
}