JSON을 sequelize schema(typescript)로 변환하세요!

JSON을 입력하면 sequelize-typescript 모델(@Table, @Column, Model)로 변환합니다! class-validator 포함.
JSON
결과
 

JSON을 sequelize schema(typescript)로 변환하세요!

JSON을 sequelize-typescript 라이브러리용 데코레이터 모델로 바꿉니다. @Table과 @Column({ type: DataType.*, allowNull })이 붙은 Model 상속 클래스, TypeScript 속성 타입, 검증용 class-validator 데코레이터가 함께 나옵니다.

일반 sequelize가 아니라 sequelize-typescript(NestJS @nestjs/sequelize가 쓰는 라이브러리)를 대상으로 하므로, import 경로와 DataType 표기(끝에 s 없음)가 JavaScript 버전과 다릅니다.

사용 방법

  1. 테이블 한 행을 나타내는 JSON 객체나 여러 행의 배열을 붙여넣습니다.
  2. 모델 이름에 클래스 이름을 적습니다(기본값 MyModel). 이 이름을 대문자 스네이크 표기로 바꾼 값이 @Table의 tableName이 됩니다.
  3. 결과를 invoice.model.ts로 저장하고 new Sequelize({ ..., models: [Invoice] })나 NestJS의 SequelizeModule.forFeature([Invoice])에 등록합니다.

예시

입력 (JSON)
{
  "invoice_no": "INV-2024-0042",
  "amount": 1250.75,
  "currency": "EUR",
  "paid": false,
  "due_date": "2024-07-31",
  "memo": ""
}
출력 (sequelize-typescript)
import { Table, Column, Model, DataType } from 'sequelize-typescript';
import { IsNotEmpty, IsOptional } from 'class-validator';

@Table({ tableName: 'INVOICE', timestamps: false })
export class Invoice extends Model<Invoice> {
  @Column({ type: DataType.INTEGER, primaryKey: true, autoIncrement: true })
  id: number;

  @Column({ type: DataType.STRING, allowNull: false, field: 'invoice_no' })
  @IsNotEmpty()
  invoiceNo: string;

  @Column({ type: DataType.DOUBLE, allowNull: false })
  @IsNotEmpty()
  amount: number;

  @Column({ type: DataType.STRING, allowNull: false })
  @IsNotEmpty()
  currency: string;

  @Column({ type: DataType.BOOLEAN, allowNull: false })
  @IsNotEmpty()
  paid: boolean;

  @Column({ type: DataType.DATEONLY, allowNull: false, field: 'due_date' })
  @IsNotEmpty()
  dueDate: string;

  @Column({ type: DataType.STRING, allowNull: false })
  @IsOptional()
  memo: string;
}

memo는 빈 문자열입니다. NULL은 아니어서 컬럼은 allowNull: false를 유지하지만, @IsNotEmpty() 대신 @IsOptional()이 붙습니다. amount는 DataType.DOUBLE, due_date는 DataType.DATEONLY이고 타입은 string인데, Sequelize가 날짜만 있는 값을 문자열로 돌려주기 때문입니다.

지원 기능

  • sequelize-typescript에서 { Table, Column, Model, DataType }을 가져오고 클래스를 extends Model<Invoice>로 선언합니다.
  • @Table({ tableName: 'INVOICE', timestamps: false })로 JavaScript 생성기와 같게 맞춰서 createdAt/updatedAt 컬럼을 가정하지 않습니다.
  • 모든 @Column에 type과 allowNull을 적고, null을 허용하는 컬럼은 string | null처럼 타입에도 반영합니다.
  • 타입 짝: INTEGER/BIGINT/DOUBLE → number, BOOLEAN → boolean, DATE → Date, DATEONLY → string, JSON → Record<string, unknown> 또는 string[] 같은 배열 타입.
  • 속성은 camelCase이고 field: 'invoice_no'가 원래 컬럼을 가리킵니다. JSON의 id 키는 중복 선언하지 않고 기본 키로 씁니다.
  • 모든 행에 비어 있지 않은 값이 있는 필드는 @IsNotEmpty(), 나머지는 @IsOptional()입니다.

사용 사례

`@nestjs/sequelize`를 쓰는 NestJS 모델

외부 청구·정산 시스템이 JSON으로 보내는 데이터를 저장해야 할 때, 그 페이로드로 모델 클래스를 만들어 @InjectModel(Invoice)로 바로 쓸 수 있습니다.

JavaScript Sequelize 모델을 타입 있는 코드로

define() 객체를 손으로 클래스로 옮기는 대신, 기존 테이블 데이터를 JSON으로 내보내 붙여넣어 타입이 붙은 모델 초안을 받으세요.

주의사항

  • 금액처럼 정확한 소수가 필요하면 DataType.DOUBLE보다 DataType.DECIMAL(12, 2)가 안전합니다.
  • 데코레이터가 동작하려면 tsconfig에서 experimentalDecorators와 emitDecoratorMetadata를 켜야 합니다.
  • useDefineForClassFields가 켜져 있으면(target이 ES2022 이상일 때 기본값) 일반 속성 선언이 Sequelize의 getter를 가립니다. 이 옵션을 끄거나 속성 앞에 declare를 붙이세요.

자주 묻는 질문

Model<Invoice>가 아니라 Model<InvoiceAttributes, InvoiceCreationAttributes>여야 하지 않나요?

sequelize-typescript v2는 제네릭 두 개를 받지만, 생성 코드는 클래스 자신을 넘기는 간단한 형태입니다. id처럼 자동 생성되는 필드를 빼고 Invoice.create({...})의 타입을 검사하고 싶다면 생성용 속성 인터페이스를 따로 만들어 두 번째 제네릭으로 넘기세요.

DataTypes가 아니라 DataType인 이유는요?

DataType은 sequelize-typescript가 내보내는 이름입니다. sequelize의 DataTypes를 가져와도 동작은 같지만, 한 파일에서는 한 가지 이름만 쓰는 편이 읽기 좋습니다.

class-validator 데코레이터가 모델에서 자동으로 검사되나요?

아닙니다. 직접 validate(invoice)를 호출하거나, NestJS ValidationPipe가 처리하는 DTO에 데코레이터가 있을 때만 검사됩니다. Sequelize 단계에서 검증하려면 @Column({ validate: { notEmpty: true } })나 sequelize-typescript의 @NotEmpty 같은 데코레이터를 쓰세요.