[파이썬] ORM을 사용한 데이터베이스 마이그레이션

01 Sep 2023

python

데이터베이스 마이그레이션은 소프트웨어 업데이트나 변경 시, 기존 데이터베이스 스키마를 새로운 버전에 맞게 변환하는 작업입니다. 이는 데이터의 일관성과 안정성을 유지하기 위해 중요한 작업이며, 많은 개발자들이 이를 보다 효율적이고 쉽게 수행하기 위해 ORM(Object-Relational Mapping)을 사용합니다.

ORM은 객체와 데이터베이스 간의 매핑을 수행해줌으로써 개발자가 SQL 쿼리를 직접 작성하지 않고도 데이터베이스와 상호작용할 수 있도록 도와줍니다. 이를 통해 데이터베이스 마이그레이션 작업을 보다 간편하게 수행할 수 있습니다.

ORM 도구 선택

Python 개발자들은 다양한 ORM 도구를 선택할 수 있습니다. 가장 널리 사용되는 도구로는 Django의 내장 ORM, SQLAlchemy, peewee 등이 있습니다. 이들 도구는 모두 데이터베이스 마이그레이션을 수행할 수 있는 기능을 제공합니다.

여기서는 SQLAlchemy를 사용한 예제를 보여드리겠습니다.

SQLAlchemy를 사용한 데이터베이스 마이그레이션 예제

SQLAlchemy 설치하기

SQLAlchemy를 사용하기 위해서는 먼저 설치해야 합니다. 아래의 명령을 사용하여 SQLAlchemy를 설치합니다.
```
pip install sqlalchemy
```
데이터베이스 연결 설정하기

SQLAlchemy를 사용하여 데이터베이스와 연결하려면, 연결 문자열을 정의해야 합니다. 예를 들어, MySQL 데이터베이스에 연결하기 위해서는 다음과 같이 연결 문자열을 작성합니다.
```
from sqlalchemy import create_engine
engine = create_engine('mysql://username:password@localhost/mydatabase')
```
마이그레이션 스크립트 작성하기

SQLAlchemy는 Alembic이라는 마이그레이션 도구와 함께 사용될 수 있습니다. Alembic을 사용하면 마이그레이션 스크립트를 생성하고 실행하는 작업을 보다 쉽게 수행할 수 있습니다.

Alembic을 설치하려면 다음과 같이 명령을 실행합니다.
```
pip install alembic
```
그리고 아래의 명령을 사용하여 Alembic 초기화를 수행합니다.
```
alembic init myproject/migrations
```
이제 마이그레이션 스크립트를 만들 준비가 되었습니다. 아래의 명령을 사용하여 마이그레이션 스크립트를 생성합니다.
```
alembic revision --autogenerate -m "create users table"
```
위의 명령을 실행하면, 기존 데이터베이스 스키마와 비교하여 새로운 테이블 생성 등의 변경사항을 자동으로 감지하여 마이그레이션 스크립트를 생성합니다.
마이그레이션 스크립트 실행하기

마이그레이션 스크립트를 실행하기 위해서는 아래의 명령을 사용합니다.
```
alembic upgrade head
```
위의 명령은 가장 최근의 마이그레이션 스크립트를 실행하여 데이터베이스를 최신 버전으로 업데이트합니다. 여러 개의 마이그레이션 스크립트를 차례대로 실행하려면 순차적으로 alembic upgrade 명령을 실행하면 됩니다.

결론

ORM을 사용한 데이터베이스 마이그레이션은 개발자들에게 많은 편의성을 제공합니다. SQLAlchemy와 Alembic을 이용하여 간편하고 안정적으로 데이터베이스 마이그레이션을 수행할 수 있습니다. 이를 통해 개발자는 데이터베이스 업데이트에 따른 복잡한 작업을 보다 쉽게 처리할 수 있으며, 데이터의 일관성과 안정성을 유지할 수 있습니다.