尝试在 mysql 数据库中设置枚举数据类型时出现问题

Question

我想做什么？

Django 不支持在 mysql 数据库中设置枚举数据类型。使用下面的代码，我尝试设置枚举数据类型。

错误详情

_mysql.connection.query(self, query) django.db.utils.ProgrammingError: (1064, "You have an error in your SQL syntax; check the manual that 对应于您的 MariaDB 服务器版本，以便使用正确的语法 'NOT NULL, created_at datetime(6) NOT NULL, user_id bigint 附近 NOT NULL)' 在第 1 行")

我错过了什么吗？

具有所有选择的枚举类

class enumTokenTypes(models.TextChoices):
    Registration = "Registration"
    ForgotPassword = "Forgot Password"

模型中的用户令牌类

class tblusertokens(models.Model):
    token_id = AutoField(primary_key=True)
    token_type = EnumField(max_length=20, choices=enumTokenTypes.choices)
    created_at = DateTimeField(auto_now_add=True, blank=True)
    user = ForeignKey(tblusers, on_delete = models.CASCADE)    

迁移中的用户令牌创建模型

class EnumField(CharField):
    def db_type(self, connection):
        return "enum"


migrations.CreateModel(
    name='tblusertokens',
    fields=[
        ('token_id', models.AutoField(primary_key=True, serialize=False)),
        ('token_type', clientauth.models.EnumField(choices=[('Registration', 'Registration'), ('Forgot Password', 'Forgotpassword')], max_length=20)),
        ('created_at', models.DateTimeField(auto_now_add=True)),
        ('user', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to='clientauth.tblusers')),
    ],
)

赏金问题

为函数设置 2 个参数以传递逗号分隔值和默认值。

Answer 1

对赏金问题的回应

用于设置默认值：在 EnumField 中添加默认参数。下面的示例我已将 enumTokenTypes Registration 设置为其默认值。通过示例查看 Django documentation 以获取 enum 实现

     class tblusertokens(models.Model):
          token_id = AutoField(primary_key=True)
          token_type = EnumField(max_length=20, choices=enumTokenTypes.choices, default=enumTokenTypes.Registration )
          created_at = DateTimeField(auto_now_add=True, blank=True)
          user = ForeignKey(tblusers, on_delete = models.CASCADE)    

Answer 2

数据类型应该是enum('Registration', 'Forgot Password') 而不仅仅是enum。

class EnumField(CharField):

    def db_type(self, connection):
        if connection.vendor == 'mysql':
            return 'enum({0})'.format(','.join("'%s'" % value for value, label in self.choices))
        return super().db_type(connection)

参考：https://dev.mysql.com/doc/refman/8.0/en/enum.html

数据库默认

虽然上面的 MySQL 8.0 文档中没有明确提及，但您也可以指定数据库默认值。

class EnumField(CharField):

    def __init__(self,  *args, **kwargs):
        self.db_default = kwargs.pop('db_default', None)
        super().__init__(*args, **kwargs)

    def db_type(self, connection):
        if connection.vendor == 'mysql':
            if self.db_default is not None:
                return "enum({0}) DEFAULT '{1}'".format(','.join("'%s'" % value for value, label in self.choices), self.db_default)
            return 'enum({0})'.format(','.join("'%s'" % value for value, label in self.choices))
        return super().db_type(connection)

    def deconstruct(self):
        name, path, args, kwargs = super().deconstruct()
        if self.db_default:
            kwargs['db_default'] = self.db_default
        return name, path, args, kwargs

用法：

token_type = EnumField(max_length=20, choices=enumTokenTypes.choices, db_default=enumTokenTypes.ForgotPassword)

关于deconstruct()方法

来自https://docs.djangoproject.com/en/3.2/howto/custom-model-fields/#field-deconstruction：

编写__init__() 方法的对应点是编写deconstruct() 方法。它在模型迁移期间用于告诉 Django 如何获取新字段的实例并将其简化为序列化形式 - 特别是传递给 __init__() 以重新创建它的参数。

如果您添加一个新的关键字参数，您需要自己在deconstruct() 中编写代码，将其值放入kwargs。

Answer 3

您可以打印出该迁移的 sql 以查看具体出了什么问题，但将 db_type 定义为返回 "enum" 绝对不是正确的处理方法。

    ('token_type', CharField(choices=enumTokenTypes.choices, max_length=22)),

Enumeration types 上的文档中推荐的语法是否因某种原因不适合您？