-
-
Notifications
You must be signed in to change notification settings - Fork 495
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(query-builder): respect
EntityManager schema (#4849)
- QueryBuilder will inherit schema from EntityManager (if set)
- QueryBuilder can now join entities that belong in a different schema
than the main entity.
Previously if you had an entity that belongs to schema n2 which have a
FK to an entity that does not exist in n2 the query will fail since it
will use `n2.SubDomain`. If you used `withSchema('n5')`, then it will
fail since `n5.Domain` does not exist.
```
@entity({ schema: 'n2' })
class Domain {
@PrimaryKey()
id!: number;
@OneToMany(() => SubDomain, e => e.domain)
subDomain = new Collection<SubDomain>(this);
}
@entity({ schema: '*' })
class SubDomain {
@PrimaryKey()
id!: number;
@manytoone(() => Domain, { nullable: true })
domain?: Domain;
}
```- Loading branch information
Showing
3 changed files
with
276 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
269 changes: 269 additions & 0 deletions
269
tests/features/multiple-schemas-entity-manager/multiple-schemas-e-manager-q-builder.test.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,269 @@ | ||
| import { | ||
| Collection, | ||
| Entity, | ||
| LoadStrategy, | ||
| ManyToOne, | ||
| MikroORM, | ||
| OneToMany, | ||
| OneToOne, | ||
| PrimaryKey, | ||
| Property, | ||
| } from '@mikro-orm/core'; | ||
| import { PostgreSqlDriver } from '@mikro-orm/postgresql'; | ||
| import { mockLogger } from '../../helpers'; | ||
|
|
||
| @Entity({ schema: 'n2' }) | ||
| class Domain { | ||
|
|
||
| @PrimaryKey() | ||
| id!: number; | ||
|
|
||
| @Property() | ||
| scope!: string; | ||
|
|
||
| @OneToMany(() => SubDomain, e => e.domain) | ||
| subDomain = new Collection<SubDomain>(this); | ||
|
|
||
| } | ||
| @Entity({ schema: '*' }) | ||
| class SubDomain { | ||
|
|
||
| @PrimaryKey() | ||
| id!: number; | ||
|
|
||
| @Property() | ||
| name!: string; | ||
|
|
||
| @ManyToOne(() => Domain, { nullable: true }) | ||
| domain?: Domain; | ||
|
|
||
| } | ||
|
|
||
|
|
||
| @Entity({ schema: '*' }) | ||
| class Topic { | ||
|
|
||
| @PrimaryKey() | ||
| id!: number; | ||
|
|
||
| @Property() | ||
| name!: string; | ||
|
|
||
| @OneToMany(() => Category, e => e.topic) | ||
| category = new Collection<Category>(this); | ||
|
|
||
| @OneToOne(() => Domain, { nullable: true }) | ||
| domain?: Domain; | ||
|
|
||
| } | ||
|
|
||
| @Entity({ schema: '*' }) | ||
| class Category { | ||
|
|
||
| @PrimaryKey() | ||
| id!: number; | ||
|
|
||
| @ManyToOne(() => Topic, { nullable: true }) | ||
| topic?: Topic; | ||
|
|
||
| } | ||
|
|
||
| describe('multiple connected schemas in postgres', () => { | ||
| let orm: MikroORM<PostgreSqlDriver>; | ||
|
|
||
| beforeAll(async () => { | ||
| orm = await MikroORM.init({ | ||
| entities: [Domain, Topic, Category, SubDomain], | ||
| dbName: `mikro_orm_test_multi_schemas`, | ||
| driver: PostgreSqlDriver, | ||
| }); | ||
| await orm.schema.ensureDatabase(); | ||
|
|
||
| for (const ns of ['n2', 'n5']) { | ||
| await orm.schema.execute(`drop schema if exists ${ns} cascade`); | ||
| } | ||
|
|
||
| // `*` schema will be ignored | ||
| await orm.schema.updateSchema(); | ||
|
|
||
| // we need to pass schema for book | ||
| await orm.schema.updateSchema({ schema: 'n2' }); | ||
| await orm.schema.updateSchema({ schema: 'n5' }); | ||
| orm.config.set('schema', 'n2'); // set the schema so we can work with book entities without options param | ||
| }); | ||
|
|
||
| afterAll(async () => { | ||
| await orm.close(true); | ||
| }); | ||
|
|
||
| beforeEach(async () => { | ||
| await orm.em.createQueryBuilder(Topic).truncate().execute(); // current schema from config | ||
| await orm.em.createQueryBuilder(Topic).withSchema('n2').truncate().execute(); | ||
| await orm.em.createQueryBuilder(Topic).withSchema('n5').truncate().execute(); | ||
| await orm.em.createQueryBuilder(Category).truncate().execute(); // current schema from config | ||
| await orm.em.createQueryBuilder(Category).withSchema('n2').truncate().execute(); | ||
| await orm.em.createQueryBuilder(Category).withSchema('n5').truncate().execute(); | ||
| await orm.em.createQueryBuilder(Domain).truncate().execute(); // current schema from config | ||
| await orm.em.createQueryBuilder(Domain).withSchema('n2').truncate().execute(); | ||
| orm.em.clear(); | ||
| }); | ||
|
|
||
| test('with fork schema', async () => { | ||
| const mock = mockLogger(orm); | ||
| mock.mockReset(); | ||
|
|
||
| const fork = orm.em.fork({ schema: 'n5' }); | ||
|
|
||
| await fork | ||
| .getRepository(Category) | ||
| .createQueryBuilder('category') | ||
| .leftJoinAndSelect('category.topic', 'topic') | ||
| .execute(); | ||
|
|
||
| await fork | ||
| .getRepository(Topic) | ||
| .createQueryBuilder('topic') | ||
| .leftJoinAndSelect('topic.category', 'category') | ||
| .leftJoinAndSelect('topic.domain', 'domain') | ||
| .execute(); | ||
|
|
||
| await fork.findOne(Domain, { | ||
| id: 1, | ||
| }, { | ||
| populate: ['subDomain'], | ||
| strategy: LoadStrategy.JOINED, | ||
| disableIdentityMap: true, | ||
| }); | ||
|
|
||
| await fork.findOne(Topic, { | ||
| id: 1, | ||
| }, { | ||
| populate: ['domain'], | ||
| strategy: LoadStrategy.JOINED, | ||
| disableIdentityMap: true, | ||
| }); | ||
|
|
||
| /** | ||
| * All * entities should use schema set in EntityManager (n5) | ||
| * All entities with defined schema(domain) should use the defined schema | ||
| */ | ||
| expect(mock.mock.calls[0][0]).toMatch( | ||
| 'select "category".*, "topic"."id" as "topic__id", "topic"."name" as "topic__name", "topic"."domain_id" as "topic__domain_id" from "n5"."category" as "category" left join "n5"."topic" as "topic" on "category"."topic_id" = "topic"."id"', | ||
| ); | ||
| expect(mock.mock.calls[1][0]).toMatch( | ||
| 'select "topic".*, "category"."id" as "category__id", "category"."topic_id" as "category__topic_id", "domain"."id" as "domain__id", "domain"."scope" as "domain__scope" from "n5"."topic" as "topic" left join "n5"."category" as "category" on "topic"."id" = "category"."topic_id" left join "n2"."domain" as "domain" on "topic"."domain_id" = "domain"."id"', | ||
| ); | ||
|
|
||
| /** | ||
| * Main table Domain(n2) will make sure that the schema used for * joins will be n2 and ignore fork settings | ||
| */ | ||
| expect(mock.mock.calls[2][0]).toMatch( | ||
| 'select "d0"."id", "d0"."scope", "s1"."id" as "s1__id", "s1"."name" as "s1__name", "s1"."domain_id" as "s1__domain_id" from "n2"."domain" as "d0" left join "n2"."sub_domain" as "s1" on "d0"."id" = "s1"."domain_id" where "d0"."id" = 1', | ||
| ); | ||
|
|
||
| /** | ||
| * Main table topic(*) will join Domain(n2) | ||
| */ | ||
| expect(mock.mock.calls[3][0]).toMatch( | ||
| 'select "t0"."id", "t0"."name", "t0"."domain_id", "d1"."id" as "d1__id", "d1"."scope" as "d1__scope" from "n5"."topic" as "t0" left join "n2"."domain" as "d1" on "t0"."domain_id" = "d1"."id" where "t0"."id" = 1', | ||
| ); | ||
| }); | ||
|
|
||
| test('with schema differ from fork schema', async () => { | ||
| const mock = mockLogger(orm); | ||
| mock.mockReset(); | ||
|
|
||
| const fork = orm.em.fork({ schema: 'n5' }); | ||
|
|
||
| await fork | ||
| .getRepository(Category) | ||
| .createQueryBuilder('category') | ||
| .withSchema('n2') | ||
| .leftJoinAndSelect('category.topic', 'topic') | ||
| .execute(); | ||
|
|
||
| await fork | ||
| .getRepository(Topic) | ||
| .createQueryBuilder('topic') | ||
| .withSchema('n2') | ||
| .leftJoinAndSelect('topic.category', 'category') | ||
| .leftJoinAndSelect('topic.domain', 'domain') | ||
| .execute(); | ||
|
|
||
| /** | ||
| * withSchema triumphs all | ||
| * n2 should be used for all entities | ||
| */ | ||
| expect(mock.mock.calls[0][0]).toMatch( | ||
| 'select "category".*, "topic"."id" as "topic__id", "topic"."name" as "topic__name", "topic"."domain_id" as "topic__domain_id" from "n2"."category" as "category" left join "n2"."topic" as "topic" on "category"."topic_id" = "topic"."id"', | ||
| ); | ||
| expect(mock.mock.calls[1][0]).toMatch( | ||
| 'select "topic".*, "category"."id" as "category__id", "category"."topic_id" as "category__topic_id", "domain"."id" as "domain__id", "domain"."scope" as "domain__scope" from "n2"."topic" as "topic" left join "n2"."category" as "category" on "topic"."id" = "category"."topic_id" left join "n2"."domain" as "domain" on "topic"."domain_id" = "domain"."id"', | ||
| ); | ||
| }); | ||
|
|
||
| test('should default schema on not defined schema', async () => { | ||
| const mock = mockLogger(orm); | ||
| mock.mockReset(); | ||
|
|
||
| const fork = orm.em.fork(); | ||
|
|
||
| await fork | ||
| .getRepository(Category) | ||
| .createQueryBuilder('category') | ||
| .leftJoinAndSelect('category.topic', 'topic') | ||
| .execute(); | ||
|
|
||
| await fork | ||
| .getRepository(Topic) | ||
| .createQueryBuilder('topic') | ||
| .leftJoinAndSelect('topic.category', 'category') | ||
| .leftJoinAndSelect('topic.domain', 'domain') | ||
| .execute(); | ||
|
|
||
| /** | ||
| * Nothing set, should default to entities.schema or if * is used, to schema set on orm | ||
| */ | ||
| expect(mock.mock.calls[0][0]).toMatch( | ||
| 'select "category".*, "topic"."id" as "topic__id", "topic"."name" as "topic__name", "topic"."domain_id" as "topic__domain_id" from "n2"."category" as "category" left join "n2"."topic" as "topic" on "category"."topic_id" = "topic"."id"', | ||
| ); | ||
| expect(mock.mock.calls[1][0]).toMatch( | ||
| 'select "topic".*, "category"."id" as "category__id", "category"."topic_id" as "category__topic_id", "domain"."id" as "domain__id", "domain"."scope" as "domain__scope" from "n2"."topic" as "topic" left join "n2"."category" as "category" on "topic"."id" = "category"."topic_id" left join "n2"."domain" as "domain" on "topic"."domain_id" = "domain"."id"', | ||
| ); | ||
| }); | ||
|
|
||
| test('join table in different schema', async () => { | ||
| const mock = mockLogger(orm); | ||
| mock.mockReset(); | ||
|
|
||
| await orm.em.fork({ schema: 'n5' }) | ||
| .getRepository(Domain) | ||
| .createQueryBuilder('domain') | ||
| .leftJoinAndSelect('domain.subDomain', 'subDomain') | ||
| .execute(); | ||
|
|
||
| /** | ||
| * Domain is set to n2 and should join to n2 | ||
| * SubDomain is set to * and should default to entityManager.schema (n5) | ||
| */ | ||
| expect(mock.mock.calls[0][0]).toMatch( | ||
| 'select "domain".*, "subDomain"."id" as "subDomain__id", "subDomain"."name" as "subDomain__name", "subDomain"."domain_id" as "subDomain__domain_id" from "n2"."domain" as "domain" left join "n5"."sub_domain" as "subDomain" on "domain"."id" = "subDomain"."domain_id"', | ||
| ); | ||
|
|
||
| orm.config.set('schema', 'n5'); | ||
| const fork = orm.em.fork(); | ||
| await fork | ||
| .getRepository(Domain) | ||
| .createQueryBuilder('domain') | ||
| .leftJoinAndSelect('domain.subDomain', 'subDomain') | ||
| .execute(); | ||
|
|
||
| /** | ||
| * Domain is set to n2 and should join to n2 | ||
| * SubDomain is set to * and should default to main table schema (n2) | ||
| */ | ||
| expect(mock.mock.calls[1][0]).toMatch( | ||
| 'select "domain".*, "subDomain"."id" as "subDomain__id", "subDomain"."name" as "subDomain__name", "subDomain"."domain_id" as "subDomain__domain_id" from "n2"."domain" as "domain" left join "n2"."sub_domain" as "subDomain" on "domain"."id" = "subDomain"."domain_id"', | ||
| ); | ||
| }); | ||
| }); |