Django 1.9 JSONField order_by

Question

我有以下包含 JSONField 的 Django 模型：

class RatebookDataEntry(models.Model):
    data = JSONField(blank=True, default=[])
    last_update = models.DateTimeField(auto_now=True)

    class Meta:
        verbose_name_plural = 'Ratebook data entries'

数据字段包含此 json：

{
    "annual_mileage": 15000, 
    "description": "LEON DIESEL SPORT COUPE", 
    "body_style": "Coupe", 
    "range_name": "LEON", 
    "co2_gkm_max": 122, 
    "manufacturer_name": "SEAT"
}

我可以按数据字段之一对查询集进行排序吗？ 此查询不起作用。

RatebookDataEntry.objects.all().order_by("data__manufacturer_name")

Answer 1

正如 Julien 提到的，Django 尚不支持对JSONField排序。 但是可以通过RawSQL使用RawSQL PostgreSQL 函数。 在 OP 的情况下：

from django.db.models.expressions import RawSQL
RatebookDataEntry.objects.all().order_by(RawSQL("data->>%s", ("manufacturer_name",)))

Answer 2

从 Django 1.11 开始，可以使用django.contrib.postgres.fields.jsonb.KeyTextTransform代替RawSQL

from django.contrib.postgres.fields.jsonb import KeyTextTransform

qs = RatebookEntry.objects.all()
qs = qs.annotate(manufacturer_name=KeyTextTransform('manufacturer_name', 'data'))
qs = qs.order_by('manufacturer_name')
# or...
qs = qs.order_by('-manufacturer_name')

在 Django 1.10 上，你必须自己KeyTransform ：

from django.contrib.postgres.fields.jsonb import KeyTransform

class KeyTextTransform(KeyTransform):
    operator = '->>'
    nested_operator = '#>>'
    _output_field = TextField()

注：之间的区别KeyTransform和KeyTextTransform是KeyTransform将返回对象的JSON表示，而KeyTextTransform将返回对象的值。

例如，如果data是{"test": "stuff"} ， KeyTextTransform将返回'stuff' ，而KeyTransform将返回'"stuff"' （可以通过json.loads解析）

Answer 3

按照Daniil Ryzhkov 的回答和Eugene Prikazchikov 的评论，您应该能够通过使用RawSQL和OrderBy对 JSON 数据字段的 ASC 和 DESC 进行排序，而无需注释您的RawSQL 。 此外，您可以通过添加LOWER来执行不区分大小写的排序：

from django.db.models.expressions import RawSQL, OrderBy

RatebookDataEntry.objects.all().order_by(OrderBy(RawSQL("LOWER(data->>%s)", ("manufacturer_name",)), descending=True))

要比较整数字段，您可以将其转换为整数：

RatebookDataEntry.objects.all().order_by(OrderBy(RawSQL("cast(data->>%s as integer)", ("annual_mileage",)), descending=True))

Answer 4

这是即将推出的功能，已经添加并将在 Django 2.1 中发布，预计将于 2018 年 8 月发布。

有关详细信息，请参阅https://code.djangoproject.com/ticket/24747和https://github.com/django/django/pull/8528 。

Answer 5

文档没有提到这种可能性。 看来您暂时不能使用基于 JSONfield 的 order_by。

Answer 6

这个问题（以及大部分答案）是针对 Django 1.9 的。 但是， Django 3.1 和更新版本在 MariaDB、MySQL、Oracle、PostgreSQL 和 SQLite 的最新版本上支持JSONField 。

在 JSON 字段上创建/维护索引的行为可能因数据库引擎而异，但排序应该使用您在问题中的确切语法：

RatebookDataEntry.objects.all().order_by("data__manufacturer_name")

请注意，除非您进行进一步过滤，否则这将包括data JSONField 中的manufacturer_name键不存在的数据库行。

Answer 7

我必须执行以下操作才能按日期排序（使用to_date ）。 假设有一个在另一个值data称为created_date （如2019年6月3日）。

RatebookDataEntry.objects.all().order_by(
        OrderBy(
            RawSQL("to_date(values->>%s, 'DD.MM.YYYY')", ("created_date",)),
            descending=True,
        )
    )