[RunSettings]
Available since Exponential 6.0.15 (in development, not in a release yet).
Summary
The group [RunSettings] 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 |
|---|---|---|
| RunAsUser | admin | The user a migration runs as when nobody is signed in: console and unattended runs. A run in the administration runs as the signed-in user. The login, never an id: ids differ between installations. |
| StopOnFailure | enabled | enabled: a run stops at the first migration that fails; the ones after it are not run. disabled: the run goes on with the migrations that do not require the failed one. |
| Throttle | (empty) | A pause between migrations, in seconds (0.5 is half a second, at most 60), to keep a long run from loading the server; PHP migrations that work in batches (expMigrationPhp::batches()) pause as long between their batches. Empty: none. --throttle=<seconds> of a run wins. |
| MaxMigrations | (empty) | A long run in parts. MaxMigrations: apply at most this many migrations in one run; MaxTime: start no further migration after this many seconds (the one running is finished). The rest stay pending: the next run (or exp:migration:resume) goes on with them, and a PHP migration that works in batches goes on from its checkpoint. Empty: no limit. --max-migrations=<n> and --max-time=<seconds> of a run win. |
| MaxTime | (empty) | |
| Nice | (empty) | A lower priority for runs on the command line (and the administration's background runs), 1 to 19 as nice(1). Empty: unchanged. --nice=<n> of a run wins. |
| ClearCaches | enabled | enabled: after a run that applied (or a rollback that undid) migrations, the caches their steps touched are cleared, by their names in ezcache, and only those (every step type declares its caches; the step type cache adds more). The report lists them, with the deploy that clears exactly them on the server too (./console exp:velocity deploy --caches=<list> --apply). disabled: the caches are left as they are. |
| Reindex | queue | What happens to the search index of the objects the steps of a run created or changed, after the run: queue: queued for the cronjob indexcontent (the pending actions of delayed indexing); now: indexed at once, before the run ends; disabled: left alone. The step type search reindexes on its own, a full reindex too. |
See also
Generated example: migration.ini [RunSettings]
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