Flask-SQLAlchemy — データベースモデルの設計
この章では、Flask-SQLAlchemy を使ってデータモデルを定義し、SQLite データベースのテーブルを作成し、テストデータを挿入する方法を学びます。
なぜORMを使うのか?
SQL文を直接書いてデータベースを操作するのは煩雑で、エラーも発生しやすいです。
ORM(オブジェクト関係マッピング)Python クラスでテーブル構造を定義し、Python メソッドでデータを操作できます。
Flask-SQLAlchemy は SQLAlchemy の Flask 統合版であり、よくある操作をカプセル化し、設定がより簡単です。
インストールと設定
(venv) $ pip install flask-sqlalchemy
実例
from flask import Flask
from flask_sqlalchemy import SQLAlchemy
app = Flask(__name__)
# SQLite データベースファイルのパス(プロジェクトルートディレクトリ)
app.config['SQLALCHEMY_DATABASE_URI'] = 'sqlite:///blog.db'
# 変更追跡を無効化(メモリ節約、将来のバージョンではデフォルトで無効)
app.config['SQLALCHEMY_TRACK_MODIFICATIONS'] = False
# db インスタンスを作成し、app にバインド
db = SQLAlchemy(app)
sqlite:///blog.db「sqlite:///」の3つのスラッシュは相対パスを表します。SQLite データベースは1つのファイルであり、データベースソフトウェアをインストールする必要がないため、開発やテストに非常に適しています。
モデルを定義する:Post と Category
実例
from datetime import datetime
from app import db
class Category(db.Model):
"""記事カテゴリ"""
__tablename__ = 'categories'
id = db.Column(db.Integer, primary_key=True, autoincrement=True)
name = db.Column(db.String(50), unique=True, nullable=False)
slug = db.Column(db.String(50), unique=True, nullable=False)
# backref:Category オブジェクト上で .posts により配下のすべての記事を逆参照できる
posts = db.relationship('Post', backref='category', lazy='dynamic')
def __repr__(self):
return f'<Category {self.name}>'
class Post(db.Model):
"""ブログ記事"""
__tablename__ = 'posts'
id = db.Column(db.Integer, primary_key=True, autoincrement=True)
title = db.Column(db.String(200), nullable=False)
slug = db.Column(db.String(200), unique=True, nullable=False)
summary = db.Column(db.Text, default='')
content = db.Column(db.Text, nullable=False)
# 外部キー:db.ForeignKey('テーブル名.フィールド名')
category_id = db.Column(db.Integer, db.ForeignKey('categories.id'), nullable=False)
created_at = db.Column(db.DateTime, default=datetime.utcnow)
updated_at = db.Column(db.DateTime, default=datetime.utcnow, onupdate=datetime.utcnow)
def __repr__(self):
return f'<Post {self.title}>'
よく使うフィールド型
| フィールド型 | データベース型 | よく使うパラメータ |
|---|---|---|
| db.Integer | INTEGER | primary_key, autoincrement |
| db.String(N) | VARCHAR(N) | unique, nullable, default |
| db.Text | TEXT | default |
| db.DateTime | DATETIME | default, onupdate |
| db.Boolean | BOOLEAN | default |
| db.ForeignKey('テーブル.フィールド') | FOREIGN KEY | — |
データベーステーブルの作成
Django の migrate とは異なり、Flask ではデータベーステーブルの初期化を手動で行う必要があります。
(venv) $ flask shell # 进入 Flask 交互式 Shell
実例
from app import db
db.create_all() # すべてのモデルに対応するデータベーステーブルを作成
exit()
実行すると、プロジェクトルートディレクトリにblog.dbファイルが生成されます。
db.create_all()テーブルが存在しない場合にのみ作成されます。モデル構造を変更しても(フィールド追加など)、テーブルは自動更新されません。本番環境では Flask-Migrate(第5章)を使用して構造変更を管理する必要があります。
flask shell でテストデータを挿入
実例
from app import db
from models import Category, Post
# 1. カテゴリを作成
py_cat = Category(name='Python', slug='python')
css_cat = Category(name='CSS', slug='css')
flask_cat = Category(name='Flask', slug='flask')
db.session.add_all([py_cat, css_cat, flask_cat])
db.session.commit()
# 2. 記事を作成
post1 = Post(
title='Flask 入門完全ガイド',
slug='flask-beginner-guide',
summary='ゼロからFlaskを学ぶ。ルーティング、テンプレート、ORMなどの核心概念を網羅。',
content='<h2>なぜFlaskを学ぶのか?</h2><p>Flask は Python で最も柔軟な Web マイクロフレームワークです...</p>',
category=flask_cat
)
post2 = Post(
title='Python コルーチン詳解',
slug='python-coroutine',
summary='1つの記事で asyncio、コルーチン、イベントループを完全に理解する。',
content='<h2>コルーチンとは?</h2><p>コルーチンはスレッドよりも軽量な並行処理方式です...</p>',
category=py_cat
)
post3 = Post(
title='CSS Grid レイアウト実践',
slug='css-grid-layout',
summary='CSS Grid で複雑なレスポンシブレイアウトを簡単に実現。',
content='<h2>Grid 入門</h2><p>Grid は2次元レイアウトシステムです...</p>',
category=css_cat
)
db.session.add_all([post1, post2, post3])
db.session.commit()
# 3. クエリを検証
print(Post.query.all())
print(Post.query.filter(Post.category_id == 1).all())
Flask-SQLAlchemy 基本クエリ
| メソッド | 同等の SQL | 戻り値 |
|---|---|---|
| Post.query.all() | SELECT * FROM posts | リスト |
| Post.query.get(1) | WHERE id = 1 | 単一オブジェクトまたは None |
| Post.query.get_or_404(1) | WHERE id = 1 | 単一オブジェクトまたは自動的に 404 を返す |
| Post.query.filter_by(category_id=1).all() | WHERE category_id=1 | リスト |
| Post.query.filter(Post.title.ilike('%flask%')).all() | WHERE title LIKE '%flask%' | リスト |
| Post.query.order_by(Post.created_at.desc()).all() | ORDER BY created_at DESC | リスト |
本章のまとめ
この章では、Flask-SQLAlchemy の完全な流れを習得しました:SQLALCHEMY_DATABASE_URI のインストールと設定、db.Model によるモデル定義(フィールド型/外部キー/relationship)、db.create_all() によるテーブル初期化、flask shell でのデータ挿入とクエリ。
これで、記事とカテゴリのデータ構造が SQLite データベースに構築されました。
その他の拡張機能