Konversi JSON ke Skema Sequelize (TypeScript)!

Masukkan JSON dan konversikan ke skema Sequelize (TypeScript)! Mendukung sequelize-typescript @Table, @Column, Model, class-validator.
JSON
Hasil
 

Konversi JSON ke Skema Sequelize (TypeScript)!

Mengonversi JSON menjadi model berbasis decorator untuk library sequelize-typescript: class yang meng-extend Model dengan @Table dan @Column({ type: DataType.*, allowNull }), tipe properti TypeScript, dan decorator class-validator untuk validasi.

Alat ini menargetkan sequelize-typescript (library di balik @nestjs/sequelize milik NestJS), bukan sequelize biasa, jadi path import dan ejaan DataType (tanpa s di belakang) berbeda dari versi JavaScript.

Cara menggunakan

  1. Tempel objek JSON untuk satu baris tabel, atau array berisi beberapa baris.
  2. Isi nama class di Nama model (default MyModel); nama ini juga menjadi tableName berformat upper snake case di @Table.
  3. Simpan hasilnya sebagai invoice.model.ts dan daftarkan dengan new Sequelize({ ..., models: [Invoice] }) atau SequelizeModule.forFeature([Invoice]) milik NestJS.

Contoh

Input (JSON)
{
  "invoice_no": "INV-2024-0042",
  "amount": 1250.75,
  "currency": "EUR",
  "paid": false,
  "due_date": "2024-07-31",
  "memo": ""
}
Output (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 adalah string kosong: bukan NULL, jadi kolomnya tetap allowNull: false, tetapi mendapat @IsOptional() dan bukan @IsNotEmpty(). amount menjadi DataType.DOUBLE, dan due_date menjadi DataType.DATEONLY bertipe string, karena Sequelize mengembalikan nilai tanggal saja sebagai teks.

Fitur yang didukung

  • Meng-import { Table, Column, Model, DataType } dari sequelize-typescript dan mendeklarasikan class sebagai extends Model<Invoice>.
  • @Table({ tableName: 'INVOICE', timestamps: false }), sama seperti generator JavaScript, jadi kolom createdAt/updatedAt tidak diasumsikan.
  • Setiap @Column menyebutkan type dan allowNull; kolom nullable bertipe string | null dan seterusnya.
  • Pasangan tipe: INTEGER/BIGINT/DOUBLE → number, BOOLEAN → boolean, DATE → Date, DATEONLY → string, JSON → Record<string, unknown> atau array bertipe seperti string[].
  • Properti ditulis camelCase dengan field: 'invoice_no' yang menunjuk ke kolom aslinya; key id di JSON dipakai sebagai primary key, bukan diduplikasi.
  • Field yang memiliki nilai tidak kosong di setiap baris mendapat @IsNotEmpty(); sisanya mendapat @IsOptional().

Kasus penggunaan

Model untuk NestJS dengan `@nestjs/sequelize`

Saat Anda perlu menyimpan data yang dikirim sistem billing atau settlement eksternal sebagai JSON, bangun class model dari payload itu dan gunakan lewat @InjectModel(Invoice).

Mengubah model Sequelize JavaScript menjadi kode bertipe

Ekspor data tabel yang ada sebagai JSON lalu tempel untuk mendapatkan draf model bertipe, alih-alih menulis ulang objek define() menjadi class secara manual.

Catatan dan batasan

  • Untuk uang dan desimal presisi lainnya, DataType.DECIMAL(12, 2) lebih aman daripada DataType.DOUBLE.
  • experimentalDecorators dan emitDecoratorMetadata harus diaktifkan di tsconfig agar decorator berfungsi.
  • Dengan useDefineForClassFields (default untuk target ES2022 ke atas), deklarasi properti biasa menutupi getter Sequelize. Matikan opsi itu atau beri prefix declare pada properti.

FAQ

Bukankah seharusnya Model<InvoiceAttributes, InvoiceCreationAttributes> dan bukan Model<Invoice>?

sequelize-typescript v2 menerima dua generic; kode yang dihasilkan cukup memberikan class itu sendiri. Jika Anda ingin Invoice.create({...}) diperiksa tipenya tanpa field yang dibuat otomatis seperti id, deklarasikan interface creation-attributes dan berikan sebagai generic kedua.

Mengapa DataType dan bukan DataTypes?

DataType adalah nama yang diekspor sequelize-typescript. Meng-import DataTypes dari sequelize berfungsi sama, tetapi memakai satu nama saja per file lebih mudah dibaca.

Apakah decorator class-validator diperiksa otomatis pada model?

Tidak. Validasi hanya terjadi ketika Anda sendiri memanggil validate(invoice) atau ketika decorator berada di DTO yang ditangani ValidationPipe NestJS. Untuk validasi di level Sequelize, gunakan @Column({ validate: { notEmpty: true } }) atau decorator sequelize-typescript seperti @NotEmpty.