Tukarkan JSON kepada TypeORM!

Masukkan JSON dan tukarkannya kepada TypeORM! Menyokong TypeORM @Entity, @PrimaryGeneratedColumn, @Column, NestJS.
JSON
Hasil
 

Tukarkan JSON kepada TypeORM!

Menukar data JSON kepada kelas entity TypeORM: kelas @Entity() dengan primary key, dan setiap kunci lain sebagai property @Column() dengan jenis TypeScript, kebolehan null dan decorator class-validator.

Gunakannya untuk mencipta entity pertama bagi TypeOrmModule.forFeature([...]) dalam aplikasi NestJS + TypeORM, atau semasa menambah DataSource TypeORM ke projek Express dan anda perlukan entity yang sepadan dengan data sedia ada.

Cara menggunakan

  1. Tampal rekod yang hendak disimpan sebagai objek, atau beberapa rekod sebagai tatasusunan. Medan yang tiada dalam sesetengah rekod menjadi lajur nullable.
  2. Masukkan nama kelas entity dalam Nama model (lalai MyModel); support ticket menjadi SupportTicket.
  3. Simpan sebagai support-ticket.entity.ts dan tambahkannya ke tatasusunan entities DataSource anda atau ke TypeOrmModule.forFeature([SupportTicket]) dalam modul NestJS.

Contoh

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;
}

Tiket kedua tiada assignee, jadi lajur itu ialah @Column({ nullable: true }) dengan jenis string | null. opened_at menjadi property openedAt berjenis Date, dengan name: 'opened_at' mengekalkan nama lajur asal.

Ciri yang disokong

  • Primary key daripada data anda: tiada kunci id atau id integer → @PrimaryGeneratedColumn() id: number; id melebihi julat 32-bit → @PrimaryGeneratedColumn({ type: 'bigint' }) id: string; id rentetan seperti UUID → @PrimaryColumn() id: string.
  • Jenis lajur: integer menggunakan @Column() lalai, perpuluhan mendapat type: 'double precision' supaya pecahan tidak dipotong, lajur bigint dan date tarikh sahaja diberi jenis string (TypeORM memulangkannya sebagai teks), tarikh-masa ialah Date.
  • Objek dan tatasusunan menjadi lajur simple-json berjenis Record<string, unknown> atau tatasusunan bertaip seperti string[].
  • Digit berpetikan seperti "007" kekal sebagai lajur string.
  • Property ditulis dalam camelCase; @Column({ name: 'opened_at' }) ditambah setiap kali kunci JSON berbeza.
  • Medan yang null atau hilang mendapat nullable: true, | null dan @IsOptional(); yang lain mendapat @IsNotEmpty().

Kes penggunaan

Mengisi entity sejurus selepas `nest g resource`

Gantikan ticket.entity.ts kosong yang dicipta oleh nest g resource tickets dengan output ini; entity itu kemudian sepadan dengan data mock yang sudah digunakan frontend, dan Repository<SupportTicket> sedia digunakan.

Titik permulaan untuk migrasi yang dijana

Selepas mencipta entity, typeorm migration:generate membandingkannya dengan pangkalan data dan menulis migrasi CREATE TABLE, termasuk nama lajur dan kebolehan null.

Nota dan had

  • simple-json menyimpan JSON sebagai teks, jadi anda tidak boleh menapis berdasarkan nilai di dalamnya. Pada PostgreSQL tukar kepada type: 'jsonb', pada MySQL kepada type: 'json', jika anda perlu membuat query terhadapnya.
  • double precision ialah jenis titik terapung; untuk harga gunakan @Column('decimal', { precision: 10, scale: 2 }), yang dipulangkan TypeORM sebagai rentetan.
  • Hubungan tidak disimpulkan. Objek bersarang yang sebenarnya entity lain patut dijadikan hubungan @ManyToOne atau @OneToMany.

Soalan lazim

Entity ini dipetakan ke nama jadual apa?

@Entity() tiada nama, jadi penamaan lalai TypeORM menukar nama kelas kepada snake_case: support_ticket. Untuk jadual sedia ada, berikan namanya, contohnya @Entity('tickets').

Bagaimana jika emitDecoratorMetadata dimatikan?

@Column() tanpa pilihan membaca jenisnya daripada metadata reflection, jadi TypeORM gagal dengan ralat jenis data. Aktifkannya dalam tsconfig atau nyatakan setiap jenis, contohnya @Column('varchar').

Jenis pangkalan data apa yang diberikan kepada property Date?

datetime pada MySQL dan timestamp without time zone pada PostgreSQL. Jika zon waktu penting pada PostgreSQL, tukar kepada @Column('timestamptz').