モデルの設計
ノートの作成・更新時にリクエストボディとして受け取るデータのモデルを定義します。note-apiフォルダ内にmodels.pyを作成してください。
1. NoteCreateモデル
まず、ノートの作成・更新時にリクエストボディとして受け取るデータのモデルを定義します。note-apiフォルダ内にmodels.pyを作成してください。
note-api/
├── .env
└── models.py ← このファイルを作成
作成したファイルに以下の内容を記述して保存します。
from datetime import datetime
from typing import Optional
from sqlalchemy import Column, Text, TIMESTAMP, text
from sqlmodel import Field, SQLModel
class NoteCreate(SQLModel):
title: str = Field(max_length=100)
content: str
コードを解説します。
class NoteCreate(SQLModel):
title: str = Field(max_length=100)
content: str
NoteCreateは、ノートの作成時にクライアントから送信されるデータを定義するモデルです。前の章で学んだように、table=Trueを指定していないため、データベースのテーブルには対応せず、データのバリデーション(入力チェック)のみを行います。
ここでtable=Trueを指定しないのは、クライアントが送るデータとデータベースのテーブル構造が異なるためです。クライアントが送るのはtitleとcontentの2つだけですが、データベースのnotesテーブルにはidやcreated_atなどのカラムもあります。これらはクライアントが指定するものではなく、データベースが自動的に付与する値です。このように、リクエストの受け取り用とデータベース操作用でモデルを分けることで、APIの設計がシンプルになります。
2. NoteUpdateモデル
次に、ノートの更新時にクライアントから送信されるデータのモデルを定義します。models.pyに以下のコードを追加してください。
class NoteUpdate(SQLModel):
title: Optional[str] = None
content: Optional[str] = None
コードを解説します。
class NoteUpdate(SQLModel):
title: Optional[str] = None
content: Optional[str] = None
NoteUpdateは、ノートの更新時に使用するモデルです。NoteCreateとの違いは、すべてのフィールドがOptionalでデフォルト値がNoneになっている点です。
更新APIでは、変更したいフィールドだけを送るケースが一般的です。たとえば、タイトルだけを変更したい場合は{"title": "新しいタイトル"}とだけ送り、contentは送りません。NoteCreateをそのまま使うと全フィールドが必須になるため、タイトルだけ変更したいときにもcontentを送る必要が出てしまいます。NoteUpdateではOptionalにすることで、送られなかったフィールドはNoneになり、「変更しない」ことを表現できます。
3. Noteテーブルモデル
次に、データベースのnotesテーブルに対応するモデルを定義します。models.pyに以下のコードを追加します。
class Note(SQLModel, table=True):
__tablename__ = "notes"
id: Optional[int] = Field(default=None, primary_key=True)
title: str = Field(max_length=100)
content: str = Field(sa_column=Column(Text, nullable=False))
created_at: Optional[datetime] = Field(
default=None,
sa_column=Column(TIMESTAMP, server_default=text("CURRENT_TIMESTAMP")),
)
updated_at: Optional[datetime] = Field(
default=None,
sa_column=Column(
TIMESTAMP,
server_default=text("CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP"),
),
)
追加したコードを解説します。
class Note(SQLModel, table=True):
__tablename__ = "notes"
Noteモデルはtable=Trueを指定しているため、データベースのnotesテーブルに対応します。各フィールドの意味は以下のとおりです。
| フィールド | 説明 |
|---|---|
id |
主キー。新規作成時はNoneで、データベースが自動付与する |
title |
ノートのタイトル。最大100文字 |
content |
ノートの本文。Text型で長い文章に対応 |
created_at |
作成日時。MySQLが自動的に現在時刻を設定する |
updated_at |
更新日時。レコードが更新されるたびにMySQLが自動的に更新する |
| 📝 sa_columnとは |
|---|
sa_columnは、SQLAlchemyのColumnオブジェクトを直接指定するオプションです。SQLModelの標準的なField()では表現できないデータベース固有の設定(TIMESTAMP型やDEFAULT CURRENT_TIMESTAMPなど)を指定する場合に使用します。server_default=text("CURRENT_TIMESTAMP")は、MySQLのサーバ側でデフォルト値を設定することを意味します。 |