I-convert ang JSON sa TypeORM Schema!

Ipasok ang JSON at i-convert ito sa TypeORM Schema! Sinusuportahan ang TypeORM @Entity, @PrimaryGeneratedColumn, @Column, NestJS.
JSON
Resulta
 

I-convert ang JSON sa TypeORM Schema!

Kino-convert ang JSON data sa isang TypeORM entity class: isang @Entity() class na may primary key, at bawat ibang key bilang @Column() property na may TypeScript type, nullability at class-validator decorator.

Gamitin ito para gawin ang unang entity para sa TypeOrmModule.forFeature([...]) sa isang NestJS + TypeORM app, o kapag nagdadagdag ng TypeORM DataSource sa isang Express project at kailangan mo ng mga entity na tugma sa data na mayroon ka na.

Paano gamitin

  1. I-paste ang record na ise-store bilang object, o ilang record bilang array. Nagiging nullable na column ang mga field na wala sa ilang record.
  2. Ilagay ang pangalan ng entity class sa Pangalan ng model (default MyModel); nagiging SupportTicket ang support ticket.
  3. I-save ito bilang support-ticket.entity.ts at idagdag ito sa entities array ng DataSource mo o sa TypeOrmModule.forFeature([SupportTicket]) sa isang NestJS module.

Halimbawa

Input (JSON)
[
  { "subject": "Login fails on Safari", "priority": 2, "assignee": "jdoe", "closed": false, "opened_at": "2024-06-03T08:12:00Z" },
  { "subject": "Export CSV is empty", "priority": 1, "closed": true, "opened_at": "2024-06-04T14:40:00Z" }
]
Output (TypeORM)
import { Entity, PrimaryGeneratedColumn, Column } from 'typeorm';
import { IsNotEmpty, IsOptional } from 'class-validator';

@Entity()
export class SupportTicket {
  @PrimaryGeneratedColumn()
  id: number;

  @Column()
  @IsNotEmpty()
  subject: string;

  @Column()
  @IsNotEmpty()
  priority: number;

  @Column({ nullable: true })
  @IsOptional()
  assignee: string | null;

  @Column()
  @IsNotEmpty()
  closed: boolean;

  @Column({ name: 'opened_at' })
  @IsNotEmpty()
  openedAt: Date;
}

Walang assignee ang pangalawang ticket, kaya @Column({ nullable: true }) ang column na iyon na may type na string | null. Naging property na openedAt na may type na Date ang opened_at, at napapanatili ng name: 'opened_at' ang orihinal na column name.

Mga sinusuportahang feature

  • Primary key mula sa data mo: walang id key o integer ang id → @PrimaryGeneratedColumn() id: number; id na lampas sa 32-bit range → @PrimaryGeneratedColumn({ type: 'bigint' }) id: string; string na id gaya ng UUID → @PrimaryColumn() id: string.
  • Mga column type: default na @Column() ang gamit ng mga integer, nakakakuha ng type: 'double precision' ang mga decimal para hindi maputol ang fraction, may type na string ang mga bigint at date-only na date column (text ang ibinabalik ng TypeORM para sa kanila), at Date ang mga date-time.
  • Nagiging simple-json column ang mga object at array na may type na Record<string, unknown> o typed array gaya ng string[].
  • Nananatiling string na column ang mga digit na naka-quote gaya ng "007".
  • camelCase ang mga property; idinadagdag ang @Column({ name: 'opened_at' }) tuwing iba ang JSON key.
  • Nakakakuha ng nullable: true, | null at @IsOptional() ang mga field na null o nawawala; @IsNotEmpty() naman ang iba.

Mga gamit

Pagpuno sa isang entity pagkatapos ng `nest g resource`

Palitan ng output na ito ang walang lamang ticket.entity.ts na ginawa ng nest g resource tickets; tugma na ang entity sa mock data na ginagamit na ng frontend, at handa nang gamitin ang Repository<SupportTicket>.

Panimulang punto para sa mga generated na migration

Pagkatapos gawin ang entity, ikinukumpara ito ng typeorm migration:generate sa database at isinusulat ang CREATE TABLE na migration, kasama ang mga column name at nullability.

Mga paalala at limitasyon

  • Sine-save ng simple-json ang JSON bilang text, kaya hindi ka makakapag-filter sa mga value sa loob nito. Lumipat sa type: 'jsonb' sa PostgreSQL o type: 'json' sa MySQL kung kailangan mo silang i-query.
  • Floating-point type ang double precision; para sa mga presyo, gamitin ang @Column('decimal', { precision: 10, scale: 2 }), na ibinabalik ng TypeORM bilang string.
  • Hindi ini-infer ang mga relation. Ang mga nested object na totoong ibang entity ay dapat gawing @ManyToOne o @OneToMany na relation.

Mga madalas itanong

Saang table name naka-map ang entity?

Walang pangalan ang @Entity(), kaya ginagawang snake_case ng default naming ng TypeORM ang class name: support_ticket. Para sa isang existing na table, ipasa ang pangalan, hal. @Entity('tickets').

Paano kung naka-off ang emitDecoratorMetadata?

Binabasa ng @Column() na walang option ang type nito mula sa reflection metadata, kaya pumapalya ang TypeORM nang may data type error. I-enable ito sa tsconfig o isaad ang bawat type, hal. @Column('varchar').

Anong database type ang nakukuha ng isang Date property?

datetime sa MySQL at timestamp without time zone sa PostgreSQL. Kung mahalaga ang time zone sa PostgreSQL, lumipat sa @Column('timestamptz').