Class Migrator

Migrator class - Manages database migrations

Index

Constructors

Methods

getPrormMigration getQueryInterface migration findMigrations getMigrations getMigration pending executed status up down downToBatch getDatabaseVersion syncMigrationsTable setPath getPath

Constructors

constructor

new Migrator(options: MigratorOptions): Migrator
Create a new Migrator instance
Parameters
- options: MigratorOptions
  Configuration options
Returns Migrator
- Defined in migrations/migrator.ts:109

Methods

getPrormMigration

getPrormMigration(): PrormMigration
Get the PrormMigration instance

Returns PrormMigration
- Defined in migrations/migrator.ts:135

getQueryInterface

getQueryInterface(): QueryInterface
Get the QueryInterface

Returns QueryInterface
- Defined in migrations/migrator.ts:142

migration

migration(migrationPath: string): Promise<void>
Register a migration file
Parameters
- migrationPath: string
  Path to the migration file
Returns Promise<void>
- Defined in migrations/migrator.ts:150

findMigrations

findMigrations(): Promise<void>
Find and register all migration files in a directory

Returns Promise<void>
- Defined in migrations/migrator.ts:229

getMigrations

getMigrations(): Migration[]
Get all registered migrations

Returns Migration[]
- Defined in migrations/migrator.ts:252

getMigration

getMigration(name: string): Migration | undefined
Get migration by name
Parameters
- name: string
Returns Migration | undefined
- Defined in migrations/migrator.ts:259

pending

pending(): Promise<Migration[]>
List pending (not yet executed) migrations

Returns Promise<Migration[]>
- Defined in migrations/migrator.ts:266

executed

executed(): Promise<Migration[]>
List all executed migrations

Returns Promise<Migration[]>
- Defined in migrations/migrator.ts:293

status

status(): Promise<MigrationStatus[]>
Get migration status for all migrations

Returns Promise<MigrationStatus[]>
- Defined in migrations/migrator.ts:316

up

up(options?: { migration?: string; batch?: number }): Promise<MigratorResult>
Run all pending migrations
Parameters
- Optionaloptions: { migration?: string; batch?: number }
  Migration options
Returns Promise<MigratorResult>
- Defined in migrations/migrator.ts:345

down

down(options?: { migration?: string; steps?: number }): Promise<MigratorResult>
Revert migrations
Parameters
- Optionaloptions: { migration?: string; steps?: number }
  Revert options
Returns Promise<MigratorResult>
- Defined in migrations/migrator.ts:388

downToBatch

downToBatch(targetBatch: number): Promise<MigratorResult>
Revert all executed migrations with a batch number greater than targetBatch, actually running each migration's down() function (loaded the same way up() is) before removing its tracking row.
Parameters
- targetBatch: number
  Batch number to revert down to
Returns Promise<MigratorResult>
- Defined in migrations/migrator.ts:445

getDatabaseVersion

getDatabaseVersion(): Promise<string>
Get database version

Returns Promise<string>
- Defined in migrations/migrator.ts:468

syncMigrationsTable

syncMigrationsTable(): Promise<void>
Sync the migrations table

Returns Promise<void>
- Defined in migrations/migrator.ts:475

setPath

setPath(newPath: string): void
Set the migration path
Parameters
- newPath: string
Returns void
- Defined in migrations/migrator.ts:482

getPath

getPath(): string
Get the current migration path

Returns string
- Defined in migrations/migrator.ts:490