แปลง JSON เป็น TypeORM แผน!

ป้อน JSON และแปลงเป็น TypeORM แผน! รองรับ TypeORM @Entity, @PrimaryGeneratedColumn, @Column, NestJS
JSON
ผลลัพธ์
 

แปลง JSON เป็น TypeORM แผน!

แปลงข้อมูล JSON เป็นคลาส entity ของ TypeORM: คลาส @Entity() ที่มี primary key และทุกคีย์อื่นเป็นพร็อพเพอร์ตี @Column() พร้อมไทป์ TypeScript การเป็น null ได้ และ decorator ของ class-validator

ใช้สร้าง entity แรกสำหรับ TypeOrmModule.forFeature([...]) ในแอป NestJS + TypeORM หรือเมื่อเพิ่ม DataSource ของ TypeORM ในโปรเจกต์ Express และต้องการ entity ที่ตรงกับข้อมูลที่มีอยู่แล้ว

วิธีใช้

  1. วางเรคคอร์ดที่จะเก็บเป็นออบเจ็กต์ หรือหลายเรคคอร์ดเป็นอาร์เรย์ ฟิลด์ที่ขาดไปในบางเรคคอร์ดจะกลายเป็นคอลัมน์ที่เป็น null ได้
  2. ใส่ชื่อคลาส entity ใน ชื่อโมเดล (ค่าเริ่มต้น MyModel) support ticket จะกลายเป็น SupportTicket
  3. บันทึกเป็น support-ticket.entity.ts แล้วเพิ่มลงในอาร์เรย์ entities ของ DataSource หรือใน TypeOrmModule.forFeature([SupportTicket]) ของโมดูล NestJS

ตัวอย่าง

อินพุต (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" }
]
เอาต์พุต (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;
}

ทิกเก็ตที่สองไม่มี assignee คอลัมน์นั้นจึงเป็น @Column({ nullable: true }) ที่มีไทป์ string | null ส่วน opened_at กลายเป็นพร็อพเพอร์ตี openedAt ไทป์ Date โดยมี name: 'opened_at' เก็บชื่อคอลัมน์เดิมไว้

ฟีเจอร์ที่รองรับ

  • primary key มาจากข้อมูลของคุณ: ไม่มีคีย์ id หรือ id เป็นจำนวนเต็ม → @PrimaryGeneratedColumn() id: number, id ที่เกินช่วง 32 บิต → @PrimaryGeneratedColumn({ type: 'bigint' }) id: string, id ที่เป็นสตริงอย่าง UUID → @PrimaryColumn() id: string
  • ไทป์คอลัมน์: จำนวนเต็มใช้ @Column() ค่าเริ่มต้น ทศนิยมได้ type: 'double precision' เพื่อไม่ให้เศษถูกตัด คอลัมน์ bigint และ date ที่มีแต่วันที่มีไทป์ string (TypeORM คืนเป็นข้อความ) ส่วนวันเวลาเป็น Date
  • ออบเจ็กต์และอาร์เรย์กลายเป็นคอลัมน์ simple-json ที่มีไทป์ Record<string, unknown> หรืออาร์เรย์ที่มีไทป์อย่าง string[]
  • ตัวเลขในเครื่องหมายคำพูดอย่าง "007" ยังเป็นคอลัมน์ string
  • พร็อพเพอร์ตีเป็น camelCase และเพิ่ม @Column({ name: 'opened_at' }) เมื่อคีย์ JSON ต่างไป
  • ฟิลด์ที่เป็น null หรือขาดไปได้ nullable: true, | null และ @IsOptional() ที่เหลือได้ @IsNotEmpty()

กรณีการใช้งาน

เติม entity หลังรัน `nest g resource`

แทน ticket.entity.ts ว่าง ๆ ที่ nest g resource tickets สร้างไว้ด้วยผลลัพธ์นี้ entity จะตรงกับ mock data ที่ frontend ใช้อยู่แล้ว และ Repository<SupportTicket> ก็พร้อมใช้งาน

จุดเริ่มต้นสำหรับ migration ที่สร้างอัตโนมัติ

หลังสร้าง entity แล้ว typeorm migration:generate จะเทียบกับฐานข้อมูลและเขียน migration CREATE TABLE ให้ รวมถึงชื่อคอลัมน์และการเป็น null ได้

ข้อควรระวังและข้อจำกัด

  • simple-json เก็บ JSON เป็นข้อความ จึงกรองด้วยค่าข้างในไม่ได้ ถ้าต้อง query ให้เปลี่ยนเป็น type: 'jsonb' บน PostgreSQL หรือ type: 'json' บน MySQL
  • double precision เป็นไทป์ floating-point สำหรับราคาให้ใช้ @Column('decimal', { precision: 10, scale: 2 }) ซึ่ง TypeORM คืนค่าเป็นสตริง
  • ไม่อนุมานความสัมพันธ์ ออบเจ็กต์ที่ซ้อนอยู่ซึ่งจริง ๆ เป็น entity อื่น ควรเปลี่ยนเป็นความสัมพันธ์ @ManyToOne หรือ @OneToMany

คำถามที่พบบ่อย

entity จับคู่กับตารางชื่ออะไร?

@Entity() ไม่ได้ระบุชื่อ การตั้งชื่อค่าเริ่มต้นของ TypeORM จึงแปลงชื่อคลาสเป็น snake_case: support_ticket ถ้าเป็นตารางที่มีอยู่แล้ว ให้ส่งชื่อเข้าไป เช่น @Entity('tickets')

ถ้าปิด emitDecoratorMetadata อยู่ล่ะ?

@Column() ที่ไม่มี option อ่านไทป์จาก reflection metadata TypeORM จึงล้มเหลวด้วย data type error ให้เปิดใน tsconfig หรือระบุไทป์ทุกตัว เช่น @Column('varchar')

พร็อพเพอร์ตี Date ได้ไทป์อะไรในฐานข้อมูล?

datetime บน MySQL และ timestamp without time zone บน PostgreSQL ถ้าเขตเวลาสำคัญบน PostgreSQL ให้เปลี่ยนเป็น @Column('timestamptz')