[python] SQLAlchemy의 자동 생성 기능

04 Dec 2023

python

SQLAlchemy는 Python 언어로 작성된 강력한 ORM(Object-Relational Mapping) 라이브러리입니다. ORM은 관계형 데이터베이스와의 상호작용을 추상화하여 개발자가 SQL 쿼리를 직접 작성하지 않고도 데이터베이스에 접근할 수 있도록 도와줍니다.

SQLAlchemy에는 자동 생성 기능이 내장되어 있어, 개발자가 매우 적은 코드로 데이터베이스 테이블을 생성하고 관리할 수 있습니다. 이번 포스트에서는 SQLAlchemy의 자동 생성 기능에 대해 알아보겠습니다.

1. 테이블 자동 생성하기

SQLAlchemy를 사용하여 데이터베이스 테이블을 자동으로 생성하려면 아래와 같은 단계를 따르면 됩니다.

SQLAlchemy에서 사용할 데이터베이스 연결 설정을 정의합니다.
데이터베이스의 엔진을 생성하고 연결 설정을 전달합니다.
모델 클래스를 정의하고 테이블 정보를 설정합니다.
엔진 객체의 create_all() 메서드를 호출하여 테이블을 생성합니다.

아래는 이러한 단계를 거쳐 User 테이블을 자동으로 생성하는 예제 코드입니다.

from sqlalchemy import create_engine, Column, Integer, String
from sqlalchemy.ext.declarative import declarative_base

Base = declarative_base()

class User(Base):
    __tablename__ = 'users'

    id = Column(Integer, primary_key=True)
    username = Column(String)
    email = Column(String)

engine = create_engine('sqlite:///database.db')  # 데이터베이스 연결 설정
Base.metadata.create_all(engine)  # 테이블 자동 생성

위 예제 코드에서는 SQLite 데이터베이스를 사용하고 있으며, User 클래스는 users 테이블과 매핑됩니다. Base.metadata.create_all(engine) 코드를 실행하면 SQLAlchemy가 자동으로 users 테이블을 생성합니다.

2. 테이블 수정 및 삭제

자동 생성된 테이블을 수정하거나 삭제하려면 아래의 단계를 따릅니다.

테이블 수정의 경우:
1. 모델 클래스를 수정하고 새로운 필드 또는 관계를 추가합니다.
2. 데이터베이스의 엔진 객체에서 alter() 메서드를 호출합니다.
테이블 삭제의 경우:
1. 데이터베이스의 엔진 객체에서 drop_all() 메서드를 호출합니다.

아래는 User 테이블을 수정하고 삭제하는 예제 코드입니다.

from sqlalchemy import create_engine, Column, Integer, String
from sqlalchemy.ext.declarative import declarative_base

Base = declarative_base()

class User(Base):
    __tablename__ = 'users'

    id = Column(Integer, primary_key=True)
    username = Column(String)
    email = Column(String)
    age = Column(Integer)  # 새로운 필드 추가

engine = create_engine('sqlite:///database.db')
Base.metadata.tables['users'].create(bind=engine, checkfirst=True)  # 테이블 수정

# Base.metadata.drop_all(engine)  # 테이블 삭제

User 테이블을 수정하는 예제에서는 age 필드를 새로 추가하였습니다. Base.metadata.tables['users'].create(bind=engine, checkfirst=True) 코드를 실행하면 SQLAlchemy가 자동으로 테이블을 수정합니다.

3. 정리

SQLAlchemy의 자동 생성 기능을 사용하면 개발자는 간단한 코드로 데이터베이스 테이블을 생성, 수정 및 삭제할 수 있습니다. 이를 통해 개발자는 SQL 쿼리 작성에 대한 부담을 덜 수 있고, 더욱 효율적인 개발을 할 수 있습니다.

더 많은 정보를 얻으려면 SQLAlchemy 공식 문서를 참조해보세요.