SQLAlchemy で Enum 型を特殊文字を含む列にマッピングする方法

2024-07-27

方法 1: enum_converter を使用する

enum_converter は、Enum 型を独自のデータベース型に変換するカスタムコンバータを作成するためのクラスです。特殊文字を含む列に Enum 型をマッピングするには、次の手順を実行します。

カスタムコンバータクラスを作成します。このクラスは、enum_converter クラスを継承し、to_native と to_python メソッドを実装する必要があります。
カスタムコンバータクラスを使用して、Enum 型の列を作成します。

from sqlalchemy import Column, Enum, EnumConverter
from sqlalchemy.types import Text

class MyEnumConverter(EnumConverter):
    def to_native(self, value, session):
        if value is None:
            return None
        return value.name.replace(' ', '_')

    def to_python(self, value, session):
        if value is None:
            return None
        return MyEnum(value.replace('_', ' '))

class MyEnum(Enum):
    A = 'A'
    B = 'B'

class MyTable(Base):
    __tablename__ = 'my_table'

    id = Column(Integer, primary_key=True)
    my_enum = Column(Enum(MyEnum, converter=MyEnumConverter()), nullable=False)

方法 2: String 型を使用する

特殊文字を含む列に Enum 型をマッピングするもう 1 つの方法は、String 型を使用することです。この場合、Enum 型の値を文字列に変換して保存する必要があります。

from sqlalchemy import Column, Enum, String

class MyEnum(Enum):
    A = 'A'
    B = 'B'

class MyTable(Base):
    __tablename__ = 'my_table'

    id = Column(Integer, primary_key=True)
    my_enum = Column(String(255), nullable=False)

    def before_insert(self, mapper, session):
        if self.my_enum is not None:
            self.my_enum = self.my_enum.name

    def before_update(self, mapper, session):
        if self.my_enum is not None:
            self.my_enum = self.my_enum.name

方法 3: JSON 型を使用する

from sqlalchemy import Column, Enum, JSON

class MyEnum(Enum):
    A = 'A'
    B = 'B'

class MyTable(Base):
    __tablename__ = 'my_table'

    id = Column(Integer, primary_key=True)
    my_enum = Column(JSON, nullable=False)

    def before_insert(self, mapper, session):
        if self.my_enum is not None:
            self.my_enum = {'value': self.my_enum.name}

    def before_update(self, mapper, session):
        if self.my_enum is not None:
            self.my_enum = {'value': self.my_enum.name}

from sqlalchemy import Column, Enum, EnumConverter
from sqlalchemy.types import Text

class MyEnumConverter(EnumConverter):
    def to_native(self, value, session):
        if value is None:
            return None
        return value.name.replace(' ', '_')

    def to_python(self, value, session):
        if value is None:
            return None
        return MyEnum(value.replace('_', ' '))

class MyEnum(Enum):
    A = 'A'
    B = 'B'

class MyTable(Base):
    __tablename__ = 'my_table'

    id = Column(Integer, primary_key=True)
    my_enum = Column(Enum(MyEnum, converter=MyEnumConverter()), nullable=False)

このコードは、MyEnum という Enum 型と、my_enum という名前の列を持つ MyTable というテーブルを定義します。MyEnumConverter というカスタムコンバータクラスは、Enum 型の値を、データベースに保存する前に特殊文字をアンダースコアに置き換え、データベースから取得する前にアンダースコアをスペースに置き換えます。

from sqlalchemy import Column, Enum, String

class MyEnum(Enum):
    A = 'A'
    B = 'B'

class MyTable(Base):
    __tablename__ = 'my_table'

    id = Column(Integer, primary_key=True)
    my_enum = Column(String(255), nullable=False)

    def before_insert(self, mapper, session):
        if self.my_enum is not None:
            self.my_enum = self.my_enum.name

    def before_update(self, mapper, session):
        if self.my_enum is not None:
            self.my_enum = self.my_enum.name

このコードは、MyEnum という Enum 型と、my_enum という名前の列を持つ MyTable というテーブルを定義します。before_insert と before_update メソッドは、Enum 型の値を、データベースに保存する前に文字列に変換します。

from sqlalchemy import Column, Enum, JSON

class MyEnum(Enum):
    A = 'A'
    B = 'B'

class MyTable(Base):
    __tablename__ = 'my_table'

    id = Column(Integer, primary_key=True)
    my_enum = Column(JSON, nullable=False)

    def before_insert(self, mapper, session):
        if self.my_enum is not None:
            self.my_enum = {'value': self.my_enum.name}

    def before_update(self, mapper, session):
        if self.my_enum is not None:
            self.my_enum = {'value': self.my_enum.name}

UnicodeEnum は、特殊文字を含む Enum 型を定義するための SQLAlchemy の拡張機能です。UnicodeEnum を使用するには、次の手順を実行します。

sqlalchemy_ext パッケージをインストールします。
UnicodeEnum クラスを使用して、Enum 型を定義します。

from sqlalchemy import Column, Enum
from sqlalchemy_ext import UnicodeEnum

class MyEnum(UnicodeEnum):
    A = 'A'
    B = 'B'

class MyTable(Base):
    __tablename__ = 'my_table'

    id = Column(Integer, primary_key=True)
    my_enum = Column(Enum(MyEnum), nullable=False)

from sqlalchemy import Column, Enum, Text

class MyEnum(Enum):
    A = 'A'
    B = 'B'

class MyTable(Base):
    __tablename__ = 'my_table'

    id = Column(Integer, primary_key=True)
    my_enum = Column(Text, nullable=False)

    def before_insert(self, mapper, session):
        if self.my_enum is not None:
            self.my_enum = self.my_enum.name

    def before_update(self, mapper, session):
        if self.my_enum is not None:
            self.my_enum = self.my_enum.name

from sqlalchemy import Column, Enum, JSON

class MyEnum(Enum):
    A = 'A'
    B = 'B'

class MyTable(Base):
    __tablename__ = 'my_table'

    id = Column(Integer, primary_key=True)
    my_enum = Column(JSON, nullable=False)

    def before_insert(self, mapper, session):
        if self.my_enum is not None:
            self.my_enum = {'value': self.my_enum.name}

    def before_update(self, mapper, session):
        if self.my_enum is not None:
            self.my_enum = {'value': self.my_enum.name}

Enum 型の値を、データベースに保存する前に変換する場合は、変換ロジックを慎重に設計する必要があります。変換ロジックが複雑すぎる場合は、パフォーマンスに影響を与える可能性があります。
データベースによっては、特殊文字を含む列をサポートしていない場合があります。そのような場合は、特殊文字をエスケープするか、別の方法でエンコードする必要があります。

sqlalchemy