セットアップスクリプトの作成

テーブルの作成とテストデータの挿入を行うsetup_db.pyを作成します。

note-api/
├── .env
├── models.py
├── database.py
└── setup_db.py  ← このファイルを作成

作成したファイルに以下の内容を記述して保存します。

from sqlalchemy import text
from sqlmodel import Session, select

from database import create_db_and_tables, engine
from models import Note

# テーブルの作成(すでに存在する場合はスキップ)
with engine.connect() as conn:
    result = conn.execute(text("SHOW TABLES LIKE 'notes'")).fetchone()

if result is None:
    create_db_and_tables()
    print("テーブル notes を作成しました")
else:
    print("テーブル notes はすでに存在するためスキップしました")

# テストデータの挿入(すでにデータが存在する場合はスキップ)
with Session(engine) as session:
    existing = session.exec(select(Note)).all()
    if len(existing) == 0:
        note1 = Note(
            title="最初のノート", content="これはテスト用の最初のノートです。"
        )
        note2 = Note(
            title="2番目のノート",
            content="FastAPIとSQLModelの連携を学んでいます。",
        )
        session.add(note1)
        session.add(note2)
        session.commit()
        print("テストデータを2件挿入しました")
    else:
        print(f"テストデータはすでに{len(existing)}件存在するためスキップしました")

コードを解説します。

with engine.connect() as conn:
    result = conn.execute(text("SHOW TABLES LIKE 'notes'")).fetchone()

if result is None:
    create_db_and_tables()

SHOW TABLES LIKE 'notes'で、データベースにnotesテーブルがすでに存在するかをMySQLに直接問い合わせています。結果がNone(テーブルが見つからない)の場合のみcreate_db_and_tables()を呼び出してテーブルを作成します。

with Session(engine) as session:
    existing = session.exec(select(Note)).all()
    if len(existing) == 0:

テストデータを挿入する前に、すでにデータが存在するかを確認しています。select(Note)で全件取得し、件数が0の場合のみテストデータを挿入することで、重複挿入を防いでいます。

1. セットアップの実行

以下のコマンドで、Python がインストールされていることを確認します。

Windowsの場合:

python --version

以下のように Python のバージョンが表示されれば、インストールは確認できています。

Python 3.x.x

Macの場合:

python3 --version

以下のように Python のバージョンが表示されれば、インストールは確認できています。

Python 3.x.x

バージョンが表示されない場合は、Pythonのインストール を先に実施してください。

インストールが確認できたら、setup_db.pyを実行します。

Windowsの場合:

python setup_db.py

Macの場合:

python3 setup_db.py

以下のような出力が表示されます。

テーブル notes を作成しました
テストデータを2件挿入しました

もう一度実行しても、データが重複挿入されないことを確認できます。

Windowsの場合:

python setup_db.py

Macの場合:

python3 setup_db.py

以下のように、テストデータの挿入がスキップされます。

テーブル notes はすでに存在するためスキップしました
テストデータはすでに2件存在するためスキップしました

MySQLに接続して、データが正しく作成されているか確認します。

mysql -u root -p -e "SELECT * FROM notedb.notes;"

パスワードを入力すると、以下の結果が表示されます。

+----+-----------------------+----------------------------------------------------------+---------------------+---------------------+
| id | title                 | content                                                  | created_at          | updated_at          |
+----+-----------------------+----------------------------------------------------------+---------------------+---------------------+
|  1 | 最初のノート          | これはテスト用の最初のノートです。                        | 2025-01-01 10:00:00 | 2025-01-01 10:00:00 |
|  2 | 2番目のノート         | FastAPIとSQLModelの連携を学んでいます。                   | 2025-01-01 10:00:00 | 2025-01-01 10:00:00 |
+----+-----------------------+----------------------------------------------------------+---------------------+---------------------+
💡 ポイント
created_atとupdated_atの値は、実行した日時によって異なります。