command
Runs one exp:* console command of the installation that migration.ini allows, without a shell.
A step of a YAML migration with type: command. The class expMigrationStepCommand (kernel/classes/migration/steps/expmigrationstepcommand.php) is registered in settings/migration.ini [StepSettings] StepTypeList[command].
Keys
| Key | Type | Default | What it is |
|---|---|---|---|
command | string | required | an exp:* command of ./console listed in migration.ini [StepSettings] CommandAllowList[] |
arguments | list | its arguments, each one argument | |
timeout | int | 600 | seconds |
expect_exit | int | 0 | the exit code that passes |
Besides these, every step takes the keys of the engine: type, mode, if, references, environments, engines and comment (the file format). A key of type identifier names a node, an object or another part of the installation by id, remote id, path or name (identifiers).
Values for references
references: { <name>: <value> } keeps a value of the step's result as ${ref.<name>} for the steps and migrations after it:
| Value | What it is |
|---|---|
exit | the exit code |
output | what the command printed (at most 64 KB) |
Undoing
A step of this type does not undo itself: a migration with it needs down: or a rollback to its caption.
It touches no cache.
Example
- type: command
command: exp:services:compile
references: { compiled: exit }Related
Generated by ./console exp:help:examples from settings/migration.ini, kernel/classes/migration/steps/expmigrationstepcommand.php. Do not edit this page: change the source and generate again (how). Free documentation: GFDL 1.3 or later.