Django 如何在 INSERT…ON CONFLICT 语句的 RETURNING 中包含被排除的行

在本文中，我们将介绍 Django ORM 中如何在 INSERT…ON CONFLICT 语句的 RETURNING 子句中包含被排除的行。
当插入数据到数据库表中时，如果发生冲突，Django ORM 可以使用 INSERT…ON CONFLICT 语句进行处理。
该语句可以指定在发生冲突时要执行的操作，例如更新冲突记录的特定字段。
然而，默认情况下，INSERT…ON CONFLICT 语句的 RETURNING 子句只返回成功插入的行，排除了发生冲突的行。
本文将介绍如何修改 Django ORM 的默认行为，以便在返回结果中包含被排除的行。

INSERT…ON CONFLICT 语句简介

INSERT…ON CONFLICT 语句是 PostgreSQL 数据库的扩展，用于处理插入冲突的情况。
在 Django 中，可以使用 Model.objects.insert() 方法来执行 INSERT…ON CONFLICT 语句。

下面是一个示例，插入一些学生的成绩信息到一个名为 student_scores 的表中：

from django.db import models
from django.contrib.postgres.fields import IntegerRangeField

class Student(models.Model):
    name = models.CharField(max_length=100)
    score = IntegerRangeField()

student_list = [
    {'name': 'Alice', 'score': (90, 100)},
    {'name': 'Bob', 'score': (80, 90)},
    {'name': 'Alice', 'score': (70, 80)},
]

Student.objects.insert(student_list, conflict_target=['name'], update={'score': ('student_scores.score', 'EXCLUDED.score')})

在这个示例中，我们使用 Student.objects.insert() 方法插入了一个学生列表到 student_scores 表中。
如果表中已存在某个学生的记录，那么发生冲突。为了处理冲突，我们使用 conflict_target 参数指定了冲突的字段，即学生的姓名。
并且使用 update 参数指定了在冲突发生时更新学生的分数。

但是，默认情况下，Student.objects.insert() 方法的返回结果中只包含成功插入的行，排除了发生冲突的行。
接下来，我们将介绍如何修改该行为，以便在返回结果中包含被排除的行。

修改默认行为

要在 INSERT…ON CONFLICT 语句的 RETURNING 子句中包含被排除的行，我们可以通过自定义 Manager 类来实现。

from django.db import models
from django.db.models import QuerySet

class ReturningQuerySet(QuerySet):
    def as_returning(self):
        self.query.set_returning_fields(self.model._meta.fields)
        return self

class ReturningManager(models.Manager):
    def get_queryset(self):
        return ReturningQuerySet(self.model, using=self._db)

首先，我们创建一个自定义的 ReturningQuerySet 类，继承自 django.db.models.QuerySet。
在该类中，我们重写了 as_returning() 方法，通过调用 set_returning_fields() 方法来设置 RETURNING 字段。

然后，我们创建一个自定义的 ReturningManager 类，继承自 django.db.models.Manager。
在该类中，我们重写了 get_queryset() 方法，返回我们之前创建的 ReturningQuerySet 对象。

接下来，我们可以将自定义的 ReturningManager 类作为模型的默认管理器，并在执行 INSERT…ON CONFLICT 语句时使用该管理器。

class Student(models.Model):
    name = models.CharField(max_length=100)
    score = IntegerRangeField()

    objects = ReturningManager()

student_list = [
    {'name': 'Alice', 'score': (90, 100)},
    {'name': 'Bob', 'score': (80, 90)},
    {'name': 'Alice', 'score': (70, 80)},
]

result = Student.objects.as_returning().insert(student_list, conflict_target=['name'], update={'score': ('student_scores.score', 'EXCLUDED.score')})

在这个示例中，我们通过调用 as_returning() 方法将查询集转换为返回返回结果的形式。
然后，我们调用 insert() 方法执行 INSERT…ON CONFLICT 语句，并将结果赋值给 result 变量。

现在，result 变量中包含了发生冲突的行，以及成功插入的行。

总结

本文介绍了在 Django ORM 中如何在 INSERT…ON CONFLICT 语句的 RETURNING 子句中包含被排除的行。
通过自定义 Manager 类，我们可以修改 Django 的默认行为，实现在返回结果中包含被排除的行。
使用这种方法，我们可以更灵活地处理插入冲突，并获取更详细的返回结果。