آپ SQL ڈیٹا بیس کو FastAPI کے ساتھ کیسے integrate کرتے ہیں؟

Question

Accepted Answer

Django کے برعکس، FastAPI ڈیٹا بیس کے بارے میں **unopinionated** ہے — آپ library کا انتخاب کرتے ہیں۔ عام انتخاب **SQLAlchemy** ہے (اکثر **SQLModel** کے ساتھ، FastAPI کے مصنف کی طرف سے، جو SQLAlchemy + Pydantic کو یکجا کرتا ہے)۔ ڈیٹا بیس sessions dependency injection کے ذریعے فراہم کیے جاتے ہیں۔

## SQLAlchemy setup

```python
from sqlalchemy import create_engine
from sqlalchemy.orm import sessionmaker, declarative_base

engine = create_engine("postgresql://user:pass@localhost/db")
SessionLocal = sessionmaker(bind=engine)
Base = declarative_base()

class User(Base):                        # an ORM model (maps to a table)
    __tablename__ = "users"
    id = Column(Integer, primary_key=True)
    name = Column(String)
    email = Column(String, unique=True)
```

## DB session کو dependency کے ذریعے فراہم کرنا

```python
def get_db():
    db = SessionLocal()
    try:
        yield db                 # provide the session
    finally:
        db.close()               # ALWAYS close after the request (cleanup)

@app.get("/users/{id}")
def get_user(id: int, db: Session = Depends(get_db)):   # inject a session per request
    user = db.query(User).filter(User.id == id).first()
    if not user:
        raise HTTPException(404, "Not found")
    return user
```

`yield` dependency pattern sessions کو منظم کرنے کا معیاری طریقہ ہے: ہر request کے لیے ایک کھولیں، اسے inject کریں، اور پھر خودکار طور پر بند کریں — ہر endpoint کو ایک صاف، صحیح طریقے سے بند شدہ session ملتا ہے۔

## SQLModel — SQLAlchemy + Pydantic ایک میں

```python
from sqlmodel import SQLModel, Field, Session, select

class User(SQLModel, table=True):        # ONE class = ORM model AND Pydantic model
    id: int | None = Field(default=None, primary_key=True)
    name: str
    email: str

@app.get("/users")
def list_users(db: Session = Depends(get_session)):
    return db.exec(select(User)).all()    # query; results are also valid response models
```

SQLModel ORM model اور Pydantic model کو ایک کلاس میں یکجا کرتا ہے — ڈیٹا بیس اور API schemas کے درمیان نقل کو کم کرتا ہے۔

## Migrations اور async اختیارات

```text
✓ Migrations: use Alembic (SQLAlchemy's migration tool) for schema changes
✓ Async: use SQLAlchemy's async engine + async session for async endpoints
  (don't use a SYNC database driver inside async def — it blocks the event loop)
```

## اہمیت

ڈیٹا بیس integration تقریباً کسی بھی حقیقی API کے لیے ضروری ہے، اور چونکہ FastAPI جان بوجھ کر اس کے بارے میں **unopinionated** ہے (Django کے built-in ORM کے برعکس)، عام طریقے کو سمجھنا اہم عملی علم ہے۔

معیاری pattern — **SQLAlchemy** (یا **SQLModel**، جو ORM اور Pydantic models کو خوبصورتی سے یکجا کرتا ہے تاکہ نقل کو کم کیا جا سکے) `yield` pattern کے ذریعے **dependency-injected sessions** کے ساتھ — وہ ہے جو تقریباً ہر FastAPI app استعمال کرتا ہے ڈیٹا برقرار رکھنے کے لیے۔

Session-per-request dependency (پہلے کھولیں، بند کریں، خودکار طور پر) ڈیٹا بیس connections کو منظم کرنے کا idiomatic، صحیح طریقہ ہے، اور SQLModel کا ڈیٹا بیس اور API schemas کی یکتائی FastAPI کے اپنے مصنف کی طرف سے ایک قابل غور productivity feature ہے۔

یہ جاننا کہ ڈیٹا بیس کو کیسے سیٹ اپ کریں، sessions کو DI کے ذریعے فراہم کریں، queries کو execute کریں، اور migrations (Alembic) اور async caveat (async endpoints میں async drivers استعمال کریں، کبھی blocking sync اردگرد نہ جائیں) کو سنبھالیں ڈیٹا-driven FastAPI applications بنانے کے لیے ضروری ہے — چونکہ FastAPI آپ کو انتخاب کرنے کی آزادی دیتا ہے، روایتی، اچھی طریقے سے چلنے والے راستے کو جاننا حقیقی apps کو صحیح طریقے سے بنانے کے لیے قیمتی ہے۔