Django unique_together与可空的ForeignKey

时间:2015-10-23 17:07:25

标签: django django-models django-forms django-validation

我在使用Sqlite的开发机器中使用Django 1.8.4并且我有这些模型:

class ModelA(Model):
    field_a = CharField(verbose_name='a', max_length=20)
    field_b = CharField(verbose_name='b', max_length=20)

    class Meta:
        unique_together = ('field_a', 'field_b',)


class ModelB(Model):
    field_c = CharField(verbose_name='c', max_length=20)
    field_d = ForeignKey(ModelA, verbose_name='d', null=True, blank=True)

    class Meta:
        unique_together = ('field_c', 'field_d',)

我已经运行了正确的迁移并在Django Admin中注册了它们。因此,使用管理员我已完成此测试:

  • 我能够创建ModelA记录,而Django禁止我创建重复记录 - 正如所料!
  • 当field_b不为空时,我无法创建相同的ModelB记录
  • 但是,当使用field_d为空时,我能够创建相同的ModelB记录

我的问题是:如何将unique_together应用于可空的ForeignKey?

我发现这个问题的最新答案有5年......我确实认为Django已经进化了,问题可能不一样。

6 个答案:

答案 0 :(得分:15)

更新:我的答案的早期版本功能正常,但设计不合理,这个版本考虑了一些评论和其他答案。

在SQL中,NULL不等于NULL。这意味着如果你有两个field_d == None and field_c == "somestring"它们不相等的对象,那么你可以创建它们。

您可以覆盖Model.clean以添加支票:

class ModelB(Model):
    #...
    def validate_unique(self, exclude=None):
        if ModelB.objects.exclude(id=self.id).filter(field_c=self.field_c, \
                                 field_d__isnull=True).exists():
            raise ValidationError("Duplicate ModelB")
        super(ModelB, self).validate_unique(exclude)

如果在表单之外使用,则必须致电full_cleanvalidate_unique

尽管如此,请注意处理竞争状况。

答案 1 :(得分:8)

@ivan,我认为django没有一种简单的方法来管理这种情况。您需要考虑并非总是来自表单的所有创建和更新操作。此外,你应该考虑竞争条件......

因为您没有在数据库级别强制使用此逻辑,实际上可能会有双倍的记录,您应该在查询结果时进行检查。

关于你的解决方案,它可能对表单有好处,但我不认为save方法会引发ValidationError。

如果可能,那么最好将此逻辑委托给DB。在这种特殊情况下,您可以使用两个部分索引。 StackOverflow上有类似的问题 - Create unique constraint with null columns

因此,您可以创建Django迁移,为您的数据库添加两个部分索引

示例:

# Assume that app name is just `example`

CREATE_TWO_PARTIAL_INDEX = """
    CREATE UNIQUE INDEX model_b_2col_uni_idx ON example_model_b (field_c, field_d)
    WHERE field_d IS NOT NULL;

    CREATE UNIQUE INDEX model_b_1col_uni_idx ON example_model_b (field_c)
    WHERE field_d IS NULL;
"""

DROP_TWO_PARTIAL_INDEX = """
    DROP INDEX model_b_2col_uni_idx;
    DROP INDEX model_b_1col_uni_idx;
"""


class Migration(migrations.Migration):

    dependencies = [
        ('example', 'PREVIOUS MIGRATION NAME'),
    ]

    operations = [
        migrations.RunSQL(CREATE_TWO_PARTIAL_INDEX, DROP_TWO_PARTIAL_INDEX)
    ]

答案 2 :(得分:3)

Django 2.2添加了新的constraints API,这使得在数据库中解决这种情况变得更加容易。

您将需要两个约束:

  1. 现有的元组约束;和
  2. 剩余键减去可为空的键,并附带条件

如果您有多个可为空的字段,我想您将需要处理排列。

下面是一个示例,其中有多个字段必须都是唯一的,其中只允许一个NULL

from django.db import models
from django.db.models import Q
from django.db.models.constraints import UniqueConstraint

class Badger(models.Model):
    required = models.ForeignKey(Required, ...)
    optional = models.ForeignKey(Optional, null=True, ...)
    key = models.CharField(db_index=True, ...)

    class Meta:
        constraints = [
            UniqueConstraint(fields=['required', 'optional', 'key'],
                             name='unique_with_optional'),
            UniqueConstraint(fields=['required', 'key'],
                             condition=Q(optional=None),
                             name='unique_without_optional'),
        ]

答案 3 :(得分:0)

我认为这是针对Django 1.2+的更清晰的方法

在表格中,它将被引发为non_field_error,没有500错误,在其他情况下,例如DRF,您必须检查此案例手册,因为它将是500错误。 但是它将始终检查unique_together!

class BaseModelExt(models.Model):
is_cleaned = False

def clean(self):
    for field_tuple in self._meta.unique_together[:]:
        unique_filter = {}
        unique_fields = []
        null_found = False
        for field_name in field_tuple:
            field_value = getattr(self, field_name)
            if getattr(self, field_name) is None:
                unique_filter['%s__isnull' % field_name] = True
                null_found = True
            else:
                unique_filter['%s' % field_name] = field_value
                unique_fields.append(field_name)
        if null_found:
            unique_queryset = self.__class__.objects.filter(**unique_filter)
            if self.pk:
                unique_queryset = unique_queryset.exclude(pk=self.pk)
            if unique_queryset.exists():
                msg = self.unique_error_message(self.__class__, tuple(unique_fields))

                raise ValidationError(msg)

    self.is_cleaned = True

def save(self, *args, **kwargs):
    if not self.is_cleaned:
        self.clean()

    super().save(*args, **kwargs)

答案 4 :(得分:0)

尚未提及的一种可能的解决方法是创建一个虚拟ModelA对象作为您的NULL值。然后,您可以依靠数据库强制执行唯一性约束。

答案 5 :(得分:0)

为您的模型添加一个干净的方法 - 见下文

def clean(self):
        if Variants.objects.filter("""Your filter """).exclude(pk=self.pk).exists():
            raise ValidationError("This variation is duplicated.")