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 তৈরি করে। ক্লাসে ডিক্লেয়ার না থাকলেও Sequelize যে id, createdAt, updatedAt আর deletedAt অ্যাট্রিবিউট যোগ করে, সেগুলোও এতে থাকে।

JS পেজের মতো নয়, এখানে ভ্যালু আসে DataType আর্গুমেন্ট থেকে নয়, প্রতিটি প্রপার্টির TypeScript type থেকে। amount: string হিসেবে ডিক্লেয়ার করা @Column(DataType.DECIMAL) একটি স্ট্রিং তৈরি করে।

কীভাবে ব্যবহার করবেন

  1. Sequelize (TS) বক্সে @Table ক্লাস থাকা একটি ফাইল পেস্ট করুন। Nested ভ্যালু পেতে associated মডেলও (@HasMany ইত্যাদির মাধ্যমে) দিন।
  2. স্বয়ংক্রিয়ভাবে যোগ হওয়া অ্যাট্রিবিউটসহ JSON দেখতে ফলাফল বক্স চেক করুন।
  3. তারিখের ফিল্ড কীভাবে বদলায় তা সাথে সাথে দেখতে timestamps বা paranoid-এর মতো @Table অপশন চালু-বন্ধ করুন।

উদাহরণ

ইনপুট (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 হিসেবে ডিক্লেয়ার করা।

সমর্থিত বৈশিষ্ট্য

  • @PrimaryKey, @Column({ primaryKey: true }) বা id প্রপার্টি না থাকলে শুরুতে id: 0 বসানো হয়, রুট আর associated মডেল দুটোর জন্যই।
  • @Table timestamps: false সেট না করলে createdAt আর updatedAt যোগ হয়; createdAt: "created_on", updatedAt: false আর paranoid: true (deletedAt: null)-এর মতো নাম বদল প্রতিটি মডেলে আলাদাভাবে মানা হয়।
  • @HasMany-এর Post[] array হয়; @BelongsTo আর @HasOne nested অবজেক্ট হয়।
  • "draft" | "sent"-এর মতো literal union প্রথম ভ্যালু ব্যবহার করে, আর extends Model-এর মাধ্যমে উত্তরাধিকার সূত্রে পাওয়া সবকিছু উপেক্ষিত হয়।
  • অবজেক্ট হিসেবে type দেওয়া DataType.JSON কলাম, যেমন { theme: string }, সেই আকৃতিতেই পূরণ হয়।

ব্যবহারের ক্ষেত্র

Express handler ডকুমেন্ট করা

res.json(await Invoice.findByPk(id)) করা endpoint-এর জন্য আউটপুট এমন একটি response উদাহরণ দেয় যার key-গুলো বাস্তবের সাথে মেলে, স্বয়ংক্রিয়ভাবে যোগ হওয়া অ্যাট্রিবিউটসহ।

Soft delete চালু করার আগে ও পরে

paranoid চালু করলে প্রতিটি response-এ deletedAt যোগ হয়। অপশন চালু আর বন্ধ রেখে আউটপুট তুলনা করে API ব্যবহারকারীদের ঠিক কী বদলাবে তা জানিয়ে দিন।

নোট ও সীমাবদ্ধতা

  • রুটের ভেতরে nested associated মডেলগুলো নিজেদের @Table অপশন থেকে নিজস্ব id আর timestamp পায়, কিন্তু Sequelize যে foreign key অন্তর্নিহিতভাবে যোগ করে (যেমন @ForeignKey কলাম ছাড়া @HasMany target-এর invoiceId) সেগুলো বানিয়ে নেওয়া হয় না।
  • JSON key প্রপার্টির নাম হওয়ায় allowNull আর @Column({ field: ... }) দিয়ে কলামের নাম বদল উপেক্ষিত হয়। @Default("x") আর @Column({...})-এর literal defaultValue নমুনা ভ্যালু হিসেবে ব্যবহৃত হয়।
  • underscored: true শুধু ডাটাবেসের কলামের নাম বদলায়; toJSON() তবুও অ্যাট্রিবিউটের নাম ব্যবহার করে, তাই আউটপুটের createdAt সঠিক।
  • ভ্যালু আসে TypeScript type থেকে, তাই শুধু decorator দিয়ে type দেওয়া প্রপার্টি (annotation ছাড়া @Column(DataType.INTEGER) count;) null হয়।

সাধারণ প্রশ্ন

DECIMAL কলামের type কি number হবে নাকি string?

MySQL আর PostgreSQL-এ Sequelize ডিফল্টভাবে DECIMAL ভ্যালু স্ট্রিং হিসেবে ফেরত দেয়। amount: string type দিলে type সঠিক থাকে, আর এখানকার উদাহরণও স্ট্রিং দেখাবে।

declare ফিল্ড বা CreationOptional কি ব্যবহার করা যায়?

হ্যাঁ। declare id: CreationOptional<number> number হিসেবে পড়া হয়, আর NonAttribute<...> ও ForeignKey<...>-এও একইভাবে খোলা হয়। InferAttributes-এর মতো এর বাইরের helper type প্রসারিত হয় না।

এই পেজ কি JavaScript-এ লেখা sequelize.define মডেল হ্যান্ডেল করে?

না। এই পেজ ক্লাস আর TypeScript type পড়ে। define আর Model.init মডেলের জন্য Sequelize (JS) থেকে JSON পেজ ব্যবহার করুন, যা এর বদলে DataTypes পড়ে।