如何将枚举与SQLAlChemy和Alembic一起使用？

问题描述

这是我的Post模型：

class Post(Base):
    __tablename__ = 'posts'

    title = db.Column(db.String(120), nullable=False)
    description = db.Column(db.String(2048), nullable=False)

我想将枚举status添加到其中。因此，我已经创建了一个新的枚举：

import enum

class PostStatus(enum.Enum):
    DRAFT='draft'
    APPROVE='approve'
    PUBLISHED='published'

并向模型添加了一个新字段：

class Post(Base):
    ...
    status = db.Column(db.Enum(PostStatus), nullable=False, default=PostStatus.DRAFT.value, server_default=PostStatus.DRAFT.value)

执行FLASK_APP=server.py flask db migrate后，生成了这样的迁移：

def upgrade():
    op.add_column('posts', sa.Column('status', sa.Enum('DRAFT', 'APPROVE', 'PUBLISHED', name='poststatus'), server_default='draft', nullable=False))

尝试升级数据库后，我收到：

sqlalchemy.exc.ProgrammingError: (psycopg2.ProgrammingError) type "poststatus" does not exist
LINE 1: ALTER TABLE posts ADD COLUMN status poststatus DEFAULT 'draf...
                                            ^
 [SQL: "ALTER TABLE posts ADD COLUMN status poststatus DEFAULT 'draft' NOT NULL"]

1. 为什么没有在DB级自动创建类型poststatus？在类似的迁移中也是如此。
2. 如何正确指定server_default选项？我既需要ORM级别的默认值，也需要DB级别的默认值，因为我正在更改现有行，所以不应用ORM默认值。
3. 为什么数据库中的实值是‘草稿’、‘批准’、‘已发布’，而不是draft等？我认为应该有ENUM值，而不是名称。

提前感谢您。

---

解决方案

为什么数据库中的实值是‘草稿’、‘批准’、‘发布’，而不是草稿等？我认为应该有ENUM值，而不是名称。

正如Peter BaSQLAlChemical已经提到的，š在数据库中使用枚举名称(草稿、批准、发布)。我认为这是因为枚举值("Draft"、"Approve"，.)可以是Python中的任意类型，并且不保证它们是唯一的(除非使用@unique)。

但是，由于SQLAlChemy 1.2.3类接受一个参数values_callable，该参数可用于在数据库中存储枚举值：

    status = db.Column(
        db.Enum(PostStatus, values_callable=lambda obj: [e.value for e in obj]),
        nullable=False,
        default=PostStatus.DRAFT.value,
        server_default=PostStatus.DRAFT.value
    )

为什么没有在DB级自动创建类型poststatus？在类似的迁移中也是如此。

我认为基本上您遇到了alembic的限制：在某些情况下，它不能正确处理PostgreSQL上的枚举。我怀疑您的案例中的主要问题是Autogenerate doesn't correctly handle postgresql enums #278。

我注意到如果我使用alembic.op.create_table可以正确创建类型，因此我的解决方法基本上是：

enum_type = SQLEnum(PostStatus, values_callable=lambda enum: [e.value for e in enum])
op.create_table(
    '_dummy',
    sa.Column('id', Integer, primary_key=True),
    sa.Column('status', enum_type)
)
op.drop_table('_dummy')
c_status = Column('status', enum_type, nullable=False)
add_column('posts', c_status)