fastapi 에서 alembic 사용하기

SQLAlchemy + pydamic 보다는 SQLAlchemy+ alembic를 사용하는 것이 추세. 데이터베이스 구조 변경이 더 쉽기 때문입니다.

 

Alembic을 사용하여 데이터베이스 마이그레이션을 수행하는 과정은 기본적으로 몇 단계로 나뉩니다.

여기에는 초기 설정, 마이그레이션 스크립트의 생성, 그리고 마이그레이션의 적용이 포함됩니다.

SQLAlchemy 모델을 기반으로 한 마이그레이션을 만들기 위해, 먼저 Alembic 설정을 완료해야 합니다.

그 후, 모델에 대한 변경 사항을 반영하는 마이그레이션 스크립트를 생성하고 적용해야 합니다.

1. Alembic 설정: 프로젝트 루트에서 $ pip install alembic ;  alembic init alembic 명령어를 실행하여 Alembic을 초기화합니다. 이 명령은 alembic 폴더와 설정 파일인 alembic.ini를 생성합니다. 

-- 각 파일에 대한 간략 설명

• alembic.ini
  • env.py 파일에서 Configuration 파일로 사용되는 alembic 설정 파일
• env.py
  • 마이그레이션 시 실행되는 서버 연결 및 마이그레이션 실행 코드
• script.py.mako
  • 마이그레이션 스크립트 템플릿 파일
• versions
  • 마이그레이션 할 스크립트 코드 저장 

  --  env.py 파일로 한 번 환경을 세팅하고 그 이후로는 versions 를 이용하여 관리

1.  
2.  alembic.ini 파일에서 SQLAlchemy 데이터베이스 URL을 설정합니다. 그리고 alembic/env.py 파일에서 target_metadata 변수를 모델의 메타데이터로 설정합니다.

<alembic/env.py 파일에서 target_metadata 변수를 모델의 메타데이터로 설정>

# 예시: myapp/models.py 파일에 정의된 모델을 사용하는 경우
from myapp.models import Base  # myapp/models.py 파일에서 Base 임포트
target_metadata = Base.metadata

 

<alembic.ini 파일에서 sqlalchemy.url 설정을 데이터베이스 연결 문자열로 수정>

# alembic.ini 파일 내
sqlalchemy.url = driver://user:pass@localhost/dbname

 

2. 마이그레이션 스크립트 생성:

모델에 변경 사항이 있는 경우, alembic revision --autogenerate -m "Add japanese and known tables" 명령어를 실행하여 자동으로 마이그레이션 스크립트를 생성합니다. 이 명령은 변경 사항을 감지하고 설명을 포함한 새로운 마이그레이션 스크립트를 alembic/versions 폴더에 추가합니다.

 

3. 마이그레이션 적용:

마이그레이션 스크립트를 데이터베이스에 적용하려면, alembic upgrade head 명령어를 실행합니다. 이 명령은 최신 마이그레이션까지 데이터베이스 스키마를 업그레이드합니다.

이 과정을 통해, SQLAlchemy 모델의 변경 사항을 기반으로 데이터베이스 스키마 마이그레이션을 수행할 수 있습니다.