diff options
| author | Étienne Beaulé <beauleetienne0@gmail.com> | 2019-07-30 20:08:55 +0200 |
|---|---|---|
| committer | Mariusz Felisiak <felisiak.mariusz@gmail.com> | 2019-07-31 11:22:50 +0200 |
| commit | 5f24e7158e1d5a7e40fa0ae270639f6a171bb18e (patch) | |
| tree | 36b249e5a101df5f3494be9000db857e5af9c3d1 /docs | |
| parent | cb3c2da12858004c805fc511a9c2eb0f91fb73c7 (diff) | |
Fixed #30665 -- Added support for distinct argument to Avg() and Sum().
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/ref/models/querysets.txt | 28 | ||||
| -rw-r--r-- | docs/releases/3.0.txt | 3 |
2 files changed, 29 insertions, 2 deletions
diff --git a/docs/ref/models/querysets.txt b/docs/ref/models/querysets.txt index f84097ae96..409d8f0f29 100644 --- a/docs/ref/models/querysets.txt +++ b/docs/ref/models/querysets.txt @@ -3378,7 +3378,7 @@ by the aggregate. ``Avg`` ~~~~~~~ -.. class:: Avg(expression, output_field=None, filter=None, **extra) +.. class:: Avg(expression, output_field=None, distinct=False, filter=None, **extra) Returns the mean value of the given expression, which must be numeric unless you specify a different ``output_field``. @@ -3387,6 +3387,18 @@ by the aggregate. * Return type: ``float`` if input is ``int``, otherwise same as input field, or ``output_field`` if supplied + Has one optional argument: + + .. attribute:: distinct + + If ``distinct=True``, ``Avg`` returns the mean value of unique values. + This is the SQL equivalent of ``AVG(DISTINCT <field>)``. The default + value is ``False``. + + .. versionchanged:: 3.0 + + Support for ``distinct=True`` was added. + ``Count`` ~~~~~~~~~ @@ -3451,13 +3463,25 @@ by the aggregate. ``Sum`` ~~~~~~~ -.. class:: Sum(expression, output_field=None, filter=None, **extra) +.. class:: Sum(expression, output_field=None, distinct=False, filter=None, **extra) Computes the sum of all values of the given expression. * Default alias: ``<field>__sum`` * Return type: same as input field, or ``output_field`` if supplied + Has one optional argument: + + .. attribute:: distinct + + If ``distinct=True``, ``Sum`` returns the sum of unique values. This is + the SQL equivalent of ``SUM(DISTINCT <field>)``. The default value is + ``False``. + + .. versionchanged:: 3.0 + + Support for ``distinct=True`` was added. + ``Variance`` ~~~~~~~~~~~~ diff --git a/docs/releases/3.0.txt b/docs/releases/3.0.txt index 4bfebba73b..da1578c0eb 100644 --- a/docs/releases/3.0.txt +++ b/docs/releases/3.0.txt @@ -291,6 +291,9 @@ Models customize the get and set behavior by overriding their :py:ref:`descriptors <descriptors>`. +* :class:`~django.db.models.Avg` and :class:`~django.db.models.Sum` now support + the ``distinct`` argument. + Requests and Responses ~~~~~~~~~~~~~~~~~~~~~~ |