JSON کو Sequelize (TypeScript) منصوبے میں تبدیل کریں!

JSON درج کریں اور اسے Sequelize (TypeScript) منصوبے میں تبدیل کریں! sequelize-typescript @Table, @Column, Model, class-validator سپورٹ۔
JSON
نتیجہ
 

JSON کو Sequelize (TypeScript) منصوبے میں تبدیل کریں!

JSON کو sequelize-typescript لائبریری کے لیے decorator پر مبنی ماڈل میں بدلتا ہے: Model کو extend کرنے والی کلاس، @Table اور @Column({ type: DataType.*, allowNull }) کے ساتھ، TypeScript property types، اور validation کے لیے class-validator decorators۔

یہ سادہ sequelize کے بجائے sequelize-typescript (NestJS کے @nestjs/sequelize کے پیچھے والی لائبریری) کو نشانہ بناتا ہے، اس لیے import path اور DataType کا ہجا (آخر میں s کے بغیر) JavaScript ورژن سے مختلف ہیں۔

استعمال کا طریقہ

  1. ایک table row کے لیے JSON آبجیکٹ، یا rows کی array پیسٹ کریں۔
  2. ماڈل کا نام میں کلاس کا نام لکھیں (ڈیفالٹ MyModel)؛ یہی @Table میں بڑے حروف والے snake case کا 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 خالی string ہے: یہ NULL نہیں، اس لیے کالم allowNull: false رکھتا ہے، لیکن اسے @IsNotEmpty() کے بجائے @IsOptional() ملتا ہے۔ amount بنتا ہے DataType.DOUBLE، اور due_date، string type کے ساتھ DataType.DATEONLY بنتا ہے، کیونکہ Sequelize صرف تاریخ والی values ٹیکسٹ کی صورت میں لوٹاتا ہے۔

معاون خصوصیات

  • sequelize-typescript سے { Table, Column, Model, DataType } import کرتا ہے اور کلاس کو extends Model<Invoice> ڈکلیئر کرتا ہے۔
  • @Table({ tableName: 'INVOICE', timestamps: false })، JavaScript generator کی طرح، اس لیے کوئی createdAt/updatedAt کالمز فرض نہیں کیے جاتے۔
  • ہر @Column، type اور allowNull واضح لکھتا ہے؛ nullable کالمز کی 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' اصل کالم کی طرف اشارہ کرتا ہے؛ JSON میں id key دوہری بنانے کے بجائے primary key کے طور پر استعمال ہوتی ہے۔
  • جن فیلڈز کی ہر row میں غیر خالی value ہو انہیں @IsNotEmpty() ملتا ہے؛ باقی کو @IsOptional() ملتا ہے۔

استعمال کے کیس

`@nestjs/sequelize` والے NestJS کے لیے ماڈلز

جب آپ کو وہ ڈیٹا محفوظ کرنا ہو جو کوئی بیرونی billing یا settlement سسٹم JSON کی صورت میں بھیجتا ہے، تو اسی payload سے ماڈل کلاس بنائیں اور اسے @InjectModel(Invoice) کے ذریعے استعمال کریں۔

JavaScript کے Sequelize ماڈلز کو typed کوڈ میں بدلنا

define() آبجیکٹ کو ہاتھ سے کلاس میں دوبارہ لکھنے کے بجائے موجودہ table کا ڈیٹا JSON کی صورت میں export کر کے پیسٹ کریں اور typed ماڈل کا ڈرافٹ حاصل کریں۔

نوٹس اور حدود

  • رقم اور دوسرے بالکل درست decimals کے لیے DataType.DECIMAL(12, 2)، DataType.DOUBLE سے زیادہ محفوظ ہے۔
  • decorators کے کام کرنے کے لیے tsconfig میں experimentalDecorators اور emitDecoratorMetadata فعال ہونے چاہئیں۔
  • useDefineForClassFields کے ساتھ (target ES2022 اور بعد کے لیے ڈیفالٹ)، سادہ property declarations Sequelize کے getters کو چھپا دیتی ہیں۔ وہ option بند کریں یا properties کے آگے declare لگائیں۔

عام سوالات

کیا Model<Invoice> کے بجائے Model<InvoiceAttributes, InvoiceCreationAttributes> نہیں ہونا چاہیے؟

sequelize-typescript v2 دو generics قبول کرتا ہے؛ بنایا گیا کوڈ بس کلاس خود ہی دے دیتا ہے۔ اگر آپ چاہتے ہیں کہ Invoice.create({...})، id جیسے خودکار فیلڈز کے بغیر type-check ہو تو creation-attributes interface ڈکلیئر کر کے اسے دوسرے generic کے طور پر دیں۔

DataTypes کیوں نہیں، DataType کیوں؟

DataType وہ نام ہے جو sequelize-typescript export کرتا ہے۔ sequelize سے DataTypes import کرنا بھی ویسے ہی کام کرتا ہے، لیکن ہر فائل میں ایک ہی نام پر قائم رہنا پڑھنے میں بہتر ہے۔

کیا class-validator decorators ماڈل پر خودبخود چیک ہوتے ہیں؟

نہیں۔ validation صرف تب ہوتی ہے جب آپ خود validate(invoice) کال کریں یا جب decorators کسی ایسے DTO پر ہوں جسے NestJS کا ValidationPipe سنبھالتا ہے۔ Sequelize کی سطح پر validation کے لیے @Column({ validate: { notEmpty: true } }) یا @NotEmpty جیسے sequelize-typescript decorators استعمال کریں۔