migration.ini [RunSettings] #

The block [RunSettings] of settings/migration.ini, with 8 setting(s).

Never edit settings/migration.ini itself: an update replaces it. Put the settings you change in an override, which wins over the shipped file:

• settings/override/migration.ini.append.php for every siteaccess,
• settings/siteaccess/<siteaccess>/migration.ini.append.php for one siteaccess,
• extension/<extension>/settings/migration.ini.append.php in an extension (read when the extension is active).

RunAsUser #

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.

Default: admin.

<?php /* #?ini charset="utf-8"?
# settings/override/migration.ini.append.php
[RunSettings]
RunAsUser=admin
*/ ?>

StopOnFailure #

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.

Default: enabled.

<?php /* #?ini charset="utf-8"?
# settings/override/migration.ini.append.php
[RunSettings]
StopOnFailure=enabled
*/ ?>

Throttle #

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.

Default: empty.

<?php /* #?ini charset="utf-8"?
# settings/override/migration.ini.append.php
[RunSettings]
Throttle=
*/ ?>

MaxMigrations #

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.

Default: empty.

<?php /* #?ini charset="utf-8"?
# settings/override/migration.ini.append.php
[RunSettings]
MaxMigrations=
*/ ?>

MaxTime #

Default: empty.

<?php /* #?ini charset="utf-8"?
# settings/override/migration.ini.append.php
[RunSettings]
MaxTime=
*/ ?>

Nice #

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.

Default: empty.

<?php /* #?ini charset="utf-8"?
# settings/override/migration.ini.append.php
[RunSettings]
Nice=
*/ ?>

ClearCaches #

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.

Default: enabled.

<?php /* #?ini charset="utf-8"?
# settings/override/migration.ini.append.php
[RunSettings]
ClearCaches=enabled
*/ ?>

Reindex #

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.

Default: queue.

<?php /* #?ini charset="utf-8"?
# settings/override/migration.ini.append.php
[RunSettings]
Reindex=queue
*/ ?>

Related #

• All blocks of migration.ini
• All INI files
• The settings page

Generated by ./console exp:help:examples from settings/migration.ini. Do not edit this page: change the source and generate again (how). Free documentation: GFDL 1.3 or later.