[CaptionSettings]
Available since Exponential 6.0.15 (in development, not in a release yet).
Summary
The group [CaptionSettings] of settings/migration.ini.
File
settings/migration.ini; override it in settings/override/migration.ini.append.php, in a siteaccess or in an extension.
Settings
| Setting | Default | Description |
|---|---|---|
| Before | enabled | Captions are exp:upgrade's (./console exp:upgrade:captions lists them all): git_manager's full caption, or the database dump of exp:upgrade without git_manager, with settings/override and the commits of the code. enabled: a caption (kind migration-pre) is taken before a run that applies migrations. When none can be taken (an engine without a dump, a full disk) the run goes on with a warning: there is then no automatic restore. |
| After | enabled | enabled: a caption (kind migration-post, labelled with the migrations that ran) is taken after a run that succeeded: the next run reuses it while nothing has changed since. |
| ReuseUnchanged | enabled | enabled: the newest migration caption is reused instead of a new one while the database, var/ storage, settings/override and the commit of the installation are as they were when it was taken. The check is exact on PostgreSQL (the change counters of every table), MySQL/MariaDB (CHECKSUM TABLE of every table) and SQLite (the rows of every table); MongoDB and Oracle always take a new caption. |
| ReuseIgnoreTableList[] | exp_migration; exp_migration_run; ezsession; expaudit_* | The tables the reuse check leaves out: the record of the runs and captions, sessions and the audit index (each caption writes an audit event). A name ending in * stands for every table that starts with it. |
| RestoreOnFailure | enabled | enabled: a run that fails is put back to its pre caption at once (after a caption of the failed state, kind migration-failure). Oracle has no built-in restore: the run stops and prints the steps to restore by hand. |
| RestoreParts[] | database; storage; settings | The parts of a caption a failed run is put back to (exp:upgrade:rollback --parts): database, storage, settings. |
| CodeTreeList[] | settings; extension; design | The code trees of the installation a run checks for changes that are not committed: a run with --apply is refused while one has some, unless it is given --include-uncommitted (the changes then go into the caption as a patch and a copy of the new files). |
| BackupDirectory | (empty) | The folder of the captions made without git_manager. Empty: var/backup/upgrade, as exp:upgrade. |
See also
Generated example: migration.ini [CaptionSettings]
Added to the reference for Exponential 6.0.15: the 4.x reference had no page for this group. The descriptions are the comment lines of settings/migration.ini.
Contributors
- Graham Brookins Updated
Comments
Add a comment