feat(postgres): add support for native enums #4296

B4nan · 2023-05-01T09:48:38Z

By default, the PostgreSQL driver, represents enums as a text columns with check constraints. Since v6, you can opt-in for a native enums by setting the nativeEnumName option.

@Entity()
export class User {

  @Enum({ items: () => UserRole, nativeEnumName: 'user_role' })
  role!: UserRole;

}

export enum UserRole {
  ADMIN = 'admin',
  MODERATOR = 'moderator',
  USER = 'user',
}

Closes #2764

codecov · 2023-05-01T10:03:48Z

Codecov Report

Patch coverage: 98.96% and project coverage change: -0.01 ⚠️

Comparison is base (c2077db) 99.47% compared to head (0ac757c) 99.46%.

Additional details and impacted files

@@            Coverage Diff             @@
##               v6    #4296      +/-   ##
==========================================
- Coverage   99.47%   99.46%   -0.01%     
==========================================
  Files         219      219              
  Lines       14441    14515      +74     
  Branches     3314     3332      +18     
==========================================
+ Hits        14365    14438      +73     
- Misses         75       76       +1     
  Partials        1        1

Impacted Files	Coverage Δ
packages/core/src/decorators/Enum.ts	`100.00% <ø> (ø)`
packages/core/src/typings.ts	`100.00% <ø> (ø)`
packages/postgresql/src/PostgreSqlSchemaHelper.ts	`99.47% <96.66%> (-0.53%)`	⬇️
packages/core/src/metadata/EntitySchema.ts	`100.00% <100.00%> (ø)`
packages/core/src/metadata/MetadataDiscovery.ts	`99.30% <100.00%> (+<0.01%)`	⬆️
packages/core/src/platforms/Platform.ts	`99.56% <100.00%> (+<0.01%)`	⬆️
packages/knex/src/schema/DatabaseSchema.ts	`100.00% <100.00%> (ø)`
packages/knex/src/schema/DatabaseTable.ts	`100.00% <100.00%> (ø)`
packages/knex/src/schema/SchemaHelper.ts	`100.00% <100.00%> (ø)`
packages/knex/src/schema/SqlSchemaGenerator.ts	`100.00% <100.00%> (ø)`
... and 2 more

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

@enum

By default, the PostgreSQL driver, represents enums as a text columns with check constraints. Since v6, you can opt-in for a native enums by setting the `nativeEnumName` option. ```ts @entity() export class User { @enum({ items: () => UserRole, nativeEnumName: 'user_role' }) role!: UserRole; } export enum UserRole { ADMIN = 'admin', MODERATOR = 'moderator', USER = 'user', } ``` Closes mikro-orm#2764

@enum

By default, the PostgreSQL driver, represents enums as a text columns with check constraints. Since v6, you can opt-in for a native enums by setting the `nativeEnumName` option. ```ts @entity() export class User { @enum({ items: () => UserRole, nativeEnumName: 'user_role' }) role!: UserRole; } export enum UserRole { ADMIN = 'admin', MODERATOR = 'moderator', USER = 'user', } ``` Closes #2764

@enum

By default, the PostgreSQL driver, represents enums as a text columns with check constraints. Since v6, you can opt-in for a native enums by setting the `nativeEnumName` option. ```ts @entity() export class User { @enum({ items: () => UserRole, nativeEnumName: 'user_role' }) role!: UserRole; } export enum UserRole { ADMIN = 'admin', MODERATOR = 'moderator', USER = 'user', } ``` Closes #2764

@enum

By default, the PostgreSQL driver, represents enums as a text columns with check constraints. Since v6, you can opt-in for a native enums by setting the `nativeEnumName` option. ```ts @entity() export class User { @enum({ items: () => UserRole, nativeEnumName: 'user_role' }) role!: UserRole; } export enum UserRole { ADMIN = 'admin', MODERATOR = 'moderator', USER = 'user', } ``` Closes #2764

@enum

By default, the PostgreSQL driver, represents enums as a text columns with check constraints. Since v6, you can opt-in for a native enums by setting the `nativeEnumName` option. ```ts @entity() export class User { @enum({ items: () => UserRole, nativeEnumName: 'user_role' }) role!: UserRole; } export enum UserRole { ADMIN = 'admin', MODERATOR = 'moderator', USER = 'user', } ``` Closes #2764

@enum

By default, the PostgreSQL driver, represents enums as a text columns with check constraints. Since v6, you can opt-in for a native enums by setting the `nativeEnumName` option. ```ts @entity() export class User { @enum({ items: () => UserRole, nativeEnumName: 'user_role' }) role!: UserRole; } export enum UserRole { ADMIN = 'admin', MODERATOR = 'moderator', USER = 'user', } ``` Closes #2764

@enum

By default, the PostgreSQL driver, represents enums as a text columns with check constraints. Since v6, you can opt-in for a native enums by setting the `nativeEnumName` option. ```ts @entity() export class User { @enum({ items: () => UserRole, nativeEnumName: 'user_role' }) role!: UserRole; } export enum UserRole { ADMIN = 'admin', MODERATOR = 'moderator', USER = 'user', } ``` Closes #2764

@enum

By default, the PostgreSQL driver, represents enums as a text columns with check constraints. Since v6, you can opt-in for a native enums by setting the `nativeEnumName` option. ```ts @entity() export class User { @enum({ items: () => UserRole, nativeEnumName: 'user_role' }) role!: UserRole; } export enum UserRole { ADMIN = 'admin', MODERATOR = 'moderator', USER = 'user', } ``` Closes #2764

@enum

By default, the PostgreSQL driver, represents enums as a text columns with check constraints. Since v6, you can opt-in for a native enums by setting the `nativeEnumName` option. ```ts @entity() export class User { @enum({ items: () => UserRole, nativeEnumName: 'user_role' }) role!: UserRole; } export enum UserRole { ADMIN = 'admin', MODERATOR = 'moderator', USER = 'user', } ``` Closes #2764

@enum

By default, the PostgreSQL driver, represents enums as a text columns with check constraints. Since v6, you can opt-in for a native enums by setting the `nativeEnumName` option. ```ts @entity() export class User { @enum({ items: () => UserRole, nativeEnumName: 'user_role' }) role!: UserRole; } export enum UserRole { ADMIN = 'admin', MODERATOR = 'moderator', USER = 'user', } ``` Closes #2764

@enum

By default, the PostgreSQL driver, represents enums as a text columns with check constraints. Since v6, you can opt-in for a native enums by setting the `nativeEnumName` option. ```ts @entity() export class User { @enum({ items: () => UserRole, nativeEnumName: 'user_role' }) role!: UserRole; } export enum UserRole { ADMIN = 'admin', MODERATOR = 'moderator', USER = 'user', } ``` Closes #2764

@enum

By default, the PostgreSQL driver, represents enums as a text columns with check constraints. Since v6, you can opt-in for a native enums by setting the `nativeEnumName` option. ```ts @entity() export class User { @enum({ items: () => UserRole, nativeEnumName: 'user_role' }) role!: UserRole; } export enum UserRole { ADMIN = 'admin', MODERATOR = 'moderator', USER = 'user', } ``` Closes #2764

@enum

By default, the PostgreSQL driver, represents enums as a text columns with check constraints. Since v6, you can opt-in for a native enums by setting the `nativeEnumName` option. ```ts @entity() export class User { @enum({ items: () => UserRole, nativeEnumName: 'user_role' }) role!: UserRole; } export enum UserRole { ADMIN = 'admin', MODERATOR = 'moderator', USER = 'user', } ``` Closes #2764

@enum

By default, the PostgreSQL driver, represents enums as a text columns with check constraints. Since v6, you can opt-in for a native enums by setting the `nativeEnumName` option. ```ts @entity() export class User { @enum({ items: () => UserRole, nativeEnumName: 'user_role' }) role!: UserRole; } export enum UserRole { ADMIN = 'admin', MODERATOR = 'moderator', USER = 'user', } ``` Closes #2764

@enum

By default, the PostgreSQL driver, represents enums as a text columns with check constraints. Since v6, you can opt-in for a native enums by setting the `nativeEnumName` option. ```ts @entity() export class User { @enum({ items: () => UserRole, nativeEnumName: 'user_role' }) role!: UserRole; } export enum UserRole { ADMIN = 'admin', MODERATOR = 'moderator', USER = 'user', } ``` Closes #2764

@enum

By default, the PostgreSQL driver, represents enums as a text columns with check constraints. Since v6, you can opt-in for a native enums by setting the `nativeEnumName` option. ```ts @entity() export class User { @enum({ items: () => UserRole, nativeEnumName: 'user_role' }) role!: UserRole; } export enum UserRole { ADMIN = 'admin', MODERATOR = 'moderator', USER = 'user', } ``` Closes #2764

feat(postgres): add support for native enums

943678d

B4nan mentioned this pull request May 1, 2023

Native enum support for postgres #2764

Closed

refactor: support for different schema

0ac757c

B4nan merged commit 0b4a262 into v6 May 1, 2023

B4nan deleted the native-pg-enum branch May 1, 2023 14:37

B4nan mentioned this pull request Sep 30, 2023

MikroORM v6 #4731

Merged

22 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(postgres): add support for native enums #4296

feat(postgres): add support for native enums #4296

B4nan commented May 1, 2023 •

edited

Loading

codecov bot commented May 1, 2023 •

edited

Loading

feat(postgres): add support for native enums #4296

feat(postgres): add support for native enums #4296

Conversation

B4nan commented May 1, 2023 • edited Loading

codecov bot commented May 1, 2023 • edited Loading

Codecov Report

B4nan commented May 1, 2023 •

edited

Loading

codecov bot commented May 1, 2023 •

edited

Loading