在 Django model 中指定 mySQL ENUM

Question

我如何 go 关于在 Django model 中指定和使用 ENUM？

Answer 1

从Django文档 ：

MAYBECHOICE = (
    ('y', 'Yes'),
    ('n', 'No'),
    ('u', 'Unknown'),
)

然后在模型中定义一个charfield：

married = models.CharField(max_length=1, choices=MAYBECHOICE)

如果您不希望在数据库中包含字母，则可以对整数字段执行相同操作。

在这种情况下，重写您的选择：

MAYBECHOICE = (
    (0, 'Yes'),
    (1, 'No'),
    (2, 'Unknown'),
)

Answer 2

from django.db import models

class EnumField(models.Field):
    """
    A field class that maps to MySQL's ENUM type.

    Usage:

    class Card(models.Model):
        suit = EnumField(values=('Clubs', 'Diamonds', 'Spades', 'Hearts'))

    c = Card()
    c.suit = 'Clubs'
    c.save()
    """
    def __init__(self, *args, **kwargs):
        self.values = kwargs.pop('values')
        kwargs['choices'] = [(v, v) for v in self.values]
        kwargs['default'] = self.values[0]
        super(EnumField, self).__init__(*args, **kwargs)

    def db_type(self):
        return "enum({0})".format( ','.join("'%s'" % v for v in self.values) )

Answer 3

使用choices参数将不使用ENUM db类型; 它只是建立一个VARCHAR或INTEGER，这取决于您是否使用choices与CharField或IntegerField。 一般来说，这很好。 如果在数据库级别使用ENUM类型对您很重要，则有三个选项：

1. 使用“./manage.py sql appname”查看SQL Django生成，手动修改它以使用ENUM类型，并自行运行。 如果您先手动创建表，“。/ manage.py syncdb”将不会乱用它。
2. 如果您不希望每次生成数据库时手动执行此操作，请在appname / sql / modelname.sql中放置一些自定义SQL以执行相应的ALTER TABLE命令。
3. 创建自定义字段类型并适当地定义db_type方法。

使用这些选项中的任何一个，您都有责任处理跨数据库可移植性的影响。 在选项2中，您可以使用特定于数据库后端的自定义SQL来确保您的ALTER TABLE仅在MySQL上运行。 在选项3中，db_type方法需要检查数据库引擎并将db列类型设置为该数据库中实际存在的类型。

更新 ：由于迁移框架是在Django 1.7中添加的，因此上面的选项1和2完全过时了。 无论如何，选项3始终是最佳选择。 新版本的选项1/2将涉及使用SeparateDatabaseAndState进行复杂的自定义迁移 - 但实际上您需要选项3。

Answer 4

http://www.b-list.org/weblog/2007/nov/02/handle-choices-right-way/

 class Entry(models.Model): LIVE_STATUS = 1 DRAFT_STATUS = 2 HIDDEN_STATUS = 3 STATUS_CHOICES = ( (LIVE_STATUS, 'Live'), (DRAFT_STATUS, 'Draft'), (HIDDEN_STATUS, 'Hidden'), ) # ...some other fields here... status = models.IntegerField(choices=STATUS_CHOICES, default=LIVE_STATUS) live_entries = Entry.objects.filter(status=Entry.LIVE_STATUS) draft_entries = Entry.objects.filter(status=Entry.DRAFT_STATUS) if entry_object.status == Entry.LIVE_STATUS: 

这是另一种实现枚举的简单方法，尽管它并没有真正保存数据库中的枚举。

但是，它允许您在查询或指定默认值时引用“标签”，而不是在必须使用“值”（可能是数字）的最高等级答案时。

Answer 5

在字段上设置choices将允许对Django端进行一些验证，但它不会在数据库端定义任何形式的枚举类型。

正如其他人所提到的，解决方案是在自定义字段上指定db_type 。

如果你正在使用SQL后端（例如MySQL），你可以这样做：

from django.db import models


class EnumField(models.Field):
    def __init__(self, *args, **kwargs):
        super(EnumField, self).__init__(*args, **kwargs)
        assert self.choices, "Need choices for enumeration"

    def db_type(self, connection):
        if not all(isinstance(col, basestring) for col, _ in self.choices):
            raise ValueError("MySQL ENUM values should be strings")
        return "ENUM({})".format(','.join("'{}'".format(col) 
                                          for col, _ in self.choices))


class IceCreamFlavor(EnumField, models.CharField):
    def __init__(self, *args, **kwargs):
        flavors = [('chocolate', 'Chocolate'),
                   ('vanilla', 'Vanilla'),
                  ]
        super(IceCreamFlavor, self).__init__(*args, choices=flavors, **kwargs)


class IceCream(models.Model):
    price = models.DecimalField(max_digits=4, decimal_places=2)
    flavor = IceCreamFlavor(max_length=20)

运行syncdb ，并检查表以查看是否正确创建了ENUM 。

mysql> SHOW COLUMNS IN icecream;
+--------+-----------------------------+------+-----+---------+----------------+
| Field  | Type                        | Null | Key | Default | Extra          |
+--------+-----------------------------+------+-----+---------+----------------+
| id     | int(11)                     | NO   | PRI | NULL    | auto_increment |
| price  | decimal(4,2)                | NO   |     | NULL    |                |
| flavor | enum('chocolate','vanilla') | NO   |     | NULL    |                |
+--------+-----------------------------+------+-----+---------+----------------+

Answer 6

如果你真的想使用你的数据库ENUM类型：

1. 使用Django 1.x.
2. 识别您的应用程序仅适用于某些数据库。
3. 通过这个文档页面拼图： http ： //docs.djangoproject.com/en/dev/howto/custom-model-fields/#howto-custom-model-fields

祝好运！

Answer 7

目前有两个基于添加这些的github项目，但我还没有仔细研究它们是如何实现的：

1. Django-EnumField ：
   提供枚举Django模型字段（使用IntegerField），具有可重用的枚举和转换验证。
2. Django-EnumFields ：
   这个包允许你使用Django的真实Python（PEP435风格）枚举。

我不认为要么使用DB枚举类型，但他们的作品的第一个。

Answer 8

Django 3.0 内置了对枚举的支持

从文档：

from django.utils.translation import gettext_lazy as _

class Student(models.Model):

    class YearInSchool(models.TextChoices):
        FRESHMAN = 'FR', _('Freshman')
        SOPHOMORE = 'SO', _('Sophomore')
        JUNIOR = 'JR', _('Junior')
        SENIOR = 'SR', _('Senior')
        GRADUATE = 'GR', _('Graduate')

    year_in_school = models.CharField(
        max_length=2,
        choices=YearInSchool.choices,
        default=YearInSchool.FRESHMAN,
    )

现在，请注意，它不会在数据库级别强制执行选择，这只是 Python 构造。 如果您还想在数据库中强制执行这些值，您可以将其与数据库约束相结合：

class Student(models.Model):
    ...

    class Meta:
        constraints = [
            CheckConstraint(
                check=Q(year_in_school__in=YearInSchool.values),
                name="valid_year_in_school")
        ]

Answer 9

如果您必须在 MySQL 表中有枚举类型，而不是“假”枚举（仅在 python 端可见），那么您可以尝试Django-MySQL扩展及其EnumField 。

型号：

from django.db import models
from django_mysql.models import EnumField


class IceCreamFlavor(models.TextChoices):
    CHOCOLATE = "chocolate"
    VANILLA = "vanilla"


class IceCream(models.Model):
    price = models.DecimalField(max_digits=4, decimal_places=2)
    ice_cream_flavor = EnumField(choices=IceCreamFlavor.choices)

结果表：

mysql> SHOW COLUMNS IN myapp.db_icecream;
+------------------+-----------------------------+------+-----+---------+----------------+
| Field            | Type                        | Null | Key | Default | Extra          |
+------------------+-----------------------------+------+-----+---------+----------------+
| id               | int                         | NO   | PRI | NULL    | auto_increment |
| price            | decimal(4,2)                | NO   |     | NULL    |                |
| ice_cream_flavor | enum('chocolate','vanilla') | NO   |     | NULL    |                |
+------------------+-----------------------------+------+-----+---------+----------------+

Answer 10

在models.py文件的顶部，执行导入后添加以下行：

    enum = lambda *l: [(s,_(s)) for s in l]