Connecting Database in FastAPI using SQLAlchemy

FastAPI는 Python의 고성능 웹 프레임워크로서, 데이터베이스와의 연결을 쉽게 구현할 수 있습니다. SQLAlchemy는 Python의 ORM(Object Relational Mapping) 라이브러리로, 데이터베이스와의 상호작용을 추상화하여 개발자가 더 쉽게 데이터베이스를 다룰 수 있도록 도와줍니다. 이 튜토리얼에서는 FastAPI에서 SQLAlchemy를 사용하여 데이터베이스와의 연결을 설정하는 방법에 대해 알아보겠습니다.

먼저, FastAPI 및 SQLAlchemy를 설치해야 합니다. 다음과 같이 pip를 사용하여 필요한 패키지를 설치할 수 있습니다.

pip install fastapi
pip install uvicorn
pip install sqlalchemy
pip install databases

이제 FastAPI 애플리케이션을 생성하고 데이터베이스 연결을 설정할 차례입니다. 다음과 같이 main.py 파일을 생성하고 코드를 작성합니다.

from fastapi import FastAPI
from sqlalchemy import create_engine
from sqlalchemy.ext.declarative import declarative_base
from sqlalchemy.orm import sessionmaker

# FastAPI 애플리케이션 생성
app = FastAPI()

# SQLAlchemy 설정
SQLALCHEMY_DATABASE_URL = "sqlite:///./test.db"
engine = create_engine(SQLALCHEMY_DATABASE_URL, connect_args={"check_same_thread": False})
SessionLocal = sessionmaker(autocommit=False, autoflush=False, bind=engine)

Base = declarative_base()

위 코드에서는 FastAPI 애플리케이션을 생성하고, SQLAlchemy를 사용하여 데이터베이스와의 연결을 설정했습니다. sqlite:///./test.db은 SQLite 데이터베이스 파일의 경로를 나타내며, 실제 프로젝트에서는 원하는 데이터베이스를 사용할 수 있습니다.

다음으로, SQLAlchemy 모델을 정의합니다. 이 모델은 데이터베이스의 테이블을 나타내며, ORM을 통해 해당 테이블과 상호작용할 수 있습니다.

from sqlalchemy import Column, Integer, String

class User(Base):
    __tablename__ = "users"

    id = Column(Integer, primary_key=True, index=True)
    name = Column(String)
    email = Column(String, unique=True)

이제 FastAPI의 각 엔드포인트에서 데이터베이스를 사용할 수 있도록 응용프로그램과 모델을 연결해야 합니다. 이를 위해 각 요청에서 데이터베이스 세션을 만들고, 요청 처리 후에 세션을 종료해야 합니다. 아래와 같이 SQLAlchemy 세션을 FastAPI 디펜던시로 만들어 이를 해결할 수 있습니다.

from fastapi import Depends
from sqlalchemy.orm import Session

def get_db():
    db = SessionLocal()
    try:
        yield db
    finally:
        db.close()

사용자를 생성하거나 조회하는 엔드포인트를 작성할 때는 get_db 함수를 FastAPI 디펜던시로 사용하여 데이터베이스 세션을 가져오고, 해당 세션을 닫습니다.

이제 FastAPI와 SQLAlchemy를 사용하여 데이터베이스와의 연결을 설정하는 방법을 알아보았습니다. 이를 바탕으로 본격적인 데이터베이스와의 상호작용을 구현할 수 있으며, 프로젝트의 요구에 맞게 데이터베이스 스키마 및 모델을 확장할 수 있습니다. 데이터베이스와의 연결 설정은 FastAPI 및 SQLAlchemy의 강력한 기능을 활용하여 프로젝트의 확장성을 향상시킬 수 있습니다.