データベース接続の設定
データベースへの接続を管理するdatabase.pyを作成します。
note-api/
├── .env
├── models.py
└── database.py ← このファイルを作成
作成したファイルに以下の内容を記述して保存します。
import os
from dotenv import load_dotenv
from sqlmodel import Session, SQLModel, create_engine
load_dotenv()
DB_HOST = os.getenv("DB_HOST", "localhost")
DB_USER = os.getenv("DB_USER", "root")
DB_PASSWORD = os.getenv("DB_PASSWORD", "")
DB_NAME = os.getenv("DB_NAME", "notedb")
DATABASE_URL = f"mysql+pymysql://{DB_USER}:{DB_PASSWORD}@{DB_HOST}/{DB_NAME}"
engine = create_engine(DATABASE_URL)
def create_db_and_tables():
SQLModel.metadata.create_all(engine)
def get_session():
with Session(engine) as session:
yield session
コードを解説します。
DATABASE_URL = f"mysql+pymysql://{DB_USER}:{DB_PASSWORD}@{DB_HOST}/{DB_NAME}"
engine = create_engine(DATABASE_URL)
.envファイルから読み込んだ接続情報で接続URLを組み立て、create_engine()でデータベースへの接続を管理するengineを作成しています。
def create_db_and_tables():
SQLModel.metadata.create_all(engine)
models.pyで定義したテーブルモデルに基づいて、データベースにテーブルを自動作成する関数です。テーブルがすでに存在する場合はスキップされます。
def get_session():
with Session(engine) as session:
yield session
データベース操作に必要なSessionを生成する関数です。yieldを使うことで、処理が終わった後にセッションが自動的に閉じられます。
| 📝 yieldとは |
|---|
yieldはPythonのジェネレータ構文です。通常のreturnと異なり、yieldは値を返した後もその位置で処理を一時停止し、ブロックの終了時に残りの処理(with文によるSessionのクローズ)が実行されます。FastAPIのDependsと組み合わせることで、リクエストの開始時にセッションを作成し、レスポンス後に自動でクローズする仕組みを実現しています。 |