Sequelize (JS) मॉडल को JSON में बदलें!

Sequelize (JS) मॉडल डालें और उदाहरण JSON बनाएँ! Sequelize define, DataTypes समर्थित। API डॉक्यूमेंटेशन और टेस्ट request body (sample JSON) के लिए उपयोगी।
Sequelize (JS)
परिणाम
 

Sequelize (JS) मॉडल को JSON में बदलें!

यह सादे JavaScript में लिखे Sequelize models, sequelize.define("User", {...}) या Model.init({...}, {...}), पढ़कर उन्हें उदाहरण JSON में बदलता है। Type annotations न होने के कारण हर attribute की वैल्यू उसकी DataTypes entry से चुनी जाती है।

यह TypeScript के बिना Express और Sequelize चलाने वाले पुराने Node.js servers के लिए ठीक है, जहां model फ़ाइल ही इकलौता विवरण है कि API response या seed row कैसी दिखती है।

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

  1. Model फ़ाइल को Sequelize (JS) बॉक्स में पेस्ट करें। बची हुई require lines और module.exports से कोई दिक्कत नहीं।
  2. अगर फ़ाइल कई models define करती है, तो आउटपुट model नाम से keyed होता है, जैसे { "User": {...}, "Post": {...} }।
  3. जांचें कि timestamps, paranoid या rename हुए createdAt जैसे model options (दूसरा argument) प्रतिबिंबित हुए हैं, फिर कॉपी करें।

उदाहरण

इनपुट (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) क्रमशः date string, time string, खाली object और एक element वाला 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 पूरी तरह zero वाली UUID string बनता है, ENUM("admin", "user") अपनी पहली वैल्यू, और JSON/JSONB खाली object।
  • ARRAY(DataTypes.STRING) अपने element type का पालन करता है, और VIRTUAL(DataTypes.STRING) अंदर के type से भरा जाता है।
  • Model options timestamps: false, updatedAt: false, createdAt: "created_on" और paranoid: true date attributes जोड़ते, हटाते या rename करते हैं।
  • लंबा रूप { type: ..., allowNull: ... } और छोटा रूप DataTypes.X दोनों समझे जाते हैं।

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

Seeder data का draft

queryInterface.bulkInsert के लिए object array लिखते समय आउटपुट से शुरू करें, ताकि key नाम और types model से मेल खाएं। जहां database खुद भरता है वहां बने हुए id और timestamps हटा दें।

बिना types वाला legacy कोड पढ़ना

TypeScript के बिना सिर्फ़ पढ़कर यह बताना मुश्किल है कि कोई model कौन सा JSON भेजता है। हर model फ़ाइल को यहां से गुज़ारने पर API के response आकारों का एक त्वरित नक्शा मिल जाता है।

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

  • Literal defaultValue ("pending", 1, true) sample वैल्यू बनता है। DataTypes.NOW, DataTypes.UUIDV4 या sequelize.fn(...) जैसे generated defaults type के placeholder पर लौट जाते हैं।
  • hasMany और belongsTo जैसे associations model definition के बाहर रहते हैं, इसलिए आउटपुट में नहीं होते। include से load होने वाला data हाथ से जोड़ें।
  • MySQL और PostgreSQL पर DECIMAL runtime पर आमतौर पर string के रूप में लौटता है, लेकिन उदाहरण 0 दिखाता है।
  • जिन types की कोई स्पष्ट sample वैल्यू नहीं, जैसे GEOMETRY, वे null बनते हैं।

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

मैंने underscored: true सेट किया है। फिर created_at की बजाय createdAt क्यों है?

underscored सिर्फ़ database column नामों को snake_case में बदलता है। toJSON() जिन attribute नामों का उपयोग करता है वे createdAt ही रहते हैं, इसलिए आउटपुट मेल खाता है। JSON key भी बदलनी हो तो createdAt: "created_at" से उसे स्पष्ट नाम दें।

क्या यह तब काम करता है जब class User extends Model {} और User.init() अलग-अलग हों?

हां। .init( से ठीक पहले का identifier model नाम के रूप में इस्तेमाल होता है, और पहला argument attribute map के रूप में पढ़ा जाता है।

TypeScript decorator models कहां बदलूं?

@Table और @Column वाले sequelize-typescript models के लिए Sequelize (TS) to JSON पेज इस्तेमाल करें। वह पेज DataType की बजाय property types पढ़ता है।