データの整合性を保ちたいなら、PostgreSQLのENUM型とSQLAlchemyを組み合わせよう

2024-04-02

SQLAlchemy で PostgreSQL の ENUM 型を使う

SQLAlchemy は、Python でデータベースとのやり取りを抽象化する ORM (Object-Relational Mapping) フレームワークです。PostgreSQL は、ENUM 型を含む様々なデータ型をサポートするオープンソースのオブジェクトリレーショナルデータベースです。

この解説では、SQLAlchemy で PostgreSQL の ENUM 型を使用する方法について説明します。

手順

PostgreSQL で ENUM 型を作成

CREATE TYPE my_enum AS ENUM ('value1', 'value2', 'value3');

Python で ENUM 型を定義

from sqlalchemy import Enum, String

class MyModel(Base):
    __tablename__ = 'my_table'

    id = Column(Integer, primary_key=True)
    status = Column(Enum('value1', 'value2', 'value3'), nullable=False)
    name = Column(String(255))

モデルの操作

model = MyModel(status='value2', name='My Name')
db.session.add(model)
db.session.commit()

# データの取得
model = MyModel.query.filter_by(status='value2').first()

# データの更新
model.status = 'value3'
db.session.commit()

ポイント

Enum 型は、sqlalchemy.Enum を使用して定義します。
ENUM 型の値は、文字列のリストとして渡します。
nullable パラメータは、NULL 値を許可するかどうかを指定します。
モデルの操作は、通常の SQLAlchemy モデルと同じように行えます。

補足

ENUM 型は、ドロップダウンリストなどの選択リストを表現するのに役立ちます。
ENUM 型は、データの整合性を保つのに役立ちます。

from sqlalchemy import create_engine, Enum, String

# PostgreSQL への接続
engine = create_engine('postgresql://postgres:password@localhost:5432/mydb')

# テーブルの作成
Base.metadata.create_all(engine)

# モデルの定義
class MyModel(Base):
    __tablename__ = 'my_table'

    id = Column(Integer, primary_key=True)
    status = Column(Enum('value1', 'value2', 'value3'), nullable=False)
    name = Column(String(255))

# データの追加
model = MyModel(status='value2', name='My Name')
db.session.add(model)
db.session.commit()

# データの取得
model = MyModel.query.filter_by(status='value2').first()

# データの更新
model.status = 'value3'
db.session.commit()