Konversi JSON ke Skema TypeORM!

Masukkan JSON dan konversikan ke skema TypeORM! Mendukung TypeORM @Entity, @PrimaryGeneratedColumn, @Column, NestJS.
JSON
Hasil
 

Konversi JSON ke Skema TypeORM!

Mengonversi data JSON menjadi class entity TypeORM: class @Entity() dengan primary key, dan setiap key lainnya sebagai properti @Column() dengan tipe TypeScript, nullability, dan decorator class-validator.

Gunakan untuk membuat entity pertama bagi TypeOrmModule.forFeature([...]) di aplikasi NestJS + TypeORM, atau saat menambahkan DataSource TypeORM ke proyek Express dan Anda butuh entity yang cocok dengan data yang sudah ada.

Cara menggunakan

  1. Tempel record yang akan disimpan sebagai objek, atau beberapa record sebagai array. Field yang tidak ada di sebagian record menjadi kolom nullable.
  2. Isi nama class entity di Nama model (default MyModel); support ticket menjadi SupportTicket.
  3. Simpan sebagai support-ticket.entity.ts dan tambahkan ke array entities di DataSource Anda atau ke TypeOrmModule.forFeature([SupportTicket]) di module 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 tidak memiliki assignee, jadi kolom itu menjadi @Column({ nullable: true }) dengan tipe string | null. opened_at menjadi properti openedAt bertipe Date, dengan name: 'opened_at' yang mempertahankan nama kolom aslinya.

Fitur yang didukung

  • Primary key dari data Anda: tanpa key id atau id integer → @PrimaryGeneratedColumn() id: number; id di atas rentang 32-bit → @PrimaryGeneratedColumn({ type: 'bigint' }) id: string; id string seperti UUID → @PrimaryColumn() id: string.
  • Tipe kolom: integer memakai @Column() default, desimal mendapat type: 'double precision' agar pecahan tidak terpotong, kolom bigint dan date (tanggal saja) bertipe string (TypeORM mengembalikannya sebagai teks), tanggal-waktu menjadi Date.
  • Objek dan array menjadi kolom simple-json bertipe Record<string, unknown> atau array bertipe seperti string[].
  • Angka bertanda kutip seperti "007" tetap menjadi kolom string.
  • Properti ditulis camelCase; @Column({ name: 'opened_at' }) ditambahkan setiap kali key JSON berbeda.
  • Field yang bernilai null atau tidak ada mendapat nullable: true, | null dan @IsOptional(); sisanya mendapat @IsNotEmpty().

Kasus penggunaan

Mengisi entity tepat setelah `nest g resource`

Ganti ticket.entity.ts kosong yang dibuat nest g resource tickets dengan output ini; entity kemudian cocok dengan mock data yang sudah dipakai frontend, dan Repository<SupportTicket> siap digunakan.

Titik awal untuk migration yang dibuat otomatis

Setelah membuat entity, typeorm migration:generate membandingkannya dengan database dan menulis migration CREATE TABLE, termasuk nama kolom dan nullability.

Catatan dan batasan

  • simple-json menyimpan JSON sebagai teks, jadi Anda tidak bisa memfilter berdasarkan nilai di dalamnya. Di PostgreSQL ganti ke type: 'jsonb', di MySQL ke type: 'json', jika Anda perlu melakukan query terhadapnya.
  • double precision adalah tipe floating-point; untuk harga gunakan @Column('decimal', { precision: 10, scale: 2 }), yang dikembalikan TypeORM sebagai string.
  • Relasi tidak disimpulkan. Objek bersarang yang sebenarnya adalah entity lain sebaiknya dijadikan relasi @ManyToOne atau @OneToMany.

FAQ

Entity ini dipetakan ke nama tabel apa?

@Entity() tidak diberi nama, jadi naming default TypeORM mengubah nama class menjadi snake_case: support_ticket. Untuk tabel yang sudah ada, berikan namanya, misalnya @Entity('tickets').

Bagaimana jika emitDecoratorMetadata dimatikan?

@Column() tanpa opsi membaca tipenya dari reflection metadata, sehingga TypeORM gagal dengan error tipe data. Aktifkan di tsconfig atau sebutkan setiap tipe, misalnya @Column('varchar').

Tipe database apa yang didapat properti Date?

datetime di MySQL dan timestamp without time zone di PostgreSQL. Jika zona waktu penting di PostgreSQL, ganti ke @Column('timestamptz').