fix: create typeorm_metatable when running migrations #4956

BitPatty · 2019-10-23T12:13:49Z

Proposed fix for #4923
When generating migrations for views a typeorm_metadata table is created in which the views select statements are stored during the migration. However, the table won't be created during the actual execution of the migration. Thus, running a migration on a database which doesn't have the typeorm_metadata table will eventually fail. To avoid that, the table is created during a migration
if necessary.

pablosproject · 2019-11-21T09:57:00Z

Any chances we got this merged any soon? Just ran into this issue and I think is important to have this in the library.

src/schema-builder/RdbmsSchemaBuilder.ts

src/commands/MigrationRunCommand.ts

GSKryachko · 2019-11-28T12:56:54Z

I also would like to see it merged as soon as possible.

pleerock · 2019-12-05T09:38:54Z

This PR isn't finished. For some reason @BitPatty added metadata table creation code into undoLastMigration method, I'm completely confused why

BitPatty · 2019-12-05T11:30:26Z

I'm just as confused on how this happened :/

michaeldever · 2020-06-11T18:15:21Z

This would be awesome, hitting my head against this in test for the last little while.

coyoteecd · 2020-06-25T09:23:51Z

@pleerock can you merge and release this? I've run into this too

imnotjames · 2020-10-09T08:07:27Z

Can you fix the conflict? Is it possible to write tests for this?

pleerock · 2020-10-09T08:49:50Z

we don't have tests for cli commands yet.. if someone can contribute and start writing tests for CLI for the first time, this one is a good opportunity. If nobody wants, probably we can merge this one.

BitPatty · 2020-10-09T14:13:05Z

@imnotjames fixed the conflict

imnotjames · 2020-10-09T16:41:43Z

Tests exercising the MigrationExecutor don't need to be using the CLI.

You can run migrations similar to this example:

https://github.com/typeorm/typeorm/blob/2f275816375a58c9ad136d5f02dc3508797152c2/test/github-issues/4697/issue-4697.ts

BitPatty · 2021-06-16T13:09:16Z

@imnotjames Can you check the tests?

imnotjames · 2021-06-16T13:50:31Z

@imnotjames Can you check the tests?

They're currently failing, it looks like?

BitPatty · 2021-06-16T14:02:57Z

The CI build had a timeout during service setup, it didn't run the tests => https://app.circleci.com/pipelines/github/typeorm/typeorm/2683/workflows/3d850679-0b7e-4944-a06a-dc09b42608aa/jobs/10722

pleerock · 2021-08-04T11:59:10Z

@AlexMesser can you please review this PR?

pleerock · 2021-11-10T13:40:35Z

Okay, I have to review it by myself.

pleerock · 2021-11-10T13:41:30Z

src/schema-builder/RdbmsSchemaBuilder.ts

+     */
+    async createMetadataTableIfNecessary(): Promise<void> {
+        if (this.viewEntityToSyncMetadatas.length > 0) {
+            this.queryRunner = this.queryRunner || this.connection.createQueryRunner();


|| this.connection.createQueryRunner() this code can be very dangerous since its not clear here where it gets released. Use this.queryRunner if it's available, or pass it to createMetadataTableIfNecessary method from the places where you call this method.

On a side note, with both the current implementation [1]/[2] as well as this PR the migration table is created when generating migrations. Is this intended behavior?

[1]

typeorm/src/commands/MigrationGenerateCommand.ts

Line 105 in a92120a

const sqlInMemory = await connection.driver.createSchemaBuilder().log();

[2]

typeorm/src/schema-builder/RdbmsSchemaBuilder.ts

Lines 116 to 125 in a92120a

async log(): Promise<SqlInMemory> {

this.queryRunner = this.connection.createQueryRunner();

try {

// TODO: typeorm_metadata table needs only for Views for now.

// Remove condition or add new conditions if necessary (for CHECK constraints for example).

if (this.viewEntityToSyncMetadatas.length > 0) {

await this.createTypeormMetadataTable();

}

the migration table is created when generating migrations. Is this intended behavior?

Probably it shouldn't be inside log method, since you are creating metadata table in executePendingMigrations, right?

Avoid creating the metatable when you don't intend to modify the database, such as when generating migrations

…nner

TheNoim · 2021-11-13T11:21:52Z

I just noticed this could also be relevant for my pr #6469, because it uses the typeorm_metadata table.

AlexMesser · 2021-11-14T16:02:49Z

thank you for contribution!

issackr · 2021-11-23T14:26:45Z

@pleerock @BitPatty
Hi
I am getting this error while having my server that run migrations going up
typeorm_metadata table already exists
It looks like this behaviour started around the merging of this fix, do you think it might be connected?

Thanks

BitPatty · 2021-11-24T14:16:49Z

You might have patched a migration manually to explicitly create the typeorm_metadata table. Check your migration files for any CREATE TABLE typeorm_metadata statements.

) * fix: create typeorm_metatable when running migrations * remove redundant check * create typeorm_metadata table in MigrationExecutor * remove redundant call to createMetadataTableIfNecessary * move create metadata table logic * add missing test (typeorm#4956) * fix migration name * pass query runner instance to metadata creation * do not create metadata table in log() Avoid creating the metatable when you don't intend to modify the database, such as when generating migrations

fix: create typeorm_metatable when running migrations

6679bef

pleerock reviewed Nov 22, 2019

View reviewed changes

src/schema-builder/RdbmsSchemaBuilder.ts Outdated Show resolved Hide resolved

pleerock reviewed Nov 22, 2019

View reviewed changes

src/commands/MigrationRunCommand.ts Outdated Show resolved Hide resolved

BitPatty added 3 commits November 22, 2019 09:04

remove redundant check

d4875b9

create typeorm_metadata table in MigrationExecutor

f1f3d36

remove redundant call to createMetadataTableIfNecessary

4b8592c

move create metadata table logic

ec5a4f2

jonseitz mentioned this pull request Mar 30, 2020

Server unable to start due to missing typeorm_metadata table seas-computing/course-planner#181

Closed

2 tasks

imnotjames self-requested a review October 3, 2020 03:02

Merge branch 'master' into master

b3bca65

BitPatty added 3 commits June 12, 2021 18:15

Merge branch 'typeorm:master' into master

ff67fbf

add missing test (#4956)

420dcbb

fix migration name

29c1d4f

BitPatty requested a review from pleerock June 12, 2021 20:18

This comment has been minimized.

Sign in to view

pleerock reviewed Nov 10, 2021

View reviewed changes

pleerock mentioned this pull request Nov 10, 2021

typeorm_metadata table not in migrations when generating view sql #4923

Closed

BitPatty added 2 commits November 10, 2021 18:51

Merge branch 'master' of github.com:typeorm/typeorm

b9fe129

pass query runner instance to metadata creation

6dd2b59

pleerock requested review from AlexMesser and pleerock November 11, 2021 14:50

pleerock assigned AlexMesser Nov 11, 2021

BitPatty added 2 commits November 11, 2021 17:26

do not create metadata table in log()

54ced47

Avoid creating the metatable when you don't intend to modify the database, such as when generating migrations

Merge branch 'master' of github.com:typeorm/typeorm into pass-queryru…

8987701

…nner

Merge branch 'master' into master

319a35c

AlexMesser merged commit b2c8168 into typeorm:master Nov 14, 2021

TheNoim mentioned this pull request Dec 5, 2021

feat: implement generated columns for postgres 12 driver #6469

Merged

julianpoemp mentioned this pull request Jul 4, 2022

relation "typeorm_metadata" does not exist while creating a view in migration #9173

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: create typeorm_metatable when running migrations #4956

fix: create typeorm_metatable when running migrations #4956

BitPatty commented Oct 23, 2019

pablosproject commented Nov 21, 2019

GSKryachko commented Nov 28, 2019

pleerock commented Dec 5, 2019

BitPatty commented Dec 5, 2019

michaeldever commented Jun 11, 2020

coyoteecd commented Jun 25, 2020

imnotjames commented Oct 9, 2020 •

edited

pleerock commented Oct 9, 2020

BitPatty commented Oct 9, 2020

imnotjames commented Oct 9, 2020

BitPatty commented Jun 16, 2021

imnotjames commented Jun 16, 2021

BitPatty commented Jun 16, 2021 •

edited

pleerock commented Aug 4, 2021

This comment has been minimized.

pleerock commented Nov 10, 2021

pleerock Nov 10, 2021

BitPatty Nov 10, 2021

pleerock Nov 11, 2021

TheNoim commented Nov 13, 2021 •

edited

AlexMesser commented Nov 14, 2021

issackr commented Nov 23, 2021

BitPatty commented Nov 24, 2021

	async log(): Promise<SqlInMemory> {
	this.queryRunner = this.connection.createQueryRunner();
	try {

	// TODO: typeorm_metadata table needs only for Views for now.
	// Remove condition or add new conditions if necessary (for CHECK constraints for example).
	if (this.viewEntityToSyncMetadatas.length > 0) {
	await this.createTypeormMetadataTable();
	}

fix: create typeorm_metatable when running migrations #4956

fix: create typeorm_metatable when running migrations #4956

Conversation

BitPatty commented Oct 23, 2019

pablosproject commented Nov 21, 2019

GSKryachko commented Nov 28, 2019

pleerock commented Dec 5, 2019

BitPatty commented Dec 5, 2019

michaeldever commented Jun 11, 2020

coyoteecd commented Jun 25, 2020

imnotjames commented Oct 9, 2020 • edited

pleerock commented Oct 9, 2020

BitPatty commented Oct 9, 2020

imnotjames commented Oct 9, 2020

BitPatty commented Jun 16, 2021

imnotjames commented Jun 16, 2021

BitPatty commented Jun 16, 2021 • edited

pleerock commented Aug 4, 2021

This comment has been minimized.

pleerock commented Nov 10, 2021

pleerock Nov 10, 2021

Choose a reason for hiding this comment

BitPatty Nov 10, 2021

Choose a reason for hiding this comment

pleerock Nov 11, 2021

Choose a reason for hiding this comment

TheNoim commented Nov 13, 2021 • edited

AlexMesser commented Nov 14, 2021

issackr commented Nov 23, 2021

BitPatty commented Nov 24, 2021

imnotjames commented Oct 9, 2020 •

edited

BitPatty commented Jun 16, 2021 •

edited

TheNoim commented Nov 13, 2021 •

edited