SchemaStep
Defined in: packages/core/src/history/historyMigrations.ts:78
One ordered step of a file’s schema.
Properties
Section titled “Properties”describe
Section titled “describe”describe:
string
Defined in: packages/core/src/history/historyMigrations.ts:82
What the step does, for a reader of this list.
version
Section titled “version”version:
number
Defined in: packages/core/src/history/historyMigrations.ts:80
The user_version the file has once this step has run. Strictly increasing.
Methods
Section titled “Methods”up(
db):void
Defined in: packages/core/src/history/historyMigrations.ts:84
Apply the step. Runs inside a transaction; must be idempotent (IF NOT EXISTS).
Parameters
Section titled “Parameters”DatabaseSync
Returns
Section titled “Returns”void