SQLAlchemy মডেল কে JSON-এ রূপান্তর করুন!

SQLAlchemy মডেল দিন এবং উদাহরণ JSON তৈরি করুন! SQLAlchemy ORM সমর্থিত। API ডকুমেন্টেশন ও টেস্ট request body (sample JSON)-এর জন্য উপযোগী।
SQLAlchemy
ফলাফল
 

SQLAlchemy মডেল কে JSON-এ রূপান্তর করুন!

SQLAlchemy মডেল ক্লাস পেস্ট করুন এবং কলাম অ্যাট্রিবিউটের নাম অনুযায়ী key করা উদাহরণ JSON পান। এটি mapped_column()-সহ 2.0 স্টাইলের Mapped[...], 1.x স্টাইলের Column(), আর Flask-SQLAlchemy-র db.Column() পড়ে, এবং mixin ও parent ক্লাসের কলামও একত্রিত করে।

SQLAlchemy মডেল সরাসরি json.dumps-এ দেওয়া যায় না, তাই FastAPI আর Flask অ্যাপ Pydantic বা Marshmallow schema যোগ করে। সেই schema লেখার আগে একটি মডেল কোন ফিল্ডগুলো এক্সপোজ করবে তা সাজিয়ে দেখতে, অথবা টেস্টের request body তৈরি করতে এটি ব্যবহার করুন।

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

  1. SQLAlchemy বক্সে মডেল ফাইলটি পেস্ট করুন। Base, mixin আর enum.Enum ক্লাস একই ইনপুটে রাখুন, যাতে উত্তরাধিকার সূত্রে পাওয়া কলাম আর enum ভ্যালু resolve হয়।
  2. শুধু __tablename__ থাকা ক্লাসকেই মডেল ধরা হয়। কয়েকটি মডেল হলে ক্লাসের নাম অনুযায়ী আউটপুট হয়, যেমন { "User": {...}, "Team": {...} }।
  3. ফলাফল কপি করুন।

উদাহরণ

ইনপুট (Python · Flask-SQLAlchemy)
class TimestampMixin:
    created_at = db.Column(db.DateTime, default=datetime.utcnow)


class Plan(enum.Enum):
    FREE = "free"
    PRO = "pro"


class Subscription(TimestampMixin, db.Model):
    __tablename__ = "subscriptions"

    id = db.Column(db.Integer, primary_key=True)
    plan = db.Column(db.Enum(Plan), nullable=False)
    seats = db.Column(db.SmallInteger, default=1)
    trial_ends = db.Column(db.Date)
    user_id = db.Column(db.Integer, db.ForeignKey("users.id"))
    user = db.relationship("User", backref="subscriptions")
আউটপুট (JSON)
{
  "created_at": "1970-01-01T00:00:00",
  "id": 0,
  "plan": "free",
  "seats": 1,
  "trial_ends": "1970-01-01",
  "user_id": 0
}

উত্তরাধিকারের ক্রম মেনে TimestampMixin-এর created_at আগে আসে, আর relationship() কলাম নয় বলে user বাদ পড়ে। db.Enum(Plan) enum-এর প্রথম ভ্যালু "free" নেয়, আর db.Date হয় 1970-01-01। seats default=1 থেকে 1 দেখায়, অন্যদিকে datetime.utcnow একটি ফাংশন বলে created_at placeholder রাখে।

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

  • Mapped[int], Mapped[Optional[str]] আর Mapped[str | None]-এর মতো Python type hint ভ্যালু নির্ধারণ করে।
  • Type hint না থাকলে SQL type আর্গুমেন্ট নির্ধারণ করে, যেমন Column(String(50)) বা db.Column(db.Numeric)।
  • DateTime → 1970-01-01T00:00:00, Date → 1970-01-01, Time → 00:00:00, JSON/JSONB → {}, Uuid → পুরো শূন্যের UUID।
  • ARRAY(String) আর Mapped[list[str]] এক element-এর array হয়।
  • Enum(Plan) বা Mapped[Plan]-এর মাধ্যমে ব্যবহৃত enum.Enum extend করা ক্লাস তার প্রথম member-এর ভ্যালু দেয়।
  • relationship(), column_property(), সাধারণ ক্লাস ভেরিয়েবল আর __table_args__-এর মতো dunder অ্যাট্রিবিউট বাদ যায়।
  • Mixin আর parent মডেলের কলাম child-এর নিজস্ব কলামের আগে বসে।

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

Pydantic response মডেলের খসড়া

FastAPI-এর response_model-এর জন্য Pydantic ক্লাস লেখার আগে মডেলটি JSON হিসেবে কোন ফিল্ড আর type এক্সপোজ করে তা দেখে নিন। সেই JSON JSON থেকে Python পেজে দিলে একটি Pydantic খসড়াও পেয়ে যাবেন।

Flask API-এর টেস্ট payload

মডেলের অ্যাট্রিবিউটের সাথে মেলে এমন key দিয়ে client.post("/subscriptions", json=...)-এর body তৈরি করুন। আগে autoincrement id আর তৈরির সময় সরিয়ে দিন।

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

  • Literal default= ("new", 1, True, None) নমুনা ভ্যালু হিসেবে ব্যবহৃত হয়; datetime.utcnow বা dict-এর মতো callable চালানো হয় না। server_default= আর nullable= পড়া হয় না।
  • Column("user_name", String)-এর মতো কোনো কলামকে আলাদা ডাটাবেস নাম দেওয়া হলেও JSON key Python অ্যাট্রিবিউটের নামই থাকে।
  • relationship-এর মাধ্যমে লোড হওয়া সম্পর্কিত অবজেক্ট অন্তর্ভুক্ত হয় না। আপনার response সেগুলো embed করলে nested অবজেক্ট নিজে যোগ করুন।
  • hybrid_property বা @property-এর মতো computed অ্যাট্রিবিউট আউটপুটের অংশ নয়।

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

Mapped[Optional[str]] কেন null না হয়ে ফাঁকা স্ট্রিং?

Optional মানে None অনুমোদিত; উদাহরণটি ভ্যালু থাকা অবস্থাটি দেখায়, তাই ভেতরের str ব্যবহার করে। সেই অবস্থাটি দরকার হলে আউটপুটে এটি null-এ বদলে নিন।

Datetime-এ কেন Z বা offset নেই?

DateTime কলাম ডিফল্টভাবে naive, আর isoformat() সেগুলো offset ছাড়াই প্রিন্ট করে। DateTime(timezone=True) ব্যবহার করলে +00:00-সহ উদাহরণ আপনি বাস্তবে যা দেখবেন তার কাছাকাছি।

এটি কি Django মডেল কনভার্ট করতে পারে?

না। এই পেজ শুধু SQLAlchemy-র Column, mapped_column আর Mapped syntax বোঝে; models.CharField-এর মতো Django ফিল্ড চেনা হয় না।