添加新的唯一字段时如何正确进行迁移

Posted 2023-02-24

【中文标题】添加新的唯一字段时如何正确进行迁移

【英文标题】：How to properly make migrations when adding a new unique field

【发布时间】：2016-07-06 22:08:31

【问题描述】：

我为我的一个模型添加了一个新字段：

class Agency(models.Model):
    email = models.EmailField(unique=True, verbose_name=_("e-mail"))

由于此字段不能为空，django-admin makemigrations 要求我提供一次性默认值，我做到了。这是生成的迁移：

# Generated by Django 1.9.4 on 2016-03-20 10:38
from __future__ import unicode_literals

from django.db import migrations, models


class Migration(migrations.Migration):

    dependencies = [
        ('accounts', '0008_auto_20160226_1226'),
    ]

    operations = [
        migrations.AddField(
            model_name='agency',
            name='email',
            field=models.EmailField(default='[e-mail]', max_length=254, unique=True, verbose_name='e-mail'),
            preserve_default=False,
        ),
    ]

不出所料，django-admin migrate 抛出了一个错误：

psycopg2.IntegrityError: could not create unique index "accounts_agency_email_key"
DETAIL:  Key (email)=([e-mail]) is duplicate.

我想我可以在使字段唯一之前编辑迁移以设置唯一值。所以我尝试了：

# -*- coding: utf-8 -*-
# Generated by Django 1.9.4 on 2016-03-20 10:38
from __future__ import unicode_literals

from django.db import migrations, models
from django.utils.text import slugify


def set_email(apps, schema_editor):
    Agency = apps.get_model('accounts', 'Agency')
    for agency in Agency.objects.all():
        agency.email = '@example.fr'.format(slugify(agency.name))
        agency.save()


class Migration(migrations.Migration):

    dependencies = [
        ('accounts', '0008_auto_20160226_1226'),
    ]

    operations = [
        migrations.AddField(
            model_name='agency',
            name='email',
            field=models.EmailField(default='', max_length=254, blank=True, verbose_name='e-mail'),
            preserve_default=False,
        ),
        migrations.RunPython(set_email),
        migrations.AlterField(
            model_name='agency',
            name='email',
            field=models.EmailField(max_length=254, unique=True, verbose_name='e-mail'),
            preserve_default=False,
        ),
    ]

不幸的是，我在运行django-admin migrate 时收到此错误：

django.db.utils.OperationalError: cannot ALTER TABLE "accounts_agency" because it has pending trigger events

我的猜测是operations 不会同步执行。

我想我可以通过将迁移分成两个迁移来解决这个问题，但我想知道我是否可以只在一个迁移中完成。在模型中添加新的唯一字段时创建迁移的常用方法是什么？

PS：我也尝试使用 F 表达式作为默认值 (default=models.F('name') + '@example.fr') 但失败了：

django.db.utils.IntegrityError: could not create unique index "accounts_agency_email_key"
DETAIL:  Key (email)=(F(name) + Vallu(@example.fr)) is duplicated.

【问题讨论】：

您是否阅读过专门处理此问题的文档部分？ docs.djangoproject.com/en/1.9/howto/writing-migrations/…

@koniiiik，我在错误的页面上搜索 docs.djangoproject.com/en/1.9/topics/migrations 所以，看起来只有一次迁移无法让它工作。

您有什么理由不想使用两次迁移吗？

我很惊讶在同一迁移中执行所有操作都不起作用。但是，进行 2 次（或 3 次）迁移意味着，一个错误可能会在没有其他迁移的情况下被还原，这会使应用程序处于意外状态。

受这个问题的启发，我给 Django howto 写了一个pull request 9212，以简化它，尤其是防止出现“意外状态”。目前我正在等待。

【参考方案1】：

也许为时已晚，但也许对别人有用

您可以通过使用 migrations.RunSQL 方法在一次迁移中完成此操作

在您将新字段添加到模型并运行 python manage.py makemigrations 命令后，对于您的示例代码（此处，如果您的表命令中有现有行想要选择默认值，您可以选择“立即提供一次性默认值” 选项并提供一些字符串值，这并不重要，因为实际上我们没有使用它）然后转到迁移文件并使用此更改操作部分（注意我使用postgresql，您可以更改数据库的 SQL）

operations = [
        migrations.RunSQL(
        'ALTER TABLE "agency" ADD COLUMN "email" varchar(254) NULL;ALTER TABLE "agency" ALTER COLUMN "email" DROP DEFAULT;COMMIT;',
        ),
        migrations.RunSQL(
        "UPDATE agency SET email= Concat(country_code, '@example.fr');COMMIT;",
        ),
        migrations.RunSQL(
        'ALTER TABLE "agency" ALTER COLUMN "email" SET NOT NULL;ALTER TABLE "agency" ADD CONSTRAINT "agency_email_b551ad2a_uniq" UNIQUE ("email");ALTER TABLE "agency" ALTER COLUMN "email" DROP DEFAULT;CREATE INDEX "agency_email_b551ad2a_like" ON "agency" ("email" varchar_pattern_ops);COMMIT;'
        )
    ]

然后运行“python manage.py migrate”命令 就是这样。

【讨论】：

这太棒了。非常感谢