Условные выражения ¶
Условные выражения позволяют использовать 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
¶
-
class
When
( условие = Нет , затем = Нет , ** поиск ) ¶
When()
Объект используется для инкапсуляции состояния и его результат для использования в условном выражении. Использование When()
объекта аналогично использованию filter()
метода. Условие может быть определено с помощью поля Lookups ,
Q
объекты или Expression
объекты , которые имеют output_field
то есть
BooleanField
. Результат предоставляется с использованием
then
ключевого слова.
Несколько примеров:
>>> 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)
Добавлена поддержка использования condition
аргумента с lookups
.
Case
¶
-
класс
Case
( * кейсы , ** экстра ) ¶
Case()
Выражение как if
... elif
...
else
заявление в Python
. Каждый condition
из предоставленных
When()
объектов оценивается по порядку, пока не будет получено истинное значение. result
Выражение из согласующего When()
объекта возвращается.
Пример:
>>>
>>> from datetime import date, timedelta
>>> from django.db.models import Case, 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%'),
... ),
... ).values_list('name', 'discount')
<QuerySet [('Jane Doe', '0%'), ('James Smith', '5%'), ('Jack Black', '10%')]>
Case()
принимает любое количество When()
объектов в качестве индивидуальных аргументов. Другие параметры предоставляются с использованием аргументов ключевого слова. Если ни одно из условий не соответствует TRUE
, то 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%'),
... )
... ).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')]>
Условное агрегирование ¶
Что, если мы хотим узнать, сколько клиентов у каждого
account_type
? Для этого мы можем использовать 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
)