Django筆記二十三之case、when操作條件表示式搜尋、更新等操作

XHunter發表於2023-04-13

本文首發於公眾號:Hunter後端
原文連結:Django筆記二十三之條件表示式搜尋、更新等操作

這一篇筆記將介紹條件表示式,就是如何在 model 的使用中根據不同的條件篩選資料返回。

這個操作類似於資料庫中 if elif else 的邏輯。

以下是本篇筆記的目錄:

  1. model 和資料準備
  2. When 和 Case 操作新增欄位返回
  3. 條件搜尋
  4. 條件更新
  5. 條件聚合

1、model 和資料準備

這篇筆記我們用到的 model 是 Client,放在 blog/models.py 下

以下是 Client 的 model 定義:

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,
    )

其中 choices 的操作在前面欄位型別中都有介紹到,這裡不再贅述。

然後 migrate 相關操作這裡不多說了,接下來插入一些資料,在 shell 中執行:

from blog.models import Client

Client.objects.create(name="client_1", registered_on="2020-01-01", account_type="R")
Client.objects.create(name="client_2", registered_on="2021-07-12", account_type="G")
Client.objects.create(name="client_3", registered_on="2022-09-20", account_type="P")
Client.objects.create(name="client_4", registered_on="2022-12-07", account_type="P")

接下來介紹我們操作的知識點。

2、When 和 Case 操作新增欄位返回

我們使用的條件表示式使用的 When 和 Case 的函式,這個其實就對應於 SQL 裡的 CASE 和 WHEN 函式。

我們先來說一下需求,我們在獲取 Client 資料的時候,想要知道這條資料 registered_on 日期欄位所在的季節,比如 1月就是 Spring,7月就是 Autumn。

怎麼處理呢?

很簡單,先獲取 Client 資料,然後根據 registered_on 欄位判斷月份,比如在 1,2,3 之間就是 Spring。

這種方法是可行的,但是如果我們有另一個需求,比如說想要篩選出所有季節為 Spring 的資料呢

(這個例子其實不太恰當,因為這種操作,我們可以直接透過 filter(registered_on__month__in=[1,2,3])來篩選,但是這裡我們強行要求使用filter(季節='Spring')的這種形式來操作)

那麼這時候就可以用上我們的 When Case 的用法了。

在下面的操作中,我們透過判斷 registered_on 欄位的月份區間來得到一個新的欄位:

from django.db.models import Case, Value, When
from blog.models import Client

results = Client.objects.annotate(
	season=
		Case(
    		When(registered_on__month__in=[1,2,3], then=Value("Spring")),
    		When(registered_on__month__in=[4,5,6], then=Value("Summer")),
    		When(registered_on__month__in=[7,8,9], then=Value("Autumn")),
    		When(registered_on__month__in=[10,11,12], then=Value("Winter")),
    		default=Value("Spring")
		)
	)

在上面的程式碼中,我們透過 annotate() 來新建一個 season 欄位,這個欄位的值是根據 registered_on 的月份所在區間來為 season 賦值。

Case() 函式內包含了四種 When 的可能性,然後會有一個 default 預設值

在每一個 When() 函式里,前一個是個表示式,可以是這種形式,也可以是 Q() 操作的語句,then= 表示如果滿足前面的表示式,那麼值的內容將會是後面的值。

在值的定義裡,我們這裡用到了 Value() 函式,Value() 表示其值是一個字串。

獲取欄位值

如果該欄位取值是獲取某個欄位的內容,比如 Client 裡的 name 欄位,就不需要 Value() 函式來操作,可以直接使用:

When(registered_on__month__in=[1,2,3], then="name")

或者透過 F() 函式來取欄位值:

from django.db.models import F
When(registered_on__month__in=[1,2,3], then=F("name"))

在不需要對欄位內容進行操作的情況下,上面兩條命令的作用是一樣的

3、條件搜尋

還是前面的需求,我們需要對 Client 的資料進行資料篩選,篩選出 season 為 Spring 的資料,可以在上面的操作中接著 filter():

results = Client.objects.annotate(
	season=
		Case(
    		When(registered_on__month__in=[1,2,3], then=Value("Spring")),
    		When(registered_on__month__in=[4,5,6], then=Value("Summer")),
    		When(registered_on__month__in=[7,8,9], then=Value("Autumn")),
    		When(registered_on__month__in=[10,11,12], then=Value("Winter")),
    		default=Value("Spring")
		)
	).filter(season="Spring")

根據條件進行filter

對於 Client 這個 model,我們想實現這樣的搜尋條件:

如果 account_type 的值為 Client.GOLD,則 registered_on 欄位搜尋一個月以前的資料

如果 account_type 的值為 Client.PLATINUM,則 registered_on 欄位搜尋一年前的資料

對於這個需求,在之前我們怎麼做?
使用 Q() 語法來連線:

from blog.models import Client
from datetime import date, timedelta
from django.db.models import Q

a_month_ago = date.today() - timedelta(days=30)
a_year_ago = date.today() - timedelta(days=365)


condition = (Q(account_type=Client.GOLD) & Q(registered_on__lte=a_month_ago))| \
	(Q(account_type= Client.PLATINUM) & Q(registered_on__lte= a_year_ago)) 

Client.objects.filter(condition)

在這裡,如果用到我們的 Case 和 When 的函式也是可以的:

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)
	)
)

一個例子

之前我在工作中遇到這樣一種需求,假設有一個 TestModel,有一個 field_1 的欄位,他的值被有 A, B, C 三種或者還有其他的值,但其他的值我們不關心

現在需要將資料按照 B,C,A 的順序返回結果,那麼這裡用到 Case 和 When 的處理方法就可以,我們可以透過條件得出一個新的欄位 priority,然後 order_by("priority") 即可

處理如下:

TestModel.objects.annotate(
	priority=Case(
    	When(field_1="B", then=1),
	    When(field_1="C", then=2),
    	When(field_1="A", then=3),
    	default=4
	)
).order_by("priority")

4、條件更新

除了前面對資料進行條件的篩選,我們還可以根據條件來對資料進行更新

假設現在需求是對 registered_on 欄位的年份進行條件更新:
年份為 2020年的 account_type 欄位內容變為 Client.PLATINUM
年份為 2021年的 account_type 欄位內容變為 Client.REGULAR

那麼相應的程式碼應該如下:

Client.objects.update(
    account_type=Case(
        When(registered_on__year=2020, then=Value(Client.PLATINUM)),
        When(registered_on__year=2021, then=Value(Client.REGULAR)),
        default=Value(Client.GOLD)
    )
)

需要注意的是,在上面的程式碼中我們沒有針對資料進行 filter() 操作,所以作用的是全表資料,其他非 2020 和 2021 年份的資料也會被更新,如果僅希望操作 2020 和 2021 年的資料,可以加上 filter() 的條件限制:

Client.objects.filter(registered_on__year__in=[2020, 2021]).update(
    account_type=Case(
        When(registered_on__year=2020, then=Value(Client.PLATINUM)),
        When(registered_on__year=2021, then=Value(Client.REGULAR)),
        default=Value(Client.GOLD)
    )
)

5、條件聚合

我們現在需要對資料根據條件進行聚合操作,比如 Client 這個 model,我們對其按照 account_type 分組,獲取各自的總數。

程式碼如下:

from django.db.models import Count, Q

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': 1, 'gold': 0, 'platinum': 3}

這個操作對應於 MySQL 中的語句如下:

select count(CASE WHEN account_type='R' THEN id ELSE null end) as regular,
       count(CASE WHEN account_type='G' THEN id ELSE null end) as gold,
       count(CASE WHEN account_type='P' THEN id ELSE null end) as platinum
FROM blog_client;

我們也可以根據另一種方式來獲取各自的總數資料,但是返回的結構是不一樣的:

Client.objects.values("account_type").annotate(count=Count("account_type"))

返回的結果形式為:

<QuerySet [{'account_type': 'P', 'count': 3}, {'account_type': 'R', 'count': 1}]>

以上就是本篇筆記關於條件表示式的全部內容,在接下來幾篇筆記中將會介紹 model 的資料庫函式,大致的內容會是比較和轉換函式、日期函式、資料公式、文字函式等。

如果想獲取更多後端相關文章,可掃碼關注閱讀:
image

相關文章