แปลงข้อมูล JSON เป็นคลาส entity ของ TypeORM: คลาส @Entity() ที่มี primary key และทุกคีย์อื่นเป็นพร็อพเพอร์ตี @Column() พร้อมไทป์ TypeScript การเป็น null ได้ และ decorator ของ class-validator
ใช้สร้าง entity แรกสำหรับ TypeOrmModule.forFeature([...]) ในแอป NestJS + TypeORM หรือเมื่อเพิ่ม DataSource ของ TypeORM ในโปรเจกต์ Express และต้องการ entity ที่ตรงกับข้อมูลที่มีอยู่แล้ว
ชื่อโมเดล (ค่าเริ่มต้น MyModel) support ticket จะกลายเป็น SupportTicketsupport-ticket.entity.ts แล้วเพิ่มลงในอาร์เรย์ entities ของ DataSource หรือใน TypeOrmModule.forFeature([SupportTicket]) ของโมดูล NestJS[
{ "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" }
]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' เก็บชื่อคอลัมน์เดิมไว้
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 คืนเป็นข้อความ) ส่วนวันเวลาเป็น Datesimple-json ที่มีไทป์ Record<string, unknown> หรืออาร์เรย์ที่มีไทป์อย่าง string[]"007" ยังเป็นคอลัมน์ string@Column({ name: 'opened_at' }) เมื่อคีย์ JSON ต่างไปnull หรือขาดไปได้ nullable: true, | null และ @IsOptional() ที่เหลือได้ @IsNotEmpty()แทน ticket.entity.ts ว่าง ๆ ที่ nest g resource tickets สร้างไว้ด้วยผลลัพธ์นี้ entity จะตรงกับ mock data ที่ frontend ใช้อยู่แล้ว และ Repository<SupportTicket> ก็พร้อมใช้งาน
หลังสร้าง entity แล้ว typeorm migration:generate จะเทียบกับฐานข้อมูลและเขียน migration CREATE TABLE ให้ รวมถึงชื่อคอลัมน์และการเป็น null ได้
simple-json เก็บ JSON เป็นข้อความ จึงกรองด้วยค่าข้างในไม่ได้ ถ้าต้อง query ให้เปลี่ยนเป็น type: 'jsonb' บน PostgreSQL หรือ type: 'json' บน MySQLdouble precision เป็นไทป์ floating-point สำหรับราคาให้ใช้ @Column('decimal', { precision: 10, scale: 2 }) ซึ่ง TypeORM คืนค่าเป็นสตริง@ManyToOne หรือ @OneToMany@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')