Skip to the content
Documentation

exp:expmigrationstatus

No ratings yet

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

Summary

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

Usage

./console exp:expmigrationstatus [options]
php bin/php/expmigrationstatus.php [options]
./console exp:migration:status [options]

Aliases

exp:migration:status

Help

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

Usage: bin/php/expmigrationstatus.php [OPTION]...
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:
  --only=VALUE...      Only these migrations (migration ids, a comma list or repeated)
  --environment=VALUE  The environment (default the installation's: [AdminEnvironment] Level, or EXP_ENV with Level=auto; check: every environment); only the migrations for it count
  --format=VALUE       text (default) or json (the machine output exp-migration/1)
  --fail-on-pending    Exit 1 when migrations are pending or failed (for CI)
  --runs=VALUE         How many of the latest runs to list (default 10, 0 for none)

Options

Option Value Description
--only required Only these migrations (migration ids, a comma list or repeated)
--environment required The environment (default the installation's: [AdminEnvironment] Level, or EXP_ENV with Level=auto; check: every environment); only the migrations for it count
--format required text (default) or json (the machine output exp-migration/1)
--fail-on-pending - Exit 1 when migrations are pending or failed (for CI)
--runs required How many of the latest runs to list (default 10, 0 for none)

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

See also

Generated example: exp:expmigrationstatus

Added to the reference for Exponential 6.0.15.

Contributors

Comments

Add a comment

Comments are read by a moderator before they appear.