exp:upgradecaptions
Upgrade captions: the safe points to roll back to (git_manager's and exp:upgrade's), checked with --verify, pruned with --prune.
Script bin/php/upgradecaptions.php, code in kernel/private/classes/commands/upgradecaptions.php. Run it from the installation root, as the user the web server runs as:
./console exp:upgradecaptions --help
./console exp:upgrade:captions --help
php bin/php/upgradecaptions.php --helpHelp text
Upgrade captions
Every caption, newest first: id, kind (pre, post, safety, manual; git_manager for its own), time,
size, engine, label, and the command that rolls back to it. A caption is git_manager's full backup
(database, var/ storage) with what exp:upgrade adds: settings, composer.lock, the git commits and
checksums. --verify=<id> checks the checksums and restores the dump into a throwaway database.
--prune lists the captions of exp:upgrade that [UpgradeSettings] CaptionKeep, CaptionKeepDays and
CaptionKeepUpgrades let go, and removes them with --apply.
./console exp:upgrade:captions
./console exp:upgrade:captions --verify=2026-10-29_10-15-00
./console exp:upgrade:captions --prune --applyOptions
| Option | Value | Help |
|---|---|---|
--format | required | text (default) or json (the machine output exp-upgrade/1) |
--verify | required | Check this caption: its checksums and a restore of its dump into a throwaway database |
--prune | Remove the captions of exp:upgrade beyond [UpgradeSettings] CaptionKeep, CaptionKeepDays, CaptionKeepUpgrades | |
--apply | Make the changes (the default is a dry run that lists them and changes nothing) | |
--dry-run | The default, accepted for scripts that pass it: list what would change, change nothing | |
--backup-dir | required | Where the backup goes (default var/backup/upgrade); a directory <time> is made in it |
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 ...).
Related
Generated by ./console exp:help:examples from bin/php/upgradecaptions.php, kernel/private/classes/commands/upgradecaptions.php. Do not edit this page: change the source and generate again (how). Free documentation: GFDL 1.3 or later.