リレーションまとめ

Model の実装例

from django.db import models


class Publisher(models.Model):
    """出版社モデル"""
    class Meta:
        db_table = 'publisher'

    name = models.CharField(verbose_name='出版社名', max_length=255)

    def __str__(self):
        return self.name


class Author(models.Model):
    """著者モデル"""
    class Meta:
        db_table = 'author'

    name = models.CharField(verbose_name='著者名', max_length=255)

    def __str__(self):
        return self.name


class Book(models.Model):
    """本モデル"""
    class Meta:
        """
        対応するテーブルや、複数カラムに対するインデックスやユニーク制約などの
        モデル全体に対する付加情報を記述する
        """
        # テーブル名を定義
        # 定義しないと、 `アプリケーション名_モデルのクラス名をスネークケースにした文字列` がテーブル名になる
        db_table = 'book'

    title = models.CharField(
        verbose_name='タイトル',  # フィールド名
        max_length=255,  # 文字列の最大文字数
        # choices: フォーム利用時にセレクトボックスに表示する選択肢
        # validators: 文字種チェックなどのバリデーションを指定
        error_messages={'invalid': 'title ちがうよー'}  # バリデーションNGの場合のエラーメッセージ
    )
    publisher = models.ForeignKey(
        # 多対一のリレーション: 多側に ForeignKey をくっつける
        Publisher, verbose_name='出版社',
        # ForeignKey と OneToOneField には on_delete をつける癖をつけよう
        on_delete=models.PROTECT,  # 自身のレコードは削除されない
    )
    authors = models.ManyToManyField(
        # 多対多のリレーション: 一方のモデルに ManyToManyField をくっつける
        #   * マイグレーション実行すると Django が自動的に中間テーブルを作成してくれる
        Author, verbose_name='著者'
    )
    price = models.IntegerField(
        verbose_name='価格',
        null=True,       # NULL制約
        unique=False,    # ユニーク制約
        blank=True,      # フォーム利用時に入力必須にするかどうか
        db_index=False,  # DB のインデックスを設定するかどうか
        default=0,       # レコード登録時に値が指定されなかったときのデフォルト値
    )
    description = models.TextField(verbose_name='概要', null=True, blank=True)
    publisher_date = models.DateField(verbose_name='出版日')

    def __str__(self):
        # 管理サイトに表示されるよ
        return self.title


class BookStock(models.Model):
    """本の在庫モデル"""
    book = models.OneToOneField(
        # 一対一のリレーション: どちらか一方のテーブルに OneToOneField をくっつける
        Book, verbose_name='本',
        on_delete=models.CASCADE  # 自身のレコードも削除される
    )
    quantity = models.IntegerField(verbose_name='在庫数', default=0)

on_delete

ForeignKey.on_delete

• 6種類くらいあって、用途に応じて選べる

• Django 2.0 から、必須の引数となる

• それ以前のバージョンでは、デフォルトで CASCADE

UserManager

• Django documentation > django.contrib.auth > マネージャメソッド

• Django documentation > Django の認証方法のカスタマイズ > 完全な具体例

• https://github.com/django/django/blob/master/django/contrib/auth/models.py#L131

• こうすると登録できる

  objects = MyUserManager()
  

• TODO: これは Model のところじゃなくて、認証のところかもしれない。いったんここに置いておく。

1件だけ取得する

User.objects.get()  # この `objects` がモデルマネージャー

• モデルが返る

• 1件も見つからないと DoesNotExist

• 2件以上見つかると MultipleObjectsReturn

全件取得する

User.objects.all()

• 即座にデータベースにはアクセスせず、クエリセットオブジェクトを返す

• しかるべきタイミングでデータベースアクセスする = 遅延評価

• 1件も見つからなくても例外発生しない、空のリストを返す

検索条件をつけて取得する

User.objects.filter(is_active=True)

• 即座にデータベースにはアクセスせず、クエリセットオブジェクトを返す

• filter() を何度も繋げて書ける

keyword = request.GET.get('keyword')
queryset = Book.objects.filter()
if keyword:
    queryset = queryset.filter(title=keyword)

# ここでクエリが発行される (print すると発行される)
print(queryset)

AND 条件

Book.objects.filter(title='Django Book', price=1000)

• 検索条件を列挙すれば AND 条件

OR 条件

from django.db.models import Q
Book.objects.filter(Q(title='Django Book') | Q(price=1000))

• Q と | (パイプ) を使う

>, <, >=, <=

Book.objects.filter(price__gt=1000)  # >1000
Book.objects.filter(price__lt=1000)  # <1000
Book.objects.filter(price__gte=1000)  # >=1000
Book.objects.filter(price__lte=1000)  # <=1000

• __ (アンダーバー2つ) でフィールド名とキーワード (gt, lt, gte, lte) をつなぐ

IN

Book.objects.filter(price__in=[900, 1000])  # IN(900, 1000)

• __ (アンダーバー2つ) でフィールド名とキーワード (in) をつなぐ

• IN 句の中身はリストで書く

LIKE

Book.objects.filter(title__icontains='Django')  # ILIKE '%Django%'
Book.objects.filter(title__contains='Django')  # LIKE '%Django%'

• __ (アンダーバー2つ) でフィールド名とキーワード (icontains, contains) をつなぐ

• 大文字と小文字を区別しない: icontains

• 大文字と小文字を区別する: contains

EXISTS

• exists: レコードが存在するか否か True/False で返す

Book.objects.all().exists()
Book.objects.filter(title__icontains='Django').exists()

ORDER BY

• order_by:

# 降順はフィールド名の前に ``-`` つける
Book.objects.all().order_by('-price')

# 複数フィールドでソートするときはカンマ区切り
Book.objects.all().order_by('price', 'publish_date')

Q Object

• Q オブジェクトを用いた複雑な検索

リレーション先のモデルを使った条件検索

Book.objects.filter(publisher__name='自費出版社')

• OneToOneField, ForeignKey, ManyToManyField でリレーションしていると、 リレーションつけたフィールド名__リレーション先モデルのフィールド名 で JOIN できる

モデルクラス名を全部小文字にしたのに _set がつく

Related objects reference

• _set というのは子テーブルのデータを参照する django の機能

• モデルクラス名を全部小文字にしたのに _set がつく

values() と values_list()

aggregate と annotate

aggregate と annotate の違いがわかりやすい

• Djangoの集計について

LEFT OUTER JOIN

Django のクエリセットは LEFT OUTER JOIN を表現できない

• SQLAlchemy でやろう

select_related, prefetch_related

Book.objects.all().select_related('publisher')

Book.objects.all().prefetch_related('authors')

• クエリの本数を減らそう!

  • N+1問題

  • 特にリレーションを持ったモデルの検索結果 (クエリセットオブジェクト) をループ処理する場合に起こりがち

  • 後続の処理で何度もアクセスされそうなオブジェクトに対して前もって処理を施しておくことでクエリの本数を減らそう

  • その他参考: 偏った言語信者の垂れ流し > Djangoでprefetch_relatedを使ってクエリ数を減らす

遅延評価

クエリセットを返す all() や filter() がクエリを発行するタイミング (データベースアクセスするタイミング) はこれら

• for ループなどイテレーションが開始されたタイミング

• [] を使ってスライスしたタイミング

  • [0:5] のように範囲指定するとクエリは即時発行されない

• オブジェクトを直列化したタイミング

• オブジェクトを REPL や print() で表示したタイミング

• len() でサイズを取得したタイミング

• list() で強制的にリストに変換したタイミング

• bool() で強制的に Boolean に変換したタイミング

トランザクション

• デフォルト設定では、オブジェクトの保存・更新・削除は即時反映 (実行した時点でデータベースに反映される)

• トランザクションの範囲指定する場合は、

  from django.db import transaction
  with transaction.atomic():
      User(username='fumi23').save()
      User(username='fumi23').save()
  

• トランザクションのデフォルト設定を変更できる

  • settings.py

    DATABASES = [
        'default': {
            # リクエストの開始から終了までに設定
            'ATOMIC_REQUESTS': True,
        }
    ]
    

select_for_update()

https://docs.djangoproject.com/ja/2.2/ref/models/querysets/#django.db.models.query.QuerySet.select_for_update

• select_for_update は transaction.atomic ブロック内で使いましょう

  • 自動コミットモードでクエリセットを評価すると、行ロックされないため TransactionManagementError が発生します

• select_for_update のタイムアウトエラー (他のトランザクションにロックがとられていて待ち時間内にロックが取得できなかった) は OperationalError が発生しますが、キャッチするのはその親の DatabaseError にしましょう

• MySQL の場合、 nowait および skip_locked 引数は MySQL 8.0.1+ でのみサポートされています。