Django の QuerySet を使った絞り込み(フィルタリング)操作をいろいろ試したので、学んだことをまとめておく。
前提: 使ったモデル
class Students(models.Model):
name = models.CharField(max_length=20)
age = models.IntegerField()
major = models.CharField(max_length=20)
school = models.ForeignKey('Schools', on_delete=models.PROTECT, related_name='students')
prefecture = models.ForeignKey('Prefectures', on_delete=models.CASCADE)
class Person(BaseMeta):
first_name = models.CharField(max_length=30)
last_name = models.CharField(max_length=30)
birthday = models.DateField(default=date(1900, 1, 1))
email = models.EmailField(db_index=True)
salary = models.FloatField(null=True)
memo = models.TextField()
web_site = models.URLField(null=True)
スクリプト側は Django アプリの外から ORM を使うため、以下のおまじないが先頭に必要だった。
import os
os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'ModelProject.settings')
from django import setup
setup()
スライスで件数を絞る
Students.objects.all() # 全件
Students.objects.all()[:5] # 先頭5件
Students.objects.all()[5:] # 5件目以降
Students.objects.all()[5:8] # 6〜8件目
Students.objects.first() # 先頭の1件
QuerySet はスライスできて、内部的には SQL の LIMIT/OFFSET に変換される。.query を print すると実際に発行される SQL が確認できて、動きを理解する上で便利だった。
print(Students.objects.all()[5:8].query)
filter() で条件を絞り込む
filter() にキーワード引数を渡すと、複数条件は AND で連結される。
# name が完全一致
Students.objects.filter(name="太郎").all()
# AND条件(カンマ区切り)
Students.objects.filter(name="太郎", pk__gt=9).all()
# 範囲指定(以上・以下)
Students.objects.filter(name="次郎", pk__gte=5, pk__lte=12).all()
__gt / __gte / __lte のような フィールド名__ルックアップ の書き方で比較演算ができる。他にも以下を確認した。
-
__startswith: 前方一致 -
__endswith: 後方一致 -
__contains: 部分一致 -
__in: リストに含まれるか(SQL のIN) -
__isnull: NULL かどうか
Students.objects.filter(name__startswith='太').all()
Students.objects.filter(name__endswith='郎').all()
Students.objects.filter(name__contains='三').all()
ids = [3, 5, 7]
Students.objects.filter(pk__in=ids).all()
Person.objects.filter(salary__isnull=True).all()
Q オブジェクトで OR 条件
filter() にキーワード引数を並べただけでは AND にしかならないので、OR を書きたいときは django.db.models.Q を使う。
from django.db.models import Q
Students.objects.filter(Q(name='太郎') | Q(pk__gt=10)).all()
Q(...) を |(OR)や &(AND)で組み合わせられる。複雑な条件をまとめて書きたいときに重宝しそう。
exclude() で除外する
filter() の逆で、条件に一致する行を除外したいときは exclude() を使う。
Students.objects.exclude(name='太郎').all()
.query で確認すると、WHERE NOT (...) のような SQL が発行されていた。
values() で一部のカラムだけ取得する
デフォルトではモデルインスタンスのリストが返るが、values() を使うと辞書のリスト(dict を要素に持つ QuerySet)として、指定したカラムだけ取得できる。
students = Students.objects.values('name', 'age').all()
for student in students:
print(student['name'])
必要なカラムだけ SELECT するので、余計なデータを取ってこなくて済む。
order_by() で並び替え
Students.objects.order_by('-name', 'id').all()
- フィールド名をそのまま渡すと昇順
- 先頭に
-を付けると降順 - カンマ区切りで複数指定すると、優先順位付きのソート(この例だと
nameの降順を優先しつつ、同じnameならidの昇順)になる
インスタンス作成〜保存のメモ
ついでに Person のインスタンスを作って save() する流れも確認した。
from datetime import date
person = Person(
first_name='Jiro',
last_name='Yamada',
birthday=date(2000, 1, 1),
email='aa@mail.com',
salary=None,
memo='memo taro',
web_site='http://taro.com',
)
person.save()
salary は null=True なので None を渡せる。この状態のレコードを salary__isnull=True で絞り込めることも上で確認済み。
まとめ
今回触ったルックアップ・メソッドを一覧にすると以下の通り。
| 操作 | 意味 |
|---|---|
filter(field=value) |
完全一致(複数条件は AND) |
filter(field__gt=x) / __gte / __lt / __lte
|
比較演算 |
filter(field__startswith=x) / __endswith
|
前方一致・後方一致 |
filter(field__contains=x) |
部分一致 |
filter(field__in=[...]) |
IN 句 |
filter(field__isnull=True) |
NULL 判定 |
Q(...) | Q(...) |
OR 条件 |
exclude(...) |
条件に一致しないものを取得 |
values('a', 'b') |
指定カラムのみ辞書で取得 |
order_by('-a', 'b') |
並び替え(- で降順) |
.query を print して実際の SQL を都度確認する癖をつけると、ORM が裏で何をしているか理解しやすかった。