Difyにおけるデータベースマイグレーション手順

はじめに

Difyプロジェクトでのデータベースマイグレーションには、AlembicコマンドとFlask-Migrateでラップされたコマンドの2種類が使用可能です。本記事では具体的な操作手順と注意点を説明します。

主要マイグレーションコマンド

Alembic直接コマンド

# 変更検出＆マイグレーションスクリプト生成
alembic revision --autogenerate -m "message"

# 最新バージョンへの適用
alembic upgrade head

Flask-Migrate経由コマンド

# 変更検出＆スクリプト生成（Alembicのラッパー）
flask db migrate -m "Initial migration."

# 最新バージョン適用（Alembicのラッパー）
flask db upgrade

標準マイグレーション作業フロー

1. データベースモデル設計完了後
2. マイグレーションスクリプト生成

   flask db migrate -m "Initial migration."
   

3. 変更をデータベースに適用

   flask db upgrade
   

4. 生成されたマイグレーションファイルをGitにコミット

※ 既に初期化済みのためflask db initは不要

デプロイ時の対応

デプロイ先環境では、コミットされたマイグレーションファイルを使用して以下を実行：

flask db upgrade

注意事項

• alembic revisionとflask db migrateは共に変更検出を行いますが、Flask-Migrateを使用する方がプロジェクト設定に沿った操作が可能
• 自動生成スクリプトは必ず内容を確認してから適用