Условные выражения ¶
Условные выражения позволяют использовать логику if
... elif
... else
внутри фильтров, аннотаций, агрегатов и обновлений. Условное выражение оценивает серию условий для каждой строки в таблице и возвращает соответствующее результирующее выражение. Условные выражения также можно комбинировать и вкладывать, как любое другое выражение .
Классы условных выражений ¶
В следующих примерах мы будем использовать следующую модель:
from django.db import models
class Client(models.Model):
REGULAR = 'R'
GOLD = 'G'
PLATINUM = 'P'
ACCOUNT_TYPE_CHOICES = [
(REGULAR, 'Regular'),
(GOLD, 'Gold'),
(PLATINUM, 'Platinum'),
]
name = models.CharField(max_length=50)
registered_on = models.DateField()
account_type = models.CharField(
max_length=1,
choices=ACCOUNT_TYPE_CHOICES,
default=REGULAR,
)
When
¶
-
класс
When
( состояние = None , то = None , ** поиски ) ¶
Объект When()
используется для заключения условия и его результатов для их использования в условное выражение. When()
Использование объекта аналогично использованию метода filter()
. Условие можно указать с помощью объектов поиска по полю , объектов Q
или объектов Expression
, результат которых output_field
равен единице BooleanField
. Результат предоставляется с использованием ключевого слова then
.
Expression
Добавлена поддержка логических значений.
Некоторые примеры :
>>> from django.db.models import F, Q, When
>>> # String arguments refer to fields; the following two examples are equivalent:
>>> When(account_type=Client.GOLD, then='name')
>>> When(account_type=Client.GOLD, then=F('name'))
>>> # You can use field lookups in the condition
>>> from datetime import date
>>> When(registered_on__gt=date(2014, 1, 1),
... registered_on__lt=date(2015, 1, 1),
... then='account_type')
>>> # Complex conditions can be created using Q objects
>>> When(Q(name__startswith="John") | Q(name__startswith="Paul"),
... then='name')
>>> # Condition can be created using boolean expressions.
>>> from django.db.models import Exists, OuterRef
>>> non_unique_account_type = Client.objects.filter(
... account_type=OuterRef('account_type'),
... ).exclude(pk=OuterRef('pk')).values('pk')
>>> When(Exists(non_unique_account_type), then=Value('non unique'))
Помните, что каждое из этих значений само по себе может быть выражением.
Заметка
Поскольку именованный параметр then
зарезервирован для результата выражения When()
, существует потенциальный конфликт, если a Model
имеет именованное поле then
. Это можно решить двумя способами:
>>> When(then__exact=0, then=1)
>>> When(Q(then=0), then=1)
Case
¶
-
класс
Case
( * кейсы , ** экстра ) ¶
Выражение Case()
похоже на инструкцию if
... elif
... else
в Python. Каждый condition
в When()
предоставленных объектах оценивается по порядку, пока один из них не даст истинное значение. Возвращается выражение result
для When()
соответствующего объекта .
Пример :
>>>
>>> from datetime import date, timedelta
>>> from django.db.models import Case, CharField, Value, When
>>> Client.objects.create(
... name='Jane Doe',
... account_type=Client.REGULAR,
... registered_on=date.today() - timedelta(days=36))
>>> Client.objects.create(
... name='James Smith',
... account_type=Client.GOLD,
... registered_on=date.today() - timedelta(days=5))
>>> Client.objects.create(
... name='Jack Black',
... account_type=Client.PLATINUM,
... registered_on=date.today() - timedelta(days=10 * 365))
>>> # Get the discount for each Client based on the account type
>>> Client.objects.annotate(
... discount=Case(
... When(account_type=Client.GOLD, then=Value('5%')),
... When(account_type=Client.PLATINUM, then=Value('10%')),
... default=Value('0%'),
... output_field=CharField(),
... ),
... ).values_list('name', 'discount')
<QuerySet [('Jane Doe', '0%'), ('James Smith', '5%'), ('Jack Black', '10%')]>
Case()
принимает любое количество объектов в When()
качестве индивидуальных параметров. Другие параметры представлены как именованные параметры. Если ни одно из оцененных условий не приводит к истинному значению, default
возвращается выражение, указанное в названном параметре . Если параметр default
не указан, None
используется именно он.
Если бы мы хотели изменить наш предыдущий запрос, чтобы получить скидку на основе лояльности Client
, мы могли бы сделать это с помощью поисковых выражений:
>>> a_month_ago = date.today() - timedelta(days=30)
>>> a_year_ago = date.today() - timedelta(days=365)
>>> # Get the discount for each Client based on the registration date
>>> Client.objects.annotate(
... discount=Case(
... When(registered_on__lte=a_year_ago, then=Value('10%')),
... When(registered_on__lte=a_month_ago, then=Value('5%')),
... default=Value('0%'),
... output_field=CharField(),
... )
... ).values_list('name', 'discount')
<QuerySet [('Jane Doe', '5%'), ('James Smith', '0%'), ('Jack Black', '10%')]>
Заметка
Помните, что условия оцениваются по порядку, поэтому в приведенном выше примере мы получаем правильный результат, даже если второе условие соответствует как Джейн Доу, так и Джеку Блэку. Это работает точно так же, как расследование if
... elif
... else
в Python.
Case()
также работает в статье filter()
. Например, чтобы найти всех «золотых» клиентов, которые зарегистрировались более месяца назад, и «платиновых» клиентов, которые подписались более года назад:
>>> a_month_ago = date.today() - timedelta(days=30)
>>> a_year_ago = date.today() - timedelta(days=365)
>>> Client.objects.filter(
... registered_on__lte=Case(
... When(account_type=Client.GOLD, then=a_month_ago),
... When(account_type=Client.PLATINUM, then=a_year_ago),
... ),
... ).values_list('name', 'account_type')
<QuerySet [('Jack Black', 'P')]>
Расширенные запросы ¶
Условные выражения можно использовать в аннотациях, агрегатах, фильтрах, поиске и обновлениях. Их также можно комбинировать и вкладывать в другие выражения. Это позволяет выполнять мощные условные запросы.
Условное обновление ¶
Допустим, мы хотим изменить тип учетной записи account_type
наших клиентов в соответствии с датами регистрации. Мы можем сделать это с помощью условного выражения и метода update()
:
>>> a_month_ago = date.today() - timedelta(days=30)
>>> a_year_ago = date.today() - timedelta(days=365)
>>> # Update the account_type for each Client from the registration date
>>> Client.objects.update(
... account_type=Case(
... When(registered_on__lte=a_year_ago,
... then=Value(Client.PLATINUM)),
... When(registered_on__lte=a_month_ago,
... then=Value(Client.GOLD)),
... default=Value(Client.REGULAR)
... ),
... )
>>> Client.objects.values_list('name', 'account_type')
<QuerySet [('Jane Doe', 'G'), ('James Smith', 'R'), ('Jack Black', 'P')]>
Условное агрегирование ¶
Что, если бы мы хотели узнать, сколько клиентов имеет каждый тип учетной записи? Мы можем использовать параметр filter
из агрегатных функций , чтобы быть в состоянии сделать это:
>>> # Create some more Clients first so we can have something to count
>>> Client.objects.create(
... name='Jean Grey',
... account_type=Client.REGULAR,
... registered_on=date.today())
>>> Client.objects.create(
... name='James Bond',
... account_type=Client.PLATINUM,
... registered_on=date.today())
>>> Client.objects.create(
... name='Jane Porter',
... account_type=Client.PLATINUM,
... registered_on=date.today())
>>> # Get counts for each value of account_type
>>> from django.db.models import Count
>>> Client.objects.aggregate(
... regular=Count('pk', filter=Q(account_type=Client.REGULAR)),
... gold=Count('pk', filter=Q(account_type=Client.GOLD)),
... platinum=Count('pk', filter=Q(account_type=Client.PLATINUM)),
... )
{'regular': 2, 'gold': 1, 'platinum': 3}
Этот агрегат создает запрос с синтаксисом SQL 2003 для поддерживающих его баз данных:FILTER WHERE
SELECT count('id') FILTER (WHERE account_type=1) as regular,
count('id') FILTER (WHERE account_type=2) as gold,
count('id') FILTER (WHERE account_type=3) as platinum
FROM clients;
Для других баз данных этот эффект эмулируется с помощью оператора CASE
:
SELECT count(CASE WHEN account_type=1 THEN id ELSE null) as regular,
count(CASE WHEN account_type=2 THEN id ELSE null) as gold,
count(CASE WHEN account_type=3 THEN id ELSE null) as platinum
FROM clients;
Два оператора SQL функционально эквивалентны, но FILTER
более явный вариант может обеспечить лучшую производительность.
Условный фильтр ¶
Когда условное выражение возвращает логическое значение, его можно использовать непосредственно в фильтрах. Это означает, что он не будет добавлен в столбцы SELECT
, но его все еще можно использовать для фильтрации результатов.
>>> non_unique_account_type = Client.objects.filter(
... account_type=OuterRef('account_type'),
... ).exclude(pk=OuterRef('pk')).values('pk')
>>> Client.objects.filter(~Exists(non_unique_account_type))
В терминах SQL это дает:
SELECT ...
FROM client c0
WHERE NOT EXISTS (
SELECT c1.id
FROM client c1
WHERE c1.account_type = c0.account_type AND NOT c1.id = c0.id
)