JSON को Sequelize (TypeScript) स्कीमा में बदलें!

JSON दर्ज करें और इसे Sequelize (TypeScript) स्कीमा में बदलें! sequelize-typescript @Table, @Column, Model, class-validator समर्थित।
JSON
परिणाम
 

JSON को Sequelize (TypeScript) स्कीमा में बदलें!

JSON को sequelize-typescript library के decorator-आधारित model में बदलता है: @Table और @Column({ type: DataType.*, allowNull }) वाली Model को extend करने वाली class, TypeScript property types, और validation के लिए class-validator decorators।

यह सादे sequelize की बजाय sequelize-typescript (NestJS के @nestjs/sequelize के पीछे की library) को target करता है, इसलिए import path और DataType की spelling (अंत में s नहीं) JavaScript version से अलग हैं।

उपयोग कैसे करें

  1. एक table row के लिए JSON object, या rows का array पेस्ट करें।
  2. मॉडल का नाम में class का नाम डालें (default MyModel); यही @Table में upper snake case tableName भी बनता है।
  3. परिणाम को invoice.model.ts के रूप में सेव करें और new Sequelize({ ..., models: [Invoice] }) या NestJS के SequelizeModule.forFeature([Invoice]) से register करें।

उदाहरण

इनपुट (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 खाली string है: वह NULL नहीं है, इसलिए column allowNull: false रखता है, लेकिन उसे @IsNotEmpty() की बजाय @IsOptional() मिलता है। amount DataType.DOUBLE बनता है, और due_date string type के साथ DataType.DATEONLY बनता है, क्योंकि Sequelize सिर्फ़ तारीख वाली values को टेक्स्ट के रूप में लौटाता है।

समर्थित सुविधाएँ

  • sequelize-typescript से { Table, Column, Model, DataType } import करता है और class को extends Model<Invoice> के रूप में declare करता है।
  • @Table({ tableName: 'INVOICE', timestamps: false }), JavaScript generator जैसा, इसलिए createdAt/updatedAt columns नहीं माने जाते।
  • हर @Column type और allowNull बताता है; nullable columns का type string | null वगैरह होता है।
  • Type जोड़ियां: INTEGER/BIGINT/DOUBLE → number, BOOLEAN → boolean, DATE → Date, DATEONLY → string, JSON → Record<string, unknown> या string[] जैसा typed array।
  • Properties camelCase हैं और field: 'invoice_no' मूल column की ओर इशारा करता है; JSON की id key दोहराई नहीं जाती बल्कि primary key के रूप में इस्तेमाल होती है।
  • हर row में खाली न होने वाली वैल्यू वाले fields को @IsNotEmpty() मिलता है; बाकी को @IsOptional()।

उपयोग के मामले

`@nestjs/sequelize` वाले NestJS के लिए models

जब बाहरी billing या settlement system का JSON में भेजा data persist करना हो, तो उस payload से model class बनाएं और उसे @InjectModel(Invoice) के ज़रिए इस्तेमाल करें।

JavaScript Sequelize models को typed कोड में बदलना

define() object को हाथ से class में दोबारा लिखने की बजाय, मौजूदा table data को JSON के रूप में export करके पेस्ट करें और typed model draft पाएं।

नोट्स और सीमाएँ

  • पैसे और दूसरे सटीक decimals के लिए DataType.DOUBLE से DataType.DECIMAL(12, 2) ज़्यादा सुरक्षित है।
  • Decorators काम करें, इसके लिए tsconfig में experimentalDecorators और emitDecoratorMetadata चालू होने चाहिए।
  • useDefineForClassFields (target ES2022 और बाद के लिए default) के साथ सादे property declarations Sequelize के getters को ढक देते हैं। उस option को बंद करें या properties के आगे declare लगाएं।

अक्सर पूछे जाने वाले प्रश्न

क्या Model<Invoice> की बजाय Model<InvoiceAttributes, InvoiceCreationAttributes> नहीं होना चाहिए?

sequelize-typescript v2 दो generics स्वीकार करता है; बना हुआ कोड बस class खुद को देता है। अगर आप चाहते हैं कि id जैसे auto-generated fields के बिना Invoice.create({...}) type-check हो, तो creation-attributes interface declare करें और उसे दूसरे generic के रूप में दें।

DataTypes की बजाय DataType क्यों?

DataType वह नाम है जिसे sequelize-typescript export करता है। sequelize से DataTypes import करना भी वैसे ही काम करता है, लेकिन एक फ़ाइल में एक ही नाम रखना ज़्यादा पढ़ने लायक है।

क्या model पर class-validator decorators अपने-आप जांचे जाते हैं?

नहीं। Validation तभी होता है जब आप खुद validate(invoice) call करें या decorators NestJS के ValidationPipe से संभाले जाने वाले DTO पर हों। Sequelize-level validation के लिए @Column({ validate: { notEmpty: true } }) या @NotEmpty जैसे sequelize-typescript decorators इस्तेमाल करें।