Class Migration

constructor

• new Migration(
      options: {
          name: string;
          up?: MigrationFunction;
          down?: MigrationFunction;
      },
  ): Migration

  Create a new Migration instance

  Parameters

  • options: { name: string; up?: MigrationFunction; down?: MigrationFunction }

    Migration options

  Returns Migration

name

timestamp

batch

Optionalid

up

• get up(): MigrationFunction | undefined

  Get the up migration function

  Returns MigrationFunction | undefined

down

• get down(): MigrationFunction | undefined

  Get the down migration function

  Returns MigrationFunction | undefined

setUp

• setUp(up: MigrationFunction): void

  Set the up migration function

  Parameters

  • up: MigrationFunction

  Returns void

setDown

• setDown(down: MigrationFunction): void

  Set the down migration function

  Parameters

  • down: MigrationFunction

  Returns void

runUp

• runUp(queryInterface: QueryInterface, prorm: any): Promise<void>

  Execute the migration (run up)

  Parameters

  • queryInterface: QueryInterface

    The query interface to use

  • prorm: any

    The prorm instance

  Returns Promise<void>

runDown

• runDown(queryInterface: QueryInterface, prorm: any): Promise<void>

  Revert the migration (run down)

  Parameters

  • queryInterface: QueryInterface

    The query interface to use

  • prorm: any

    The prorm instance

  Returns Promise<void>

getMeta

• getMeta(): MigrationMeta

  Get migration metadata

  Returns MigrationMeta

setMeta

• setMeta(meta: MigrationMeta): void

  Set migration metadata from database record

  Parameters

  • meta: MigrationMeta

  Returns void

isExecuted

• isExecuted(): boolean

  Check if migration has been executed

  Returns boolean

StaticgetTimestamp

• getTimestamp(): string

  Get a timestamp string for the migration name

  Returns string

StaticgenerateFileName

• generateFileName(name: string): string

  Generate a migration file name with timestamp

  Parameters

  • name: string

  Returns string

StaticparseFileName

• parseFileName(filename: string): { timestamp: string; name: string } | null

  Parse migration file name to extract timestamp and name

  Parameters

  • filename: string

  Returns { timestamp: string; name: string } | null