SQLAlchemy 与 PostgreSQL 中的 ENUM 类型

Question

我正在将 SQLAlchemy core 与 postgresql 数据库一起使用，我想将 ENUM 类型添加到我的表定义中。根据 postgresql 文档，必须在创建表之前定义 ENUM 类型：

CREATE TYPE gender_enum AS ENUM ('female', 'male');

CREATE TABLE person (
  name VARCHAR(20),
  gender gender_enum
);

问题是当我创建表定义时。阅读了SQLAlchemy文档后，我找不到任何实现示例。我尝试过类似的方法，但没有成功：

from sqlalchemy.dialects.postgresql import ENUM

person = Table('user_profile', metadata,
    Column('name', String(20)),
    Column('gender', ENUM('female', 'male'))
);

必须如何完成？

Answer 1

您需要从 sqlalchemy 导入 Enum 并为其添加名称。它应该像这样工作：

from sqlalchemy import Enum

person = Table("user_profile", metadata,
    Column("name", String(20)),
    Column("gender", Enum("female", "male", name="gender_enum", create_type=False))
);

Answer 2

@Tim 的答案绝对是正确的，但我想提供我设置 ENUM 的方式。

在我的 models.py 中，我将创建值作为元组

skill_levels = ('Zero', 'A little', 'Some', 'A lot')

然后我将创建一个 Skill_level_enum 变量，并为其分配一个 ENUM 类，其中技能级别值作为参数。

skill_level_enum = ENUM(*skill_levels, name="skill_level")

在我的表模型中，我传入 Skill_level_enum

class User(db.Model):
    id = db.Column(db.Integer(), primary_key=True)
    skill_level = db.Column(skill_level_enum)

我发现这使我的代码更加简洁，并且我能够更新文件顶部的技能级别，而不是扫描我的模型以查找要更新的正确内容。

Answer 3

您可以使用 Python 的本机枚举 作为列类型的输入：

from flask_sqlalchemy import SQLAlchemy
from sqlalchemy.dialects.postgresql import ENUM as pgEnum
from enum import Enum, unique

@unique
class errorTypeEnum(Enum):
    videoValidation = 'videoValidation'
    audioValidation = 'audioValidation'
    subtitleValidation = 'subtitleValidation'

db = SQLAlchemy()

class Error(db.Model):
    serviceID = db.Column(db.String(20), primary_key=True)
    timestamp = db.Column(db.DateTime, unique=False, nullable=False)
    category = db.Column(pgEnum(errorTypeEnum), unique=False, nullable=False)

Answer 4

下面的代码适用于我的 SQLAlchemy 1.3.11 和 Postgres 12.0。

在创建用户表之前，必须先在 postgres 中创建 Enum 类型。这可以直接通过sql语句完成。

CREATE TYPE permission AS ENUM ('READ_ONLY', 'READ_WRITE', 'ADMIN', 'OWNER');

然后设置项目模型

from flask_sqlalchemy import SQLAlchemy    

db = SQLAlchemy()

class User(db.Model): 
    __tablename__ = 'user'

    user_id = db.Column(db.Integer, primary_key=True)   
    username = db.Column(db.String(120), unique=True, nullable=False)
    password = db.Column(db.String(200), nullable=False)
    access = db.Column(db.Enum('READ_ONLY', 'READ_WRITE', 'ADMIN', 'OWNER', name="permission"))