Skip to main content

Interface: MigrationScript

Defined in: Data/Migration/MigrationTypes.ts:42

A parsed migration file, ready to run.

Properties​

description?​

optional description?: string

Defined in: Data/Migration/MigrationTypes.ts:50

Free-text @description from the header, if present.

filePath?​

optional filePath?: string

Defined in: Data/Migration/MigrationTypes.ts:54

Where it was loaded from, for error messages. Absent for inline scripts.

name​

name: string

Defined in: Data/Migration/MigrationTypes.ts:46

Remainder of the filename, e.g. 'markup_color_hex'.

source​

source: string

Defined in: Data/Migration/MigrationTypes.ts:52

Raw file contents. Used for the checksum.

target​

target: MigrationTarget

Defined in: Data/Migration/MigrationTypes.ts:48

Which database this migration targets.

version​

version: string

Defined in: Data/Migration/MigrationTypes.ts:44

Zero-padded ordinal from the filename, e.g. '007'. Identity in the ledger.