Interface IMigrationLedger

Migration history consumed by runners and readiness.

Since

0.10.0

interface IMigrationLedger {
    applied(): Promise<readonly string[]>;
    record(name: string, appliedAt: string): Promise<void>;
    remove(name: string): Promise<void>;
}

Index

Methods

applied record remove

Methods

applied

applied(): Promise<readonly string[]>
Returns Promise<readonly string[]>
Applied names; rejects with MigrationLedgerError above 10,000 rows.
- Defined in packages/database-plugin/src/interfaces/index.ts:366

record

record(name: string, appliedAt: string): Promise<void>
Records a successful migration; duplicate names propagate the adapter's create error.
Parameters
- name: string
  Migration filename without extension
- appliedAt: string
  Caller-supplied ISO-8601 timestamp
Returns Promise<void>
Completion of the insert
- Defined in packages/database-plugin/src/interfaces/index.ts:373

remove

remove(name: string): Promise<void>
Removes a reversed migration, resolving even when absent.
Parameters
- name: string
  Migration filename without extension
Returns Promise<void>
Completion of the delete
- Defined in packages/database-plugin/src/interfaces/index.ts:379