Django モデル: チュートリアル、ヒント、ベストプラクティス

Django チュートリアル: モデル

このチュートリアルでは、モデルの基本的な概念と、Django でモデルを作成、使用、管理する方法について説明します。

モデルを作成するには、models.py ファイルに Python クラスを作成します。クラス名は、モデルを表す単数名詞にするのが一般的です。

class Book(models.Model):
    title = models.CharField(max_length=255)
    author = models.CharField(max_length=255)
    pub_date = models.DateField()

この例では、Book というモデルを作成しました。このモデルには、title、author、pub_date という 3 つのフィールドがあります。

• title は、最大 255 文字の文字列フィールドです。
• pub_date は、日付フィールドです。

モデルの使用

モデルを作成したら、Django の ORM (Object-Relational Mapping) を使用してデータベースとやり取りできます。

• オブジェクトを作成するには、Model.objects.create() メソッドを使用します。

book = Book.objects.create(title="The Hitchhiker's Guide to the Galaxy", author="Douglas Adams", pub_date="1979-10-12")

book = Book.objects.get(pk=1)

• オブジェクトを更新するには、Model.save() メソッドを使用します。

book.title = "The Hitchhiker's Guide to the Galaxy: 42nd Anniversary Edition"
book.save()

book.delete()

モデルの管理

Django は、モデルを管理するための便利なツールを提供しています。

• makemigrations コマンドを使用して、モデルの変更をデータベーススキーマに反映します。

python manage.py makemigrations

• migrate コマンドを使用して、データベーススキーマを更新します。

python manage.py migrate

• shell コマンドを使用して、Django シェルでモデルを操作できます。

python manage.py shell

モデルの詳細

Django モデルには、他にも多くの機能があります。詳細については、次のリソースを参照してください。

Django モデルは、データベースとのやり取りを抽象化し、データへのアクセスを容易にする強力なツールです。このチュートリアルでは、モデルの基本的な概念と、Django でモデルを作成、使用、管理する方法について説明しました。

Django モデルのサンプルコード

モデルの作成

class Book(models.Model):
    title = models.CharField(max_length=255)
    author = models.CharField(max_length=255)
    pub_date = models.DateField()

class Author(models.Model):
    name = models.CharField(max_length=255)
    birth_date = models.DateField()

class Publisher(models.Model):
    name = models.CharField(max_length=255)
    address = models.CharField(max_length=255)

モデルの使用

# オブジェクトを作成
book = Book.objects.create(title="The Hitchhiker's Guide to the Galaxy", author="Douglas Adams", pub_date="1979-10-12")

# オブジェクトを取得
book = Book.objects.get(pk=1)

# オブジェクトを更新
book.title = "The Hitchhiker's Guide to the Galaxy: 42nd Anniversary Edition"
book.save()

# オブジェクトを削除
book.delete()

# 関連するオブジェクトを取得
author = book.author

# フィルターを使用してオブジェクトを取得
books = Book.objects.filter(author__name="Douglas Adams")

# 並べ替え
books = Book.objects.order_by("-pub_date")

モデルの管理

# モデルの変更をデータベーススキーマに反映
python manage.py makemigrations

# データベーススキーマを更新
python manage.py migrate

# Django シェルでモデルを操作
python manage.py shell

その他のサンプルコード

• OneToOneField 関係

class Book(models.Model):
    title = models.CharField(max_length=255)
    author = models.OneToOneField(Author, on_delete=models.CASCADE)

class Author(models.Model):
    name = models.CharField(max_length=255)

• ManyToManyField 関係

class Book(models.Model):
    title = models.CharField(max_length=255)
    authors = models.ManyToManyField(Author)

class Author(models.Model):
    name = models.CharField(max_length=255)

• モデルメタデータ

class Book(models.Model):
    title = models.CharField(max_length=255)
    author = models.CharField(max_length=255)
    pub_date = models.DateField()

    class Meta:
        ordering = ["-pub_date"]

Django モデルを扱うその他の方法

モデルアドミンを作成するには、admin.py ファイルに ModelAdmin クラスを作成します。

from django.contrib import admin

from .models import Book

class BookAdmin(admin.ModelAdmin):
    list_display = ('title', 'author', 'pub_date')

admin.site.register(Book, BookAdmin)

シリアルライザー

Django REST Framework は、Django モデルを JSON などの API エンドポイントに変換するためのシリアルライザーを提供しています。

シリアルライザーを作成するには、serializers.py ファイルに Serializer クラスを作成します。

from django.contrib.auth.models import User
from rest_framework import serializers

class UserSerializer(serializers.ModelSerializer):
    class Meta:
        model = User
        fields = ('username', 'email', 'is_staff')

カスタムクエリ

Django ORM は、データベースからデータを取得するための強力なツールですが、複雑なクエリの場合には不十分な場合があります。

このような場合は、生の SQL クエリを使用することができます。

from django.db import connection

cursor = connection.cursor()
cursor.execute("SELECT * FROM books WHERE author = 'Douglas Adams'")

その他のライブラリ

Django モデルを扱うための便利なライブラリが多数あります。

• django-filter: フィルター機能を追加
• django-guardian: 権限管理機能を追加
• django-taggit: タグ機能を追加

Django モデルは、データベースとのやり取りを抽象化し、データへのアクセスを容易にする強力なツールです。

このチュートリアルでは、モデルの基本的な概念と、Django でモデルを作成、使用、管理する方法について説明しました。

上記以外にも、モデルを扱う方法は多数あります。詳細については、次のリソースを参照してください。

上記のサンプルコードはあくまでも参考であり、実際のユースケースに合わせて変更する必要があります。