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:upgradestatus

Upgrade status: every upgrade step with its state (done, pending, not-needed, failed, unknown).

Download as PDF

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

On this page

exp:upgradestatus

Upgrade status: every upgrade step with its state (done, pending, not-needed, failed, unknown).

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

./console exp:upgradestatus --help
./console exp:upgrade:status --help
php bin/php/upgradestatus.php --help

Help text

Upgrade status
Every upgrade step, stage by stage, with its state as the installation shows it: done (applied
by exp:upgrade), not-needed (in place without it, or not for this installation), pending, failed
or unknown, and how it was told. Changes nothing, takes no lock.

./console exp:upgrade:status
./console exp:upgrade:status --stages=database --format=json
./console exp:upgrade:status --fail-on-pending     exit 1 when something is pending, for CI

Options

OptionValueHelp
--stagesrequiredOnly these stages, a comma list of code, libraries, database, scripts, finish (in that order)
--onlyrequiredOnly these steps (step ids, a comma list or repeated); an optional step runs only when named here
--formatrequiredtext (default) or json (the machine output exp-upgrade/1)
--fail-on-pendingExit 1 when steps are still pending (for CI)

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/upgradestatus.php, kernel/private/classes/commands/upgradestatus.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