I-convert ang JSON sa Sequelize (TypeScript) Schema!

Ipasok ang JSON at i-convert ito sa Sequelize (TypeScript) Schema! Sinusuportahan ang sequelize-typescript @Table, @Column, Model, class-validator.
JSON
Resulta
 

I-convert ang JSON sa Sequelize (TypeScript) Schema!

Kino-convert ang JSON sa isang decorator-based na model para sa library na sequelize-typescript: isang class na nag-e-extend ng Model na may @Table at @Column({ type: DataType.*, allowNull }), mga TypeScript property type, at mga class-validator decorator para sa validation.

Naka-target ito sa sequelize-typescript (ang library sa likod ng @nestjs/sequelize ng NestJS) sa halip na plain na sequelize, kaya iba ang import path at ang spelling ng DataType (walang s sa dulo) kumpara sa JavaScript na bersyon.

Paano gamitin

  1. I-paste ang isang JSON object para sa isang row ng table, o array ng mga row.
  2. Ilagay ang class name sa Pangalan ng model (default MyModel); ito rin ang nagiging upper snake case na tableName sa @Table.
  3. I-save ang resulta bilang invoice.model.ts at i-register ito gamit ang new Sequelize({ ..., models: [Invoice] }) o ang SequelizeModule.forFeature([Invoice]) ng NestJS.

Halimbawa

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;
}

Empty string ang memo: hindi ito NULL, kaya napapanatili ng column ang allowNull: false, pero @IsOptional() ang nakukuha nito sa halip na @IsNotEmpty(). Nagiging DataType.DOUBLE ang amount, at nagiging DataType.DATEONLY na may type na string ang due_date, dahil text ang ibinabalik ng Sequelize para sa mga value na petsa lang.

Mga sinusuportahang feature

  • Ini-import ang { Table, Column, Model, DataType } mula sa sequelize-typescript at dine-declare ang class bilang extends Model<Invoice>.
  • @Table({ tableName: 'INVOICE', timestamps: false }), tugma sa JavaScript generator, kaya walang ipinapalagay na createdAt/updatedAt na column.
  • Tahasang isinasaad ng bawat @Column ang type at allowNull; may type na string | null at iba pa ang mga nullable na column.
  • Mga pares ng type: INTEGER/BIGINT/DOUBLE → number, BOOLEAN → boolean, DATE → Date, DATEONLY → string, JSON → Record<string, unknown> o typed array gaya ng string[].
  • camelCase ang mga property at tinuturo ng field: 'invoice_no' ang orihinal na column; ginagamit bilang primary key ang id key sa JSON sa halip na dobleng isama.
  • Nakakakuha ng @IsNotEmpty() ang mga field na may hindi blangkong value sa bawat row; @IsOptional() naman ang iba.

Mga gamit

Mga model para sa NestJS gamit ang `@nestjs/sequelize`

Kapag kailangan mong i-persist ang data na ipinapadala bilang JSON ng isang external na billing o settlement system, bumuo ng model class mula sa payload na iyon at gamitin ito sa pamamagitan ng @InjectModel(Invoice).

Paggawang typed code ng mga JavaScript Sequelize model

I-export bilang JSON ang data ng existing na table at i-paste ito para makakuha ng typed na model draft, sa halip na mano-manong isulat ulit bilang class ang isang define() object.

Mga paalala at limitasyon

  • Para sa pera at iba pang eksaktong decimal, mas ligtas ang DataType.DECIMAL(12, 2) kaysa sa DataType.DOUBLE.
  • Dapat naka-enable ang experimentalDecorators at emitDecoratorMetadata sa tsconfig para gumana ang mga decorator.
  • Kapag may useDefineForClassFields (ang default para sa target na ES2022 pataas), tinatakpan ng mga simpleng property declaration ang mga getter ng Sequelize. I-off ang option na iyon o lagyan ng declare sa unahan ang mga property.

Mga madalas itanong

Hindi ba dapat Model<InvoiceAttributes, InvoiceCreationAttributes> sa halip na Model<Invoice>?

Tumatanggap ng dalawang generic ang sequelize-typescript v2; ipinapasa lang ng na-generate na code ang mismong class. Kung gusto mong ma-type-check ang Invoice.create({...}) nang walang mga awtomatikong field gaya ng id, mag-declare ng creation-attributes interface at ipasa ito bilang pangalawang generic.

Bakit DataType at hindi DataTypes?

DataType ang pangalang ine-export ng sequelize-typescript. Pareho ang gana kapag in-import ang DataTypes mula sa sequelize, pero mas malinis basahin kung iisang pangalan lang bawat file.

Awtomatiko bang sinusuri sa model ang mga class-validator decorator?

Hindi. Nangyayari lang ang validation kapag ikaw mismo ang tumawag ng validate(invoice) o kapag nasa DTO na hinahawakan ng ValidationPipe ng NestJS ang mga decorator. Para sa validation sa level ng Sequelize, gamitin ang @Column({ validate: { notEmpty: true } }) o mga decorator ng sequelize-typescript gaya ng @NotEmpty.