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

Take a caption of the installation now (database, storage, settings, the commits of the code), or list the captions; a dry run unless --apply.

Download as PDF

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

On this page

exp:expmigrationcaption

Take a caption of the installation now (database, storage, settings, the commits of the code), or list the captions; a dry run unless --apply.

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

./console exp:expmigrationcaption --help
./console exp:migration:caption --help
php bin/php/expmigrationcaption.php --help

Help text

Take a caption now
A caption of the kind manual, under the installation lock: git_manager's full backup (database and
var/ storage) where it is installed, else exp:upgrade's own dump, with settings/override and the
commits of the code. It is a point exp:migration:rollback --expert and exp:upgrade:rollback can go
back to. --list lists the captions, newest first, with the command that restores each.

./console exp:migration:caption --list
./console exp:migration:caption --apply
./console exp:migration:caption --label="before the news import" --apply

Options

OptionValueHelp
--applyMake the changes (the default is a dry run that lists them and changes nothing)
--dry-runThe default, accepted for scripts that pass it: list what would change, change nothing
--formatrequiredtext (default) or json (the machine output exp-migration/1)
--listList the captions instead of taking one
--labelrequiredThe label of the caption or of the recording (a caption without one: "manual caption" with the time)
--backup-dirrequiredWhere the captions made without git_manager are (default var/backup/upgrade)

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