[파이썬] SQLAlchemy 레거시 데이터베이스와의 통합

06 Sep 2023

SQLAlchemy

SQLAlchemy는 파이썬에서 데이터베이스를 다루는 데 사용되는 강력한 ORM(Object Relational Mapping) 라이브러리입니다. 이를 통해 파이썬 개발자들은 데이터베이스와 상호작용하기 위해 SQL 쿼리를 직접 작성하는 대신, 객체지향적인 방식으로 데이터를 다룰 수 있습니다.

하지만 SQLAlchemy가 처음 도입되었을 때 이미 존재하던 “레거시” 데이터베이스와의 통합은 어려운 문제였습니다. 레거시 데이터베이스는 보통 기본적인 ORM 지원을 제공하지 않으며, 테이블 구조나 데이터 형식 등이 특이한 경우가 많기 때문입니다.

SQLAlchemy의 레거시 데이터베이스 통합 방법

SQLAlchemy는 매우 유연한 구조를 가지고 있기 때문에, 레거시 데이터베이스와의 통합을 위한 다양한 방법을 제공합니다. 이를 통해 기존 데이터베이스와의 연동을 용이하게 할 수 있습니다.

1. 외부 테이블 매핑

SQLAlchemy의 외부 테이블 매핑 기능을 사용하면, 기존 레거시 데이터베이스의 테이블을 SQLAlchemy 모델로 매핑할 수 있습니다. 다음은 Employees 테이블을 매핑하는 예시입니다.

from sqlalchemy import create_engine, Table, Column, String

# 데이터베이스 연결 설정
engine = create_engine('sqlite:///legacy.db')

# 외부 테이블 매핑
employees = Table('Employees', metadata,
    Column('employee_id', String, primary_key=True),
    Column('employee_name', String),
    Column('employee_age', Integer),
)

# 쿼리 실행
result = engine.execute(select([employees]))

2. 커스텀 타입 정의

레거시 데이터베이스에서 사용되는 특정한 데이터 형식을 SQLAlchemy가 인식할 수 있도록, 커스텀 타입을 정의할 수 있습니다. 다음은 EmployeeAge 커스텀 타입을 정의하는 예시입니다.

from sqlalchemy import types, AbstractType

# EmployeeAge 커스텀 타입 정의
class EmployeeAge(types.TypeDecorator):
    impl = types.Integer

    def process_bind_param(self, value, dialect):
        # 데이터 형식 변환 로직
        if value < 0:
            raise ValueError("Invalid age")
        return value

# 테이블 컬럼에 타입 적용
class Employee(Base):
    __tablename__ = 'employees'
    id = Column(Integer, primary_key=True)
    name = Column(String)
    age = Column(EmployeeAge)

# 객체 생성
employee = Employee(name='Alice', age=25)

3. 원시 SQL 쿼리 실행

레거시 데이터베이스와의 통합이 복잡한 경우, SQLAlchemy의 text() 함수를 사용하여 직접 SQL 쿼리를 작성하고 실행할 수 있습니다. 다음은 원시 SQL 쿼리를 실행하는 예시입니다.

from sqlalchemy import text

# 원시 SQL 쿼리 실행
result = session.execute(text('SELECT employee_name FROM Employees WHERE employee_age > :age'), {'age': 30})

# 결과 출력
for row in result:
    print(row.employee_name)

결론

SQLAlchemy는 레거시 데이터베이스와의 통합을 위한 다양한 기능을 제공하여 개발자들이 쉽고 효율적으로 기존 데이터베이스와 상호작용할 수 있도록 도와줍니다. 외부 테이블 매핑, 커스텀 타입 정의 및 원시 SQL 쿼리 실행 등의 방법을 활용하여 레거시 데이터베이스와의 통합을 성공적으로 수행할 수 있습니다.