typeorm migration:show #4173
typeorm migration:show #4173
Conversation
|
@Juddling could you also add this to the using-cli.md? i took a stab: Show migrations and whether they've been run or notTo show all migrations and whether they've been run or not use following command: This command also returns an error code if there are unapplied migrations. |
|
Added, thank you @ashbadger |
src/migration/MigrationExecutor.ts
Outdated
| const executedMigration = executedMigrations.find(executedMigration => executedMigration.name === migration.name); | ||
|
|
||
| if (executedMigration) { | ||
| this.connection.logger.logSchemaBuild(` ✅ ${migration.name}`); |
There was a problem hiding this comment.
I don't have much of experience in this, so I have to ask - will such characters be displayed in all/most of all terminals?
There was a problem hiding this comment.
I just had a dig through yarn's codebase and it looks like they only enable it for specific terminals, so I'll remove these emojis 😢 😞
https://github.com/yarnpkg/yarn/blob/d4805c302d9a02fd2a52cb4e02f9092b4689fbb1/src/cli/index.js#L116
commander.option(
'--emoji [bool]',
'enable emoji in output',
boolify,
process.platform === 'darwin' ||
process.env.TERM_PROGRAM === 'Hyper' ||
process.env.TERM_PROGRAM === 'HyperTerm' ||
process.env.TERM_PROGRAM === 'Terminus',
);
src/commands/MigrationShowCommand.ts
Outdated
| default: "default", | ||
| describe: "Name of the connection on which run a query." | ||
| }) | ||
| .option("transaction", { |
There was a problem hiding this comment.
It's probably not necessary if we're just going to show migrations without running them.
|
@Kononnable thanks for the review, I've pushed changes with your recommendations |
| let connections: Connection[]; | ||
| before(async () => connections = await createTestingConnections({ | ||
| migrations: [__dirname + "/migration/*.js"], | ||
| enabledDrivers: ["postgres"], |
There was a problem hiding this comment.
Could we enable more drivers?
There was a problem hiding this comment.
There are no driver specific changes. Run this test only for one driver is ok.
There was a problem hiding this comment.
I've enabled them all for now, if it adds too much of a time hit to the tests, we can drop to fewer drivers
There was a problem hiding this comment.
I'll drop back down to just postgres then 👌
This reverts commit ff505cc.
|
Thank you very much guys! |
|
Great work, thank you @Juddling! |
|
This makes absolutely no sense as the default behaviour. It is in no way an error for there to be unapplied migrations. Now, every time that this command is run manually by a user, they get 10 If you need different behaviour in a CI environment, then add a CLI argument. A command run in a CI environment is usually only defined once, as opposed to users running this command many times manually. |
Initial use case for this was to run in CI pre deploy, i.e. all code migrations should be run before new code version is deployed. If you're running this locally I can see why the error code isn't useful. I'd suggest opening a github issue tagging me, outlining the issue (are you having any problems beyond the fact that you don't like seeing those err lines) and a proposed solution - baring in mind that people may depend on this command returning the error code so this is probably a breaking change |
|
Can we get this to also output the SQL? |
As proposed here: #3954
This PR adds a new command
typeorm migration:showThis lists all migrations and shows whether they are applied or pending.
The command also returns an error code if there are unapplied migrations, so that it can easily be used in CI pipelines.