FastAPI | SQL (Relational) Databases

 

https://fastapi.tiangolo.com/ko/tutorial/sql-databases/

SQL (Relational) Databases - FastAPI

https://ulfrid.github.io/python/python-sqlalchemy/

SQLAlchemy 그것이 알고싶다

1. 파일 구조

2. sql_app/database.py (디비정의)

from sqlalchemy import create_engine
from sqlalchemy.ext.declarative import declarative_base
from sqlalchemy.orm import sessionmaker
# SQLALCHEMY_DATABASE_URL = "sqlite:///./폴더이름/디비이름.db"
SQLALCHEMY_DATABASE_URL = "sqlite:///./sql_app/sql_app.db"
# SQLALCHEMY_DATABASE_URL = "postgresql://user:password@postgresserver/db"

# 외부 DB와 연동하기 위한 SQLAlchemy 엔진 생성, 이 엔진은 다른곳에서 사용 될 것이다.
engine = create_engine(
    SQLALCHEMY_DATABASE_URL, 
    connect_args={"check_same_thread": False},
    echo = True, # 쿼리 로그 확인 
)
# 세션로컬 클래스 생성
SessionLocal = sessionmaker(autocommit=False, autoflush=False, bind=engine)

# 베이스 클래스 생성
Base = declarative_base()

 

# 세션로컬 클래스 생성

세션로컬 클래스의 각 인스턴스는 데이터베이스의 세션이 된다.

클래스 자체는 아직 데이터베이스 세션이 아니지만 인스턴스를 생성하면 이 인스턴스가 세션이 된다.

 

# 베이스 클래스 생성

클래스를 반환 하는 함수

나중에 이 클래스를 상속받아서 모델 또는 클래스를 생성할것이다.

3. sql_app/models.py (SQLAlchemy모델 생성)

from sqlalchemy import Boolean, Column, ForeignKey, Integer, String
from sqlalchemy.orm import relationship
from .database import Base

# 베이스클래스 상속
class User(Base):
    __tablename__ = "users"

    id = Column(Integer, primary_key=True, index=True)
    email = Column(String, unique=True, index=True)
    hashed_password = Column(String)
    is_active = Column(Boolean, default=True)

    items = relationship("Item", back_populates="owner")


# 베이스클래스 상속
class Item(Base):
    __tablename__ = "items"

    id = Column(Integer, primary_key=True, index=True)
    title = Column(String, index=True)
    description = Column(String, index=True)
    owner_id = Column(Integer, ForeignKey("users.id"))

    owner = relationship("User", back_populates="items")

relationship 속성을 이용하여 다른 테이블의 값에 포함시켜 준다.

4. sql_app/schmes.py (유효성 검사)

SQLAlchemy 모델과 Pydantic 모델간의 혼동을 피하기 위해 

SQLAlchemy 모델이 있는 파일 models.py과 schemas.py Pydantic 모델이 있는 파일이 있습니다.
이 Pydantic 모델은 "스키마"(유효한 데이터 모양)를 어느 정도 정의합니다.
따라서 둘 다 사용하는 동안 혼동을 피하는 데 도움이 됩니다.

from pydantic import BaseModel


class ItemBase(BaseModel):
    title: str
    description: str | None = None


class ItemCreate(ItemBase):
    pass


class Item(ItemBase):
    id: int
    owner_id: int

    class Config:
        orm_mode = True


class UserBase(BaseModel):
    email: str


class UserCreate(UserBase):
    password: str


class User(UserBase):
    id: int
    is_active: bool
    items: list[Item] = []

    class Config:
        orm_mode = True

orm_mode = True 로 인해서  Pydantic 모델이 데이터를 다양하게 읽도록 한다.

id=data['id'] , id=data.id 둘다 읽을 수 있도록 한다고 한다.

5. sql_app/crud.py (CRUD 함수 생성)

from sqlalchemy.orm import Session
from . import models, schemas


def get_user(db: Session, user_id: int):
    return db.query(models.User).filter(models.User.id == user_id).first()


def get_user_by_email(db: Session, email: str):
    return db.query(models.User).filter(models.User.email == email).first()


def get_users(db: Session, skip: int = 0, limit: int = 100):
    return db.query(models.User).offset(skip).limit(limit).all()


def create_user(db: Session, user: schemas.UserCreate):
    fake_hashed_password = user.password + "notreallyhashed"
    db_user = models.User(email=user.email, hashed_password=fake_hashed_password)
    db.add(db_user)
    db.commit()
    db.refresh(db_user)
    return db_user


def get_items(db: Session, skip: int = 0, limit: int = 100):
    return db.query(models.Item).offset(skip).limit(limit).all()


def create_user_item(db: Session, item: schemas.ItemCreate, user_id: int):
    db_item = models.Item(**item.dict(), owner_id=user_id)
    db.add(db_item)
    db.commit()
    db.refresh(db_item)
    return db_item

6. sql_app/main.py (API 작성)

from fastapi import Depends, FastAPI, HTTPException
from sqlalchemy.orm import Session

from . import models, crud, schemas
from .database import SessionLocal, engine

# 디비 테이블 생성
models.Base.metadata.create_all(bind=engine)

app = FastAPI()


# 종속성 생성 단일 요청에 사용될 SQLAchemy 세션 생성하고, 요청완료시 세션 종료
def get_db():
    db = SessionLocal()
    try:
        yield db
    finally:
        db.close()

# 요청받을 모델을 schemas.User로하여 유효성 검사를 진행
@app.post("/users/", response_model=schemas.User)
def create_user(user: schemas.UserCreate, db: Session = Depends(get_db)):
    db_user = crud.get_user_by_email(db, email=user.email)
    if db_user:
        raise HTTPException(status_code=400, detail="Email already registered")
    return crud.create_user(db=db, user=user)

# objects.get.all()인 경우 리스트
@app.get("/users/", response_model=list[schemas.User])
def read_users(skip: int = 0, limit: int = 100, db: Session = Depends(get_db)):
    users = crud.get_users(db, skip=skip, limit=limit)
    return users


@app.get("/users/{user_id}", response_model=schemas.User)
def read_user(user_id: int, db: Session = Depends(get_db)):
    db_user = crud.get_user(db, user_id=user_id)
    if db_user is None:
        raise HTTPException(status_code=404, detail="User not found")
    return db_user


@app.post("/users/{user_id}/items/", response_model=schemas.Item)
def create_item_for_user(
    user_id: int, item: schemas.ItemCreate, db: Session = Depends(get_db)
):
    return crud.create_user_item(db=db, item=item, user_id=user_id)

# objects.get.all()인 경우 리스트
@app.get("/items/", response_model=list[schemas.Item])
def read_items(skip: int = 0, limit: int = 100, db: Session = Depends(get_db)):
    items = crud.get_items(db, skip=skip, limit=limit)
    return items