exp:expmigrationrecordstop
Available since Exponential 6.0.15 (in development, not in a release yet).
Summary
Stop a recording of changes: the one named, a user's own (--user) or the site-wide window (--site-wide); its events stay for exp:migration:generate --from-recording; a dry run unless --apply
Usage
./console exp:expmigrationrecordstop [options] php bin/php/expmigrationrecordstop.php [options] ./console exp:migration:record:stop [options]
Aliases
exp:migration:record:stop
Help
The output of ./console help exp:expmigrationrecordstop (the script run with --help), without the standard options:
Usage: bin/php/expmigrationrecordstop.php [OPTION]... [RECORDING] Stop a recording of changes Stops the recording named by its id, or else the session recording of --user (default: [RunSettings] RunAsUser), or with --site-wide the site-wide window. Nothing more is recorded; what was recorded stays until exp:migration:record:discard, for exp:migration:record:show and exp:migration:generate --from-recording. Without --apply it says what it would stop. ./console exp:migration:record:stop --apply ./console exp:migration:record:stop --site-wide --apply ./console exp:migration:record:stop 20261101-120000-a1b2c3 --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) --site-wide The site-wide recording: every change of every user and of the console (without it: one user's own changes) --user=VALUE The user, by login, whose own changes a session recording keeps (default: [RunSettings] RunAsUser of migration.ini)
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) |
| --site-wide | - | The site-wide recording: every change of every user and of the console (without it: one user's own changes) |
| --user | required | The user, by login, whose own changes a session recording keeps (default: [RunSettings] RunAsUser of migration.ini) |
Arguments
[recording]
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/expmigrationrecordstop.php, kernel/private/classes/commands/expmigrationrecordstop.php
See also
Generated example: exp:expmigrationrecordstop
Added to the reference for Exponential 6.0.15.
Contributors
- Graham Brookins Updated
Comments
Add a comment