MigrationAction extends UpdateAction
The tracking document of a migration run — one row per applied version in the `migrations` collection of a database.
Modelled as a schema.org UpdateAction (the act of changing the state of the database) so the tracking collection is a real, queryable schema.org dataset rather than an opaque bookkeeping table. The inherited vocabulary carries everything a run needs:
_key/identifier: the migration version (e.g.20260612090000_AddPlaceKind) ;name/description: human labels ;actionStatus: the run lifecycle (MigrationStatus) ;startTime/endTime: ISO timestamps ;agent: who ran it (user@host) ;error: the failure message + trace, when it failed ;result: a short summary of what the run did ;instrument: the library version that ran it ;additionalType: the event family (MigrationKind) —UpdateActionfor a versioned migration,CreateActionfor adoctor --applyjournal entry.
The only field schema.org has no equivalent for is added here:
Tags
Table of Contents
Constants
- GIT_COMMIT : string = 'gitCommit'
- The `gitCommit` property key.
Properties
- $gitCommit : string|null
- The hash of the git commit the migration (or doctor apply) was run from — the history link between the database and the source tree.
Constants
GIT_COMMIT
The `gitCommit` property key.
public
string
GIT_COMMIT
= 'gitCommit'
Properties
$gitCommit
The hash of the git commit the migration (or doctor apply) was run from — the history link between the database and the source tree.
public
string|null
$gitCommit
= null
null when the working directory is not a git repository.