Tukarkan JSON kepada Sequelize (TypeScript)!

Masukkan JSON dan tukarkannya kepada Sequelize (TypeScript)! Menyokong sequelize-typescript @Table, @Column, Model, class-validator.
JSON
Hasil
 

Tukarkan JSON kepada Sequelize (TypeScript)!

Menukar JSON kepada model berasaskan decorator untuk pustaka sequelize-typescript: kelas yang mewarisi Model dengan @Table dan @Column({ type: DataType.*, allowNull }), jenis property TypeScript, serta decorator class-validator untuk validasi.

Ia menyasarkan sequelize-typescript (pustaka di sebalik @nestjs/sequelize NestJS) dan bukan sequelize biasa, jadi laluan import dan ejaan DataType (tanpa s di hujung) berbeza daripada versi JavaScript.

Cara menggunakan

  1. Tampal objek JSON untuk satu baris jadual, atau tatasusunan baris.
  2. Masukkan nama kelas dalam Nama model (lalai MyModel); ia juga menjadi tableName dalam upper snake case pada @Table.
  3. Simpan hasilnya sebagai invoice.model.ts dan daftarkannya dengan new Sequelize({ ..., models: [Invoice] }) atau SequelizeModule.forFeature([Invoice]) 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 ialah rentetan kosong: ia bukan NULL, jadi lajurnya kekal allowNull: false, tetapi ia mendapat @IsOptional() dan bukan @IsNotEmpty(). amount menjadi DataType.DOUBLE, dan due_date menjadi DataType.DATEONLY berjenis string, kerana Sequelize memulangkan nilai tarikh sahaja sebagai teks.

Ciri yang disokong

  • Mengimport { Table, Column, Model, DataType } daripada sequelize-typescript dan mengisytiharkan kelas sebagai extends Model<Invoice>.
  • @Table({ tableName: 'INVOICE', timestamps: false }), sama seperti penjana JavaScript, jadi lajur createdAt/updatedAt tidak diandaikan.
  • Setiap @Column menyatakan type dan allowNull; lajur yang boleh null diberi jenis string | null dan seumpamanya.
  • Pasangan jenis: INTEGER/BIGINT/DOUBLE → number, BOOLEAN → boolean, DATE → Date, DATEONLY → string, JSON → Record<string, unknown> atau tatasusunan bertaip seperti string[].
  • Property ditulis dalam camelCase dengan field: 'invoice_no' menunjuk ke lajur asal; kunci id dalam JSON digunakan sebagai primary key dan tidak diduplikasi.
  • Medan yang mempunyai nilai tidak kosong dalam setiap baris mendapat @IsNotEmpty(); yang lain mendapat @IsOptional().

Kes penggunaan

Model untuk NestJS dengan `@nestjs/sequelize`

Apabila anda perlu menyimpan data yang dihantar sebagai JSON oleh sistem bil atau penyelesaian luaran, bina kelas model daripada payload itu dan gunakannya melalui @InjectModel(Invoice).

Menukar model Sequelize JavaScript kepada kod bertaip

Eksport data jadual sedia ada sebagai JSON dan tampalkannya untuk mendapat draf model bertaip, daripada menulis semula objek define() menjadi kelas secara manual.

Nota dan had

  • Untuk wang dan perpuluhan tepat yang lain, DataType.DECIMAL(12, 2) lebih selamat daripada DataType.DOUBLE.
  • experimentalDecorators dan emitDecoratorMetadata mesti diaktifkan dalam tsconfig supaya decorator berfungsi.
  • Dengan useDefineForClassFields (lalai untuk target ES2022 dan ke atas), pengisytiharan property biasa membayangi getter Sequelize. Matikan pilihan itu atau letakkan declare di hadapan property.

Soalan lazim

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

sequelize-typescript v2 menerima dua generic; kod yang dijana hanya menghantar kelas itu sendiri. Jika anda mahu Invoice.create({...}) diperiksa jenisnya tanpa medan yang dijana automatik seperti id, isytiharkan interface creation-attributes dan hantarnya sebagai generic kedua.

Mengapa DataType dan bukan DataTypes?

DataType ialah nama yang dieksport oleh sequelize-typescript. Mengimport DataTypes daripada sequelize berfungsi sama, tetapi menggunakan satu nama sahaja bagi setiap fail lebih mudah dibaca.

Adakah decorator class-validator diperiksa secara automatik pada model?

Tidak. Validasi hanya berlaku apabila anda sendiri memanggil validate(invoice) atau apabila decorator berada pada DTO yang dikendalikan oleh ValidationPipe NestJS. Untuk validasi di peringkat Sequelize, gunakan @Column({ validate: { notEmpty: true } }) atau decorator sequelize-typescript seperti @NotEmpty.