JSON을 typeorm schema로 변환하세요!

JSON을 입력하면 TypeORM 엔티티(@Entity, @PrimaryGeneratedColumn, @Column)로 변환합니다! NestJS 프로젝트에.
JSON
결과
 

JSON을 typeorm schema로 변환하세요!

JSON 데이터를 TypeORM 엔티티 클래스로 바꿉니다. 기본 키가 있는 @Entity() 클래스가 만들어지고, 나머지 키는 TypeScript 타입과 null 허용 여부, class-validator 데코레이터가 붙은 @Column() 속성이 됩니다.

NestJS + TypeORM 앱에서 TypeOrmModule.forFeature([...])에 넣을 첫 엔티티를 만들 때, 또는 Express 프로젝트에 TypeORM DataSource를 붙이면서 이미 가진 데이터에 맞는 엔티티가 필요할 때 쓰세요.

사용 방법

  1. 저장할 레코드를 객체로, 또는 여러 레코드를 배열로 붙여넣습니다. 일부 레코드에 없는 필드는 null을 허용하는 컬럼이 됩니다.
  2. 엔티티 클래스 이름은 모델 이름 칸에 적습니다(기본값 MyModel). support ticket은 SupportTicket이 됩니다.
  3. support-ticket.entity.ts로 저장하고 DataSource의 entities 배열이나 NestJS 모듈의 TypeOrmModule.forFeature([SupportTicket])에 추가합니다.

예시

입력 (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은 Date 타입 속성 openedAt이 되고, name: 'opened_at'이 원래 컬럼 이름을 유지합니다.

지원 기능

  • 기본 키는 데이터를 따릅니다. id 키가 없거나 정수면 @PrimaryGeneratedColumn() id: number, 32비트 범위를 넘는 id면 @PrimaryGeneratedColumn({ type: 'bigint' }) id: string, UUID 같은 문자열 id면 @PrimaryColumn() id: string입니다.
  • 컬럼 타입: 정수는 기본 @Column(), 소수는 소수점이 잘리지 않도록 type: 'double precision'을 줍니다. bigint와 날짜만 있는 date 컬럼은 TypeORM이 문자열로 돌려주므로 string, 날짜와 시간은 Date입니다.
  • 객체와 배열은 simple-json 컬럼이 되고 타입은 Record<string, unknown>이나 string[] 같은 배열 타입입니다.
  • "007"처럼 따옴표로 감싼 숫자는 string 컬럼으로 남습니다.
  • 속성은 camelCase이고, JSON 키와 다르면 @Column({ name: 'opened_at' })을 붙입니다.
  • null이거나 빠졌던 필드에는 nullable: true, | null, @IsOptional()이 붙고, 나머지에는 @IsNotEmpty()가 붙습니다.

사용 사례

`nest g resource` 직후 엔티티 채우기

nest g resource tickets가 만든 빈 ticket.entity.ts를 이 결과로 바꾸면 프론트엔드가 쓰던 목 데이터와 같은 모양의 엔티티가 되고, Repository<SupportTicket>를 바로 쓸 수 있습니다.

마이그레이션 자동 생성의 출발점

엔티티를 만든 뒤 typeorm migration:generate를 실행하면 DB와 비교해 컬럼 이름과 null 여부까지 반영한 CREATE TABLE 마이그레이션을 써 줍니다.

주의사항

  • simple-json은 JSON을 텍스트로 저장하므로 안쪽 값으로 조회할 수 없습니다. 조회가 필요하면 PostgreSQL에서는 type: 'jsonb', MySQL에서는 type: 'json'으로 바꾸세요.
  • double precision은 부동소수점입니다. 가격에는 @Column('decimal', { precision: 10, scale: 2 })를 쓰세요(TypeORM이 문자열로 돌려줍니다).
  • 관계는 추론하지 않습니다. 사실상 다른 엔티티인 중첩 객체는 @ManyToOne이나 @OneToMany 관계로 바꾸세요.

자주 묻는 질문

엔티티는 어떤 테이블 이름에 매핑되나요?

@Entity()에 이름이 없어서 TypeORM 기본 규칙에 따라 클래스 이름을 snake_case로 바꾼 support_ticket이 됩니다. 기존 테이블에 맞추려면 @Entity('tickets')처럼 이름을 넘기세요.

emitDecoratorMetadata가 꺼져 있으면요?

옵션 없는 @Column()은 리플렉션 메타데이터에서 타입을 읽기 때문에 TypeORM이 데이터 타입 오류를 냅니다. tsconfig에서 켜거나 @Column('varchar')처럼 타입을 직접 적으세요.

Date 속성은 DB에서 어떤 타입이 되나요?

MySQL에서는 datetime, PostgreSQL에서는 timestamp without time zone입니다. PostgreSQL에서 시간대가 중요하다면 @Column('timestamptz')로 바꾸세요.