Skip to the content
Documentation
Help Start
Reading in:
  • German: 9,059 of 9,059 pages
About the help in other languages
All help pages

exp:expmigrationstatus

Migration status: every migration with its state (done, pending, not-needed, failed, unknown), the latest runs and what waits.

Download as PDF

Address: https://doc.exponential.earth/exphelp/viewer/examples/commands/expmigrationstatus.md

On this page

exp:expmigrationstatus

Migration status: every migration with its state (done, pending, not-needed, failed, unknown), the latest runs and what waits.

Script bin/php/expmigrationstatus.php, code in kernel/private/classes/commands/expmigrationstatus.php. Run it from the installation root, as the user the web server runs as:

./console exp:expmigrationstatus --help
./console exp:migration:status --help
php bin/php/expmigrationstatus.php --help

Help text

Migration status
Every migration of the site, the active extensions and the installed packages for the environment,
in the order they run, with its state (done, pending, not-needed, failed, unknown) and its record;
the records whose file is gone, the latest runs, the runs whose push waits and who holds the lock.
Changes nothing, takes no lock.

./console exp:migration:status
./console exp:migration:status --environment=production --format=json
./console exp:migration:status --fail-on-pending     exit 1 when something is pending, for CI

Options

OptionValueHelp
--onlyrequiredOnly these migrations (migration ids, a comma list or repeated)
--environmentrequiredThe environment (default the installation's: [AdminEnvironment] Level, or EXP_ENV with Level=auto; check: every environment); only the migrations for it count
--formatrequiredtext (default) or json (the machine output exp-migration/1)
--fail-on-pendingExit 1 when migrations are pending or failed (for CI)
--runsrequiredHow many of the latest runs to list (default 10, 0 for none)

Read from the option definitions in the code (startup(), getOptions(), options() or ezcConsoleOption). Every script also takes the standard options of the script framework (--help, --siteaccess, --debug, --quiet, --allow-root-user ...).


Generated by ./console exp:help:examples from bin/php/expmigrationstatus.php, kernel/private/classes/commands/expmigrationstatus.php. Do not edit this page: change the source and generate again (how). Free documentation: GFDL 1.3 or later.

Something wrong on this page? Report an error

Documentation license

This documentation is free documentation, licensed under the GNU Free Documentation License 1.3 or later.

Exponential Copyright © 1998-2026 Exponential Foundation and 7x