ArrayAgg¶

class ArrayAgg(expression, distinct=False, filter=None, default=None, ordering=(), **extra)¶

傳回一個值列表，包括空值，串連成一個陣列，如果沒有值則傳回 default。

distinct¶

一個可選的布林引數，決定陣列值是否為唯一值。預設為 False。

ordering¶

一個可選的欄位名稱字串（帶有可選的 "-" 字首，表示降序）或一個表示式（或字串和/或表示式的元組或列表），指定結果列表中元素的順序。

範例

"some_field"
"-some_field"
from django.db.models import F

F("some_field").desc()

在 Django 5.0 中變更

在較舊版本中，如果沒有資料列且沒有提供 default，ArrayAgg 會傳回一個空列表而不是 None。如果需要，請明確將 default 設定為 Value([])。

BitAnd¶

class BitAnd(expression, filter=None, default=None, **extra)¶

傳回所有非空輸入值的位元 AND 的 int，如果所有值都為空值則傳回 default。

BitOr¶

class BitOr(expression, filter=None, default=None, **extra)¶

傳回所有非空輸入值的位元 OR 的 int，如果所有值都為空值則傳回 default。

BitXor¶

class BitXor(expression, filter=None, default=None, **extra)¶

傳回所有非空輸入值的位元 XOR 的 int，如果所有值都為空值則傳回 default。它需要 PostgreSQL 14+。

BoolAnd¶

class BoolAnd(expression, filter=None, default=None, **extra)¶

如果所有輸入值都為 true 則傳回 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 則傳回 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 and index lookups 查詢結果。

distinct¶

一個可選的布林引數，決定陣列值是否為唯一值。預設為 False。

ordering¶

一個可選的欄位名稱字串（帶有可選的 "-" 字首，表示降序）或一個表示式（或字串和/或表示式的元組或列表），指定結果列表中元素的順序。

範例與 ArrayAgg.ordering 相同。

使用範例

class Room(models.Model):
    number = models.IntegerField(unique=True)


class HotelReservation(models.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}
]}]>

在 Django 5.0 中變更

在較舊版本中，如果沒有資料列且沒有提供 default，JSONBAgg 會傳回一個空列表而不是 None。如果需要，請明確將 default 設定為 Value([])。

StringAgg¶

class StringAgg(expression, delimiter, distinct=False, filter=None, default=None, ordering=())¶

傳回輸入值串連成一個字串，並以 delimiter 字串分隔，如果沒有值則傳回 default。

delimiter¶

必要參數。必須為字串。

distinct¶

一個可選的布林參數，決定串連的值是否為唯一值。預設值為 False。

ordering¶

一個可選的欄位名稱字串（可選用 "-" 前綴表示降冪排序）或一個運算式（或字串和/或運算式的元組或列表），用於指定結果字串中元素的排序方式。

範例與 ArrayAgg.ordering 相同。

使用範例

class Publication(models.Model):
    title = models.CharField(max_length=30)


class Article(models.Model):
    headline = models.CharField(max_length=100)
    publications = models.ManyToManyField(Publication)

>>> article = Article.objects.create(headline="NASA uses Python")
>>> article.publications.create(title="The Python Journal")
<Publication: Publication object (1)>
>>> article.publications.create(title="Science News")
<Publication: Publication object (2)>
>>> from django.contrib.postgres.aggregates import StringAgg
>>> Article.objects.annotate(
...     publication_names=StringAgg(
...         "publications__title",
...         delimiter=", ",
...         ordering="publications__title",
...     )
... ).values("headline", "publication_names")
<QuerySet [{
    'headline': 'NASA uses Python', 'publication_names': 'Science News, The Python Journal'
}]>

在 Django 5.0 中變更

在較舊的版本中，如果沒有任何列且未提供 default，StringAgg 會傳回空字串而不是 None。如果需要此行為，請明確將 default 設為 Value("")。

y 和 x¶

所有這些函數的參數 y 和 x 可以是欄位名稱或傳回數值資料的運算式。兩者皆為必要參數。

Corr¶

class Corr(y, x, filter=None, default=None)¶

傳回相關係數，型別為 float，如果沒有任何符合的列則傳回 default。

CovarPop¶

class CovarPop(y, x, sample=False, filter=None, default=None)¶

傳回母體共變異數，型別為 float，如果沒有任何符合的列則傳回 default。

sample¶

可選。預設情況下，CovarPop 傳回一般母體共變異數。但是，如果 sample=True，則傳回值將為樣本母體共變異數。

RegrAvgX¶

class RegrAvgX(y, x, filter=None, default=None)¶

傳回自變數的平均值 (sum(x)/N)，型別為 float，如果沒有任何符合的列則傳回 default。

RegrAvgY¶

class RegrAvgY(y, x, filter=None, default=None)¶

傳回應變數的平均值 (sum(y)/N)，型別為 float，如果沒有任何符合的列則傳回 default。

RegrCount¶

class RegrCount(y, x, filter=None)¶

傳回一個 int，表示兩個運算式皆不為 null 的輸入列數量。

注意

不支援 default 參數。

RegrIntercept¶

class RegrIntercept(y, x, filter=None, default=None)¶

傳回由 (x, y) 對所確定的最小平方法線性方程式的 y 軸截距，型別為 float，如果沒有任何符合的列則傳回 default。

RegrR2¶

class RegrR2(y, x, filter=None, default=None)¶

傳回相關係數的平方，型別為 float，如果沒有任何符合的列則傳回 default。

RegrSlope¶

class RegrSlope(y, x, filter=None, default=None)¶

傳回由 (x, y) 對所確定的最小平方法線性方程式的斜率，型別為 float，如果沒有任何符合的列則傳回 default。

RegrSXX¶

class RegrSXX(y, x, filter=None, default=None)¶

傳回 sum(x^2) - sum(x)^2/N （自變數的「平方和」），型別為 float，如果沒有任何符合的列則傳回 default。

RegrSXY¶

class RegrSXY(y, x, filter=None, default=None)¶

以 float 形式回傳 sum(x*y) - sum(x) * sum(y)/N （獨立變數與相依變數的「乘積總和」），若沒有符合的列則回傳 default。

RegrSYY¶

class RegrSYY(y, x, filter=None, default=None)¶

以 float 形式回傳 sum(y^2) - sum(y)^2/N （相依變數的「平方總和」），若沒有符合的列則回傳 default。