Skip to content

Commit 605d547

Browse files
docs(db): clarify migration status command help
Signed-off-by: Josh <josh.t.richards@gmail.com>
1 parent ec6f6f8 commit 605d547

1 file changed

Lines changed: 27 additions & 2 deletions

File tree

core/Command/Db/Migrations/StatusCommand.php

Lines changed: 27 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,33 @@ public function __construct(
3131
protected function configure() {
3232
$this
3333
->setName('migrations:status')
34-
->setDescription('View the status of a set of migrations.')
35-
->addArgument('app', InputArgument::REQUIRED, 'Name of the app this migration command shall work on');
34+
->setDescription('Show the database migration status for an app')
35+
->addArgument(
36+
'app',
37+
InputArgument::REQUIRED,
38+
'App ID to inspect, or "core" for server migrations',
39+
)
40+
->setHelp(<<<'HELP'
41+
The <info>%command.name%</info> command shows the database migration status
42+
for core or an installed app.
43+
44+
It reports:
45+
- migration versions recorded as executed
46+
- migration files available in the installed code
47+
- migrations that have not yet been applied
48+
- executed migrations that are missing from the installed code
49+
50+
This command is read-only. It does not execute migrations or modify migration
51+
history.
52+
53+
If executed migrations are missing from the installed code, verify that the
54+
installed app and server code match the intended version. Do not remove records
55+
from the migration history table manually.
56+
57+
Example:
58+
59+
<info>php occ migrations:status core</info>
60+
HELP);
3661
}
3762

3863
#[\Override]

0 commit comments

Comments
 (0)