Class MigrationFileWriter

Produces Flyway-compatible migration file names and content.

Index

Constructors

Methods

GenerateMigrationFileName GenerateTimestampSequence WrapInMigrationFile

Constructors

constructor

new MigrationFileWriter(): MigrationFileWriter
Returns MigrationFileWriter

Methods

GenerateMigrationFileName

GenerateMigrationFileName(
    objectName: string,
    action: string,
    mjVersion: string,
    migrationsDir: string,
    timestamp: Date,
    consumer?: string,
): string
Generate a Flyway-compatible migration file name. Format: {migrationsDir}/V{YYYYMMDDHHMM}_v{VERSION}.x{Consumer}{ObjectName}{Action}.sql

Example: migrations/v5/V202603120230__v5.10.x_Integration_HubSpot_CreateTables.sql
Parameters
- objectName: string
- action: string
- mjVersion: string
- migrationsDir: string
- timestamp: Date
- consumer: string = 'Schema'
Returns string
- Defined in packages/SchemaEngine/src/MigrationFileWriter.ts:18

GenerateTimestampSequence

GenerateTimestampSequence(count: number, startTime?: Date): Date[]
Generate a sequence of timestamps, each 1 minute apart, for ordering multiple migrations produced in a single pass.
Parameters
- count: number
- startTime: Date = ...
Returns Date[]
- Defined in packages/SchemaEngine/src/MigrationFileWriter.ts:64

WrapInMigrationFile

WrapInMigrationFile(
    ddl: string,
    metadata: MigrationMetadata,
    filePath: string,
): EmittedFile
Wrap DDL content in a migration file with a standard header comment.
Parameters
- ddl: string
- metadata: MigrationMetadata
- filePath: string
Returns EmittedFile
- Defined in packages/SchemaEngine/src/MigrationFileWriter.ts:36