Skip to the content
Documentation

exp:expmigrationcaption

No ratings yet

Available since Exponential 6.0.15 (in development, not in a release yet).

Summary

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

Usage

./console exp:expmigrationcaption [options]
php bin/php/expmigrationcaption.php [options]
./console exp:migration:caption [options]

Aliases

exp:migration:caption

Help

The output of ./console help exp:expmigrationcaption (the script run with --help), without the standard options:

Usage: bin/php/expmigrationcaption.php [OPTION]...
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:
  --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
  --format=VALUE      text (default) or json (the machine output exp-migration/1)
  --list              List the captions instead of taking one
  --label=VALUE       The label of the caption or of the recording (a caption without one: "manual caption" with the time)
  --backup-dir=VALUE  Where the captions made without git_manager are (default var/backup/upgrade)

Options

Option Value Description
--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
--format required text (default) or json (the machine output exp-migration/1)
--list - List the captions instead of taking one
--label required The label of the caption or of the recording (a caption without one: "manual caption" with the time)
--backup-dir required Where the captions made without git_manager are (default var/backup/upgrade)

Standard options

Every script also takes the standard options of the script framework: --help, --quiet, --siteaccess, --debug, --colors, --no-colors, --logfiles, --no-logfiles, --verbose and --allow-root-user.

Source

bin/php/expmigrationcaption.php, kernel/private/classes/commands/expmigrationcaption.php

See also

Generated example: exp:expmigrationcaption

Added to the reference for Exponential 6.0.15.

Contributors

Comments

Add a comment

Comments are read by a moderator before they appear.