SQLAlchemy에서 Enum을 사용하는 최고의 방법

2024-07-27

SQLAlchemy는 Python에서 데이터베이스와 상호 작용하는 데 사용되는 인기 있는 오픈 소스 ORM(Object-Relational Mapper) 라이브러리입니다. Enum은 데이터베이스 테이블에서 유효한 값 집합을 정의하는 데 사용되는 유용한 기능입니다. SQLAlchemy에는 다음과 같은 몇 가지 방법으로 Enum을 구현할 수 있습니다.

SQLAlchemy 내장 Enum 유형 사용:

SQLAlchemy 1.4 버전부터 내장 Enum 유형을 지원합니다. 이를 사용하려면 다음과 같이 해야 합니다.

from sqlalchemy import Enum, Column

class Color(Enum):
    RED = 1
    GREEN = 2
    BLUE = 3

class User(Base):
    color = Column(Enum(Color))

이 코드는 Color라는 Enum 유형을 정의하고 User 테이블에 color라는 Enum 열을 추가합니다.

사용자 정의 Enum 유형 사용:

SQLAlchemy 내장 Enum 유형을 사용하지 않으려면 다음과 같이 사용자 정의 Enum 유형을 만들 수 있습니다.

from sqlalchemy import Column, Integer

class Color(object):
    RED = 1
    GREEN = 2
    BLUE = 3

class User(Base):
    color = Column(Integer)

    @property
    def color_label(self):
        if self.color == Color.RED:
            return "빨간색"
        elif self.color == Color.GREEN:
            return "초록색"
        else:
            return "파란색"

이 코드는 Color라는 사용자 정의 Enum 유형을 정의하고 User 테이블에 color라는 정수 열을 추가합니다. color_label 속성은 color 값에 따라 문자열 레이블을 반환합니다.

pgEnum 사용:

PostgreSQL 데이터베이스를 사용하는 경우 pgEnum 라이브러리를 사용하여 Enum을 구현할 수 있습니다.

from sqlalchemy import Enum, Column
from sqlalchemy.ext.declarative import declarative_base
from pgEnum import PgEnum

Base = declarative_base()

class Color(PgEnum):
    RED = 1
    GREEN = 2
    BLUE = 3

class User(Base):
    color = Column(Enum(Color))

어떤 방법을 사용해야 할까요?

사용해야 할 방법은 특정 상황에 따라 다릅니다.

SQLAlchemy 내장 Enum 유형은 간단하고 사용하기 쉽습니다.
사용자 정의 Enum 유형은 더 많은 제어 기능을 제공하지만 더 복잡합니다.
pgEnum은 PostgreSQL 데이터베이스에서만 사용할 수 있습니다.

SQLAlchemy에서 Enum을 사용하는 예제 코드

다음은 SQLAlchemy에서 Enum을 사용하는 세 가지 방법에 대한 예제 코드입니다.

from sqlalchemy import Enum, Column, create_engine
from sqlalchemy.ext.declarative import declarative_base

Base = declarative_base()

engine = create_engine("sqlite:///database.db")

class Color(Enum):
    RED = 1
    GREEN = 2
    BLUE = 3

class User(Base):
    __tablename__ = "users"

    id = Column(Integer, primary_key=True)
    name = Column(String(255))
    color = Column(Enum(Color))

Base.metadata.create_all(engine)

이 코드는 다음을 수행합니다.

Color라는 Enum 유형을 정의합니다.
User라는 테이블을 정의합니다.
id, name 및 color라는 세 개의 열을 가진 User 테이블을 만듭니다.
color 열은 Color Enum 유형으로 정의됩니다.

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

Base = declarative_base()

engine = create_engine("sqlite:///database.db")

class Color(object):
    RED = 1
    GREEN = 2
    BLUE = 3

class User(Base):
    __tablename__ = "users"

    id = Column(Integer, primary_key=True)
    name = Column(String(255))
    color = Column(Integer)

    @property
    def color_label(self):
        if self.color == Color.RED:
            return "빨간색"
        elif self.color == Color.GREEN:
            return "초록색"
        else:
            return "파란색"

Base.metadata.create_all(engine)

color 열은 정수 유형으로 정의됩니다.
color_label 속성은 color 값에 따라 문자열 레이블을 반환합니다.

from sqlalchemy import Enum, Column, create_engine
from sqlalchemy.ext.declarative import declarative_base
from pgEnum import PgEnum

Base = declarative_base()

engine = create_engine("postgresql://user:password@host:port/database")

class Color(PgEnum):
    RED = 1
    GREEN = 2
    BLUE = 3

class User(Base):
    __tablename__ = "users"

    id = Column(Integer, primary_key=True)
    name = Column(String(255))
    color = Column(Enum(Color))

Base.metadata.create_all(engine)

SQLAlchemy에서 Enum을 구현하는 대체 방법

SQLAlchemy에서 Enum을 구현하는 기본적인 방법 외에도 몇 가지 대체 방법을 사용할 수 있습니다.

다이얼렉트 기반 Enum:

이 방법은 데이터베이스 다이얼렉트에 따라 서로 다른 Enum 구현을 사용하는 것입니다. 예를 들어, PostgreSQL 데이터베이스에서는 pgEnum 라이브러리를 사용하고, MySQL 데이터베이스에서는 ENUM 데이터 유형을 사용할 수 있습니다.

from sqlalchemy import Enum, Column, create_engine
from sqlalchemy.ext.declarative import declarative_base
from pgEnum import PgEnum

if engine.dialect.name == "postgresql":
    Color = PgEnum
else:
    from sqlalchemy.types import Enum
    Color = Enum("RED", "GREEN", "BLUE")

Base = declarative_base()

class User(Base):
    __tablename__ = "users"

    id = Column(Integer, primary_key=True)
    name = Column(String(255))
    color = Column(Color)

Base.metadata.create_all(engine)

외부 매핑 테이블 사용:

이 방법은 Enum 값을 별도의 테이블에 저장하고, User 테이블에서 해당 테이블의 외래 키를 사용하는 것입니다.

from sqlalchemy import Column, Integer, ForeignKey, create_engine
from sqlalchemy.ext.declarative import declarative_base
from sqlalchemy.orm import relationship

Base = declarative_base()

engine = create_engine("sqlite:///database.db")

class Color(Base):
    __tablename__ = "colors"

    id = Column(Integer, primary_key=True)
    name = Column(String(255))

class User(Base):
    __tablename__ = "users"

    id = Column(Integer, primary_key=True)
    name = Column(String(255))
    color_id = Column(Integer, ForeignKey("colors.id"))
    color = relationship("Color")

Base.metadata.create_all(engine)

JSON 데이터 사용:

이 방법은 Enum 값을 JSON 문자열로 저장하는 것입니다.

import json
from sqlalchemy import Column, Integer, Text, create_engine
from sqlalchemy.ext.declarative import declarative_base

Base = declarative_base()

engine = create_engine("sqlite:///database.db")

class User(Base):
    __tablename__ = "users"

    id = Column(Integer, primary_key=True)
    name = Column(String(255))
    color_data = Column(Text)

    @property
    def color(self):
        if self.color_data:
            return json.loads(self.color_data)
        else:
            return None

    @color.setter
    def color(self, value):
        if value:
            self.color_data = json.dumps(value)
        else:
            self.color_data = None

Base.metadata.create_all(engine)