Sequelize (TS) ماڈلز کو JSON میں تبدیل کریں!

Sequelize (TS) ماڈلز درج کریں اور مثالی JSON بنائیں! Sequelize, sequelize-typescript سپورٹ۔ API دستاویزات اور ٹیسٹ request body (sample JSON) کے لیے مفید۔
Sequelize (TS)
نتیجہ
 

Sequelize (TS) ماڈلز کو JSON میں تبدیل کریں!

اسے sequelize-typescript سے لکھی گئی @Table ماڈل کلاسز دیں اور یہ instance کے toJSON() آؤٹ پٹ کی شکل والا مثالی JSON بناتا ہے۔ اس میں وہ id، createdAt، updatedAt اور deletedAt attributes بھی شامل ہیں جو Sequelize کلاس میں ڈکلیئر نہ ہونے پر بھی شامل کرتا ہے۔

JS والے صفحے کے برعکس یہاں values DataType argument کے بجائے ہر property کی TypeScript type سے آتی ہیں۔ amount: string کے طور پر ڈکلیئر کیا گیا @Column(DataType.DECIMAL) ایک string بناتا ہے۔

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

  1. @Table کلاسز والی فائل Sequelize (TS) باکس میں پیسٹ کریں۔ nested values حاصل کرنے کے لیے associated ماڈلز (@HasMany وغیرہ کے ذریعے) بھی شامل کریں۔
  2. خودکار شامل کیے گئے attributes والا JSON نتیجہ باکس میں دیکھیں۔
  3. timestamps یا paranoid جیسے @Table options بدل کر فوراً دیکھیں کہ تاریخ والے فیلڈز کیسے بدلتے ہیں۔

مثال

ان پٹ (sequelize-typescript)
@Table({ tableName: "invoices", paranoid: true })
export class Invoice extends Model {
  @Column(DataType.STRING(20))
  number: string;

  @Column(DataType.DECIMAL(10, 2))
  amount: string;

  @Column(DataType.ENUM("draft", "sent", "paid"))
  status: "draft" | "sent" | "paid";

  @ForeignKey(() => Customer)
  @Column
  customerId: number;
}
آؤٹ پٹ (JSON)
{
  "id": 0,
  "number": "",
  "amount": "",
  "status": "draft",
  "customerId": 0,
  "createdAt": "1970-01-01T00:00:00.000Z",
  "updatedAt": "1970-01-01T00:00:00.000Z",
  "deletedAt": null
}

کلاس میں کوئی primary key نہیں، اس لیے سب سے پہلے id شامل کیا جاتا ہے، اور paranoid: true، deletedAt: null شامل کرتا ہے۔ status اپنے union کا پہلا literal "draft" لیتا ہے، اور amount خالی string ہے کیونکہ وہ string کے طور پر ڈکلیئر ہے۔

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

  • @PrimaryKey، @Column({ primaryKey: true }) یا id property کے بغیر سب سے اوپر id: 0 ڈالا جاتا ہے، root اور associated ماڈلز دونوں کے لیے۔
  • جب تک @Table، timestamps: false سیٹ نہ کرے، createdAt اور updatedAt آخر میں جوڑے جاتے ہیں؛ createdAt: "created_on" جیسے نام کی تبدیلی، updatedAt: false اور paranoid: true (deletedAt: null) ہر ماڈل کے لیے الگ لاگو ہوتے ہیں۔
  • @HasMany سے Post[] ایک array بنتا ہے؛ @BelongsTo اور @HasOne nested objects بنتے ہیں۔
  • "draft" | "sent" جیسے literal unions پہلی value استعمال کرتے ہیں، اور extends Model سے وراثت میں ملنے والی ہر چیز نظر انداز ہوتی ہے۔
  • آبجیکٹ type والا DataType.JSON کالم، مثلاً { theme: string }، اسی شکل میں بھرا جاتا ہے۔

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

Express handlers کی documentation

res.json(await Invoice.findByPk(id)) کرنے والے endpoints کے لیے آؤٹ پٹ ایسی response مثال دیتا ہے جس کی keys حقیقت سے میل کھاتی ہیں، خودکار شامل attributes سمیت۔

soft delete فعال کرنے سے پہلے اور بعد

paranoid آن کرنے سے ہر response میں deletedAt شامل ہو جاتا ہے۔ API استعمال کرنے والوں کو ٹھیک ٹھیک بتانے کے لیے کہ کیا بدلے گا، option آن اور بند کر کے آؤٹ پٹ کا موازنہ کریں۔

نوٹس اور حدود

  • root کے اندر nested associated ماڈلز کو اپنے @Table options سے اپنا id اور timestamps ملتے ہیں، لیکن Sequelize کی ضمنی طور پر شامل کی گئی foreign keys (جیسے @ForeignKey کالم کے بغیر @HasMany target پر invoiceId) گھڑی نہیں جاتیں۔
  • allowNull اور @Column({ field: ... }) کے ذریعے کالم کے نام کی تبدیلی نظر انداز ہوتی ہے، کیونکہ JSON keys property نام ہوتے ہیں۔ @Default("x") اور @Column({...}) میں literal defaultValue نمونہ values کے طور پر استعمال ہوتے ہیں۔
  • underscored: true صرف ڈیٹا بیس کالم نام بدلتا ہے؛ toJSON() پھر بھی attribute نام استعمال کرتا ہے، اس لیے آؤٹ پٹ میں createdAt درست ہے۔
  • values TypeScript types سے آتی ہیں، اس لیے جس property کی type صرف decorator میں ہو (@Column(DataType.INTEGER) count; بغیر annotation کے) وہ null بنتی ہے۔

عام سوالات

DECIMAL کالم کی type number ہو یا string؟

MySQL اور PostgreSQL کے ساتھ Sequelize بطور ڈیفالٹ DECIMAL values کو strings کی صورت میں لوٹاتا ہے۔ اسے amount: string لکھنا type کو سچا رکھتا ہے، اور یہاں کی مثال بھی string دکھائے گی۔

کیا میں declare فیلڈز یا CreationOptional استعمال کر سکتا ہوں؟

جی ہاں۔ declare id: CreationOptional<number> کو number پڑھا جاتا ہے، اور یہی کھولنا NonAttribute<...> اور ForeignKey<...> پر بھی لاگو ہوتا ہے۔ ان کے علاوہ InferAttributes جیسی helper types نہیں کھولی جاتیں۔

کیا یہ صفحہ JavaScript میں لکھے sequelize.define ماڈلز سنبھالتا ہے؟

نہیں۔ یہ صفحہ کلاسز اور TypeScript types پڑھتا ہے۔ define اور Model.init ماڈلز کے لیے Sequelize (JS) to JSON صفحہ استعمال کریں، جو اس کے بجائے DataTypes پڑھتا ہے۔