这些功能可以从 django.contrib.postgres.aggregates
模块中获得。在 PostgreSQL docs 中对这些功能有更详细的描述。
备注
所有的函数都没有默认的别名,所以你必须明确提供一个别名。例如:
>>> SomeModel.objects.aggregate(arr=ArrayAgg('somefield'))
{'arr': [0, 1, 2]}
通用聚合函数
ArrayAgg
-
class
ArrayAgg
(expression, distinct=False, filter=None, default=None, ordering=(), **extra) 返回一个值的列表,包括空值,串联成一个数组,如果没有值,则返回
default
。-
ordering
可选的字段名字符串(可选的
"-"
前缀表示降序)或表达式(或字符串和/或表达式的元组或列表),指定结果列表中元素的顺序。举例:
'some_field' '-some_field' from django.db.models import F F('some_field').desc()
4.0 版后已移除: 如果没有行,并且没有提供
default
,ArrayAgg
会返回一个空列表,而不是None
。这个行为已被废弃,并将在 Django 5.0 中被删除。如果你需要它,请明确设置default
为Value([])
。-
BoolAnd
-
class
BoolAnd
(expression, filter=None, default=None, **extra) 如果所有输入值为真,返回
True
,如果所有值为空或没有值,返回default
,否则返回False
。使用实例:
class Comment(models.Model): body = models.TextField() published = models.BooleanField() rank = models.IntegerField() >>> from django.db.models import Q >>> from django.contrib.postgres.aggregates import BoolAnd >>> Comment.objects.aggregate(booland=BoolAnd('published')) {'booland': False} >>> Comment.objects.aggregate(booland=BoolAnd(Q(rank__lt=100))) {'booland': True}
BoolOr
-
class
BoolOr
(expression, filter=None, default=None, **extra) 如果至少有一个输入值为真,则返回
True
,如果所有值都为空或没有值,则返回default
,否则返回False
。使用实例:
class Comment(models.Model): body = models.TextField() published = models.BooleanField() rank = models.IntegerField() >>> from django.db.models import Q >>> from django.contrib.postgres.aggregates import BoolOr >>> Comment.objects.aggregate(boolor=BoolOr('published')) {'boolor': True} >>> Comment.objects.aggregate(boolor=BoolOr(Q(rank__gt=2))) {'boolor': False}
JSONBAgg
-
class
JSONBAgg
(expressions, distinct=False, filter=None, default=None, ordering=(), **extra) 返回输入值为
JSON
数组,如果没有值,则返回default
。你可以使用key 和 index 查找
来查询结果。-
ordering
可选的字段名字符串(可选的
"-"
前缀表示降序)或表达式(或字符串和/或表达式的元组或列表),指定结果列表中元素的顺序。例子与
ArrayAgg.ordering
相同。
使用实例:
class Room(models.Model): number = models.IntegerField(unique=True) class HotelReservation(model.Model): room = models.ForeignKey('Room', on_delete=models.CASCADE) start = models.DateTimeField() end = models.DateTimeField() requirements = models.JSONField(blank=True, null=True) >>> from django.contrib.postgres.aggregates import JSONBAgg >>> Room.objects.annotate( ... requirements=JSONBAgg( ... 'hotelreservation__requirements', ... ordering='-hotelreservation__start', ... ) ... ).filter(requirements__0__sea_view=True).values('number', 'requirements') <QuerySet [{'number': 102, 'requirements': [ {'parking': False, 'sea_view': True, 'double_bed': False}, {'parking': True, 'double_bed': True} ]}]>
4.0 版后已移除: 如果没有记录,并且没有提供
default
,JSONBAgg
会返回一个空列表,而不是None
。这个行为已被废弃,并将在 Django 5.0 中删除。如果你需要它,请明确设置default
为Value('[]')
。-
StringAgg
-
class
StringAgg
(expression, delimiter, distinct=False, filter=None, default=None, ordering=()) 返回输入值串联成的字符串,用
delimiter
字符串分隔,如果没有值,则返回default
。-
ordering
可选的字段名字符串(可选的
"-"
前缀表示降序)或表达式(或字符串和/或表达式的元组或列表),指定结果字符串中元素的顺序。例子与
ArrayAgg.ordering
相同。
4.0 版后已移除: 如果没有记录,并且没有提供
default
,StringAgg
会返回一个空字符串,而不是None
。这个行为已经过时,在 Django 5.0 中会被删除。如果你需要它,请明确设置default
为Value('')
。-
使用实例:
我们将用这个例表:
| FIELD1 | FIELD2 | FIELD3 |
|--------|--------|--------|
| foo | 1 | 13 |
| bar | 2 | (null) |
| test | 3 | 13 |
下面是一些通用聚合函数的例子:
>>> TestModel.objects.aggregate(result=StringAgg('field1', delimiter=';'))
{'result': 'foo;bar;test'}
>>> TestModel.objects.aggregate(result=ArrayAgg('field2'))
{'result': [1, 2, 3]}
>>> TestModel.objects.aggregate(result=ArrayAgg('field1'))
{'result': ['foo', 'bar', 'test']}
下一个例子显示了统计聚合函数的使用。基本的数学知识将不作说明(例如,你可以在 wikipedia ):
>>> TestModel.objects.aggregate(count=RegrCount(y='field3', x='field2'))
{'count': 2}
>>> TestModel.objects.aggregate(avgx=RegrAvgX(y='field3', x='field2'),
... avgy=RegrAvgY(y='field3', x='field2'))
{'avgx': 2, 'avgy': 13}
讨论区