exp:expmigrationdeploy
Available since Exponential 6.0.15 (in development, not in a release yet).
Summary
Deploy this installation's migrations to one or many remotes at once, in sync: preflight and verify on all, then switch all, or take all back
Usage
./console exp:expmigrationdeploy [options] php bin/php/expmigrationdeploy.php [options] ./console exp:migration:deploy [options]
Aliases
exp:migration:deploy
Options
| Option | Value | Description |
|---|---|---|
| --remotes | required | The remotes: ids or group names of [RemoteSettings] RemoteList[] in migration.ini, or all (a comma list or repeated) |
| --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 |
| --transfer-only | - | Send and verify the migration files, but do not run them (with --apply; the only mode for an FTP remote without a trigger) |
| --only | required | Only these migrations (migration ids, a comma list or repeated) |
| --format | required | text (default) or json (the machine output exp-migration/1) |
| --parallel | required | How many remotes are worked on at the same time (default [RemoteSettings] Parallel) |
| --timeout | required | Seconds each remote may take for one phase (default [RemoteSettings] Timeout) |
| --retries | required | How often a connection failure is tried again (default [RemoteSettings] Retries) |
| --staged | - | Deploy stage by stage ([RemoteSettings] StageOrder[] by environment): the first stage now, a gate before each next one (with --apply) |
| --continue | required | Approve the gate of a staged deploy and deploy its next stage (the deploy id; with --apply) |
| --rollback | required | Take back every remote that applied this deploy (the deploy id; with --apply) |
| --login | required | Run as this user (default: [RunSettings] RunAsUser of migration.ini) |
| --run-id | required | The id of the run to start (default a new one: <date>-<time>-<6 hex digits>); the administration names it before it starts the run |
| --progress | required | Append the progress of the run to this file, one JSON object per line (what the administration shows while the run goes on) |
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/expmigrationdeploy.php, kernel/private/classes/commands/expmigrationdeploy.php
See also
Generated example: exp:expmigrationdeploy
Added to the reference for Exponential 6.0.15.
Contributors
- Graham Brookins Updated
Comments
Add a comment