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

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

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

یہ سادہ JavaScript میں لکھے Sequelize ماڈلز، sequelize.define("User", {...}) یا Model.init({...}, {...})، پڑھ کر انہیں مثالی JSON میں بدلتا ہے۔ چونکہ type annotations موجود نہیں، ہر attribute کی value اس کی DataTypes entry سے چنی جاتی ہے۔

یہ TypeScript کے بغیر Express اور Sequelize پر چلنے والے پرانے Node.js سرورز کے لیے موزوں ہے، جہاں ماڈل فائل ہی وہ واحد جگہ ہے جو بتاتی ہے کہ API response یا seed row کیسی دکھتی ہے۔

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

  1. ماڈل فائل Sequelize (JS) باکس میں پیسٹ کریں۔ بچی ہوئی require لائنیں اور module.exports رہنے دیں، کوئی مسئلہ نہیں۔
  2. اگر فائل کئی ماڈلز بیان کرتی ہے تو آؤٹ پٹ ماڈل نام کو key بنا کر آتا ہے، مثلاً { "User": {...}, "Post": {...} }۔
  3. چیک کریں کہ ماڈل options (دوسرا argument) جیسے timestamps، paranoid یا نام بدلا ہوا createdAt نتیجے میں ظاہر ہو رہے ہیں، پھر کاپی کریں۔

مثال

ان پٹ (Sequelize · JavaScript)
class Reservation extends Model {}

Reservation.init(
  {
    code: { type: DataTypes.UUID, defaultValue: DataTypes.UUIDV4, primaryKey: true },
    guests: DataTypes.SMALLINT,
    checkIn: DataTypes.DATEONLY,
    arrivalTime: DataTypes.TIME,
    options: DataTypes.JSONB,
    tags: DataTypes.ARRAY(DataTypes.STRING),
  },
  { sequelize, modelName: "Reservation", updatedAt: false }
);
آؤٹ پٹ (JSON)
{
  "code": "00000000-0000-0000-0000-000000000000",
  "guests": 0,
  "checkIn": "1970-01-01",
  "arrivalTime": "00:00:00",
  "options": {},
  "tags": [
    ""
  ],
  "createdAt": "1970-01-01T00:00:00.000Z"
}

code میں primaryKey: true ہے، اس لیے کوئی id شامل نہیں کیا جاتا، اور اس کا defaultValue، DataTypes.UUIDV4 ہے جو literal نہیں بلکہ generator ہے، اس لیے placeholder UUID دکھایا جاتا ہے۔ updatedAt: false کی وجہ سے صرف createdAt واحد timestamp رہتا ہے، اور DATEONLY، TIME، JSONB اور ARRAY(STRING) بالترتیب تاریخ کی string، وقت کی string، خالی آبجیکٹ اور ایک عنصر والی array بنتے ہیں۔

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

  • DataTypes.STRING، TEXT، CHAR → ""؛ INTEGER، BIGINT، FLOAT، DECIMAL → 0؛ BOOLEAN → false۔
  • DATE سے 1970-01-01T00:00:00.000Z، DATEONLY سے 1970-01-01 اور TIME سے 00:00:00 ملتا ہے۔
  • UUID تمام صفروں والی UUID string بنتا ہے، ENUM("admin", "user") اپنی پہلی value، اور JSON/JSONB خالی آبجیکٹ۔
  • ARRAY(DataTypes.STRING) اپنی element type کے مطابق ہوتا ہے، اور VIRTUAL(DataTypes.STRING) اندرونی type سے بھرا جاتا ہے۔
  • ماڈل options timestamps: false، updatedAt: false، createdAt: "created_on" اور paranoid: true تاریخ والے attributes کو شامل کرتے، ہٹاتے یا ان کا نام بدلتے ہیں۔
  • لمبی شکل { type: ..., allowNull: ... } اور مختصر شکل DataTypes.X دونوں سمجھی جاتی ہیں۔

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

seeder ڈیٹا کا ڈرافٹ

queryInterface.bulkInsert کے لیے objects کی array لکھتے وقت آؤٹ پٹ سے شروع کریں، تاکہ key نام اور types ماڈل سے میل کھائیں۔ جہاں ڈیٹا بیس خود بھرتا ہو وہاں بنایا گیا id اور timestamps ہٹا دیں۔

بغیر types والا legacy کوڈ پڑھنا

TypeScript کے بغیر صرف ماڈل پڑھ کر یہ بتانا مشکل ہے کہ وہ کون سا JSON بھیجتا ہے۔ ہر ماڈل فائل یہاں سے گزارنے پر API کی response شکلوں کا جلدی نقشہ مل جاتا ہے۔

نوٹس اور حدود

  • literal defaultValue ("pending"، 1، true) نمونہ value بنتی ہے۔ DataTypes.NOW، DataTypes.UUIDV4 یا sequelize.fn(...) جیسے generated defaults کی جگہ type کا placeholder آتا ہے۔
  • hasMany اور belongsTo جیسی associations ماڈل definition کے باہر ہوتی ہیں، اس لیے آؤٹ پٹ میں نہیں ہوتیں۔ include سے لوڈ کیا جانے والا ڈیٹا ہاتھ سے شامل کریں۔
  • MySQL اور PostgreSQL پر DECIMAL عموماً runtime پر string کی صورت میں آتا ہے، لیکن مثال 0 دکھاتی ہے۔
  • جن types کی کوئی واضح نمونہ value نہیں، جیسے GEOMETRY، وہ null بنتی ہیں۔

عام سوالات

میں نے underscored: true سیٹ کیا ہے۔ پھر created_at کے بجائے createdAt کیوں ہے؟

underscored صرف ڈیٹا بیس کالم ناموں کو snake_case میں بدلتا ہے۔ toJSON() جو attribute نام استعمال کرتا ہے وہ createdAt ہی رہتے ہیں، اس لیے آؤٹ پٹ میل کھاتا ہے۔ JSON key بھی بدلنی ہو تو createdAt: "created_at" سے واضح نام دیں۔

کیا یہ تب چلتا ہے جب class User extends Model {} اور User.init() الگ الگ ہوں؟

جی ہاں۔ .init( سے بالکل پہلے والا identifier ماڈل نام کے طور پر استعمال ہوتا ہے، اور پہلا argument attribute map کے طور پر پڑھا جاتا ہے۔

TypeScript decorator ماڈلز کہاں تبدیل کروں؟

@Table اور @Column والے sequelize-typescript ماڈلز کے لیے Sequelize (TS) to JSON صفحہ استعمال کریں۔ وہ صفحہ DataType کے بجائے property types پڑھتا ہے۔