JSON کو SQLAlchemy منصوبے میں تبدیل کریں!

JSON درج کریں اور اسے SQLAlchemy منصوبے میں تبدیل کریں! SQLAlchemy 2.0 ORM, Mapped, mapped_column, Flask, FastAPI سپورٹ۔
JSON
نتیجہ
 

JSON کو SQLAlchemy منصوبے میں تبدیل کریں!

JSON کو فوراً چلنے کے قابل SQLAlchemy 2.0 declarative ماڈل میں بدلتا ہے: Base(DeclarativeBase) کلاس، mapped_column() کے ساتھ Mapped[...] type hints، nullable flags، __tablename__ اور Integer primary key۔

یہ اچھا نقطۂ آغاز ہے جب FastAPI یا Flask بیک اینڈ کو request JSON، یا کسی دوسرے سسٹم سے ڈاؤن لوڈ کیا گیا ڈیٹا، ایسی table میں محفوظ کرنا ہو جس کا ابھی کوئی ماڈل نہیں۔

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

  1. ایک table row کی نمائندگی کرنے والا JSON آبجیکٹ پیسٹ کریں۔ اگر کچھ rows میں خالی values ہوں تو کئی rows array کی صورت میں پیسٹ کریں تاکہ nullable=True پکڑا جائے۔
  2. ماڈل کا نام میں کلاس کا نام لکھیں (ڈیفالٹ MyModel)؛ __tablename__ وہی نام بڑے حروف والے snake case میں ہوتا ہے۔
  3. آؤٹ پٹ کو models.py کے طور پر محفوظ کریں۔ اگر آپ کے پروجیکٹ میں پہلے سے Base ہے تو بنایا گیا مٹا کر اپنا import کریں، تاکہ تمام ماڈلز ایک ہی metadata شیئر کریں۔

مثال

ان پٹ (JSON)
{
  "isbn": "978-0-13-468599-1",
  "title": "The Pragmatic Programmer",
  "pages": 352,
  "rating": 4.7,
  "available": true,
  "published_at": "2019-09-13"
}
آؤٹ پٹ (SQLAlchemy 2.0)
from datetime import date

from sqlalchemy import Boolean, Date, Float, Integer, String
from sqlalchemy.orm import DeclarativeBase, Mapped, mapped_column


class Base(DeclarativeBase):
    pass


class Book(Base):
    __tablename__ = "BOOK"

    id: Mapped[int] = mapped_column(Integer, primary_key=True)
    isbn: Mapped[str] = mapped_column(String(255), nullable=False)
    title: Mapped[str] = mapped_column(String(255), nullable=False)
    pages: Mapped[int] = mapped_column(Integer, nullable=False)
    rating: Mapped[float] = mapped_column(Float, nullable=False)
    available: Mapped[bool] = mapped_column(Boolean, nullable=False)
    published_at: Mapped[date] = mapped_column(Date, nullable=False)

hyphen والا isbn، String(255) ہی رہتا ہے، pages بنتا ہے Integer، rating بنتا ہے Float، اور بغیر وقت والی تاریخ published_at، date hint کے ساتھ Date بنتی ہے۔ ہر value موجود ہے، اس لیے تمام کالمز nullable=False ہیں۔

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

  • class Base(DeclarativeBase): pass بیان کرتا ہے اور صرف وہی SQLAlchemy types اور datetime نام import کرتا ہے جو واقعی استعمال ہوئے۔
  • type mapping: integers → Integer/int (بڑی values کے لیے BigInteger)، decimals → Float، booleans → Boolean، YYYY-MM-DD → Date/date، date-times → DateTime/datetime، objects اور arrays → dict/list کے ساتھ JSON۔
  • strings String(255) ہوتی ہیں، یا جب کوئی نمونہ value 255 حروف سے لمبی ہو تو Text، تاکہ table MySQL پر بھی بن سکے۔
  • attributes snake_case ہوتے ہیں۔ جب JSON key مختلف ہو (publishedAt، home-url) تو اصل key کالم نام کے طور پر دی جاتی ہے: mapped_column("publishedAt", ...)۔ Python keywords اور metadata کے آخر میں _ لگتا ہے۔
  • nullable کالمز کو nullable=True کے ساتھ ساتھ Mapped[str | None] hint بھی ملتا ہے۔
  • primary key Integer ہے، جو SQLite پر بھی autoincrement ہوتی ہے؛ آپ کے JSON میں string id ہو تو String(255) key بنتی ہے، اور بڑا integer id ہو تو BigInteger().with_variant(Integer, "sqlite") استعمال ہوتا ہے۔

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

FastAPI endpoints کے لیے persistence ماڈلز

اگر آپ کے پاس Pydantic schema کے لیے نمونہ request JSON پہلے سے ہے تو اسی JSON سے SQLAlchemy ماڈل بنائیں اور فوراً session.add(Book(**payload)) والا flow لکھیں۔

خودکار Alembic migrations

جب ماڈل Base.metadata پر رجسٹر ہو جائے تو alembic revision --autogenerate اس کلاس سے create_table migration بنا دیتا ہے۔

نوٹس اور حدود

  • str | None hints کے لیے Python 3.10+ چاہیے۔ پرانے ورژنز پر from typing import Optional کے ساتھ Optional[str] لکھیں۔
  • __tablename__ بڑے حروف میں ہے (BOOK)۔ ایسے میں PostgreSQL پر raw SQL میں اسے quotes میں لکھنا پڑتا ہے، اس لیے بہت سے پروجیکٹس اسے books کر دیتے ہیں۔
  • Flask-SQLAlchemy کے ساتھ بنائے گئے Base کے بجائے db.Model سے inherit کریں۔
  • Float binary floating point ہے؛ قیمتوں کے لیے Decimal کے ساتھ Numeric(10, 2) استعمال کریں۔

عام سوالات

id کے لیے BigInteger کے بجائے Integer کیوں؟

SQLite صرف اسی کالم کو autoincrement کرتا ہے جو بالکل INTEGER PRIMARY KEY ڈکلیئر ہو، اس لیے Integer local ٹیسٹس اور production کا رویہ ایک جیسا رکھتا ہے۔ صرف تب جب آپ کے ڈیٹا میں پہلے سے 32 bits سے بڑی ids ہوں، key، SQLite variant کے ساتھ BigInteger پر چلی جاتی ہے۔

کیا schema (__table_args__) کی کوئی setting ہے؟

نہیں۔ table connection کے ڈیفالٹ schema میں جاتی ہے۔ کسی اور PostgreSQL schema کو نشانہ بنانے کے لیے __table_args__ = {"schema": "billing"} خود شامل کریں۔

کیا مجھے SQLAlchemy 1.4 والا Column() syntax مل سکتا ہے؟

آؤٹ پٹ صرف 2.0 انداز کا ہے (Mapped، mapped_column، DeclarativeBase)۔ 1.4 کے لیے declarative_base() استعمال کریں اور ہر لائن کو title = Column(String(255), nullable=False) کی طرح دوبارہ لکھیں۔