【要約】Alembic マイグレーションファイルを作成順に並べる [Zenn_Python] | Summary by TechDistill
> Source: Zenn_Python
Execute Primary Source
// Problem
開発者が、マイグレーションの適用状況を視覚的に確認しようとする際に、以下の問題に直面する。
- ・デフォルトのリビジョンIDはランダムなため、ファイル順が作成順と一致しない。
- ・
alembic currentの結果から、未適用のファイルを特定する作業が困難である。 - ・
Revises項目を一つずつ辿る必要があり、判断に時間がかかる。
// Approach
開発者は、
alembic.ini の設定を変更することで、ファイル名にタイムスタンプを組み込む。- ・
file_templateのコメントアウトを解除する。 - ・
%%(year)d_%%(month).2d_%%(day).2d_%%(hour).2d%%(minute).2d-%%(rev)s_%%(slug)sを指定する。 - ・これにより、ファイル名の先頭に日付と時刻が付与される。
// Result
この設定変更により、開発者はファイル一覧から適用状況を直感的に把握できる。
- ・ファイルが作成順（時系列順）に並ぶようになる。
- ・適用済みリビジョンの直後にあるファイルが未適用であると即座に判断できる。
- ・人間による管理コストが大幅に削減される。
Senior Engineer Insight
> 大規模開発では、マイグレーション履歴の可視性が運用の生命線となる。デフォルトのハッシュ値管理は、機械的な処理には適しているが、人間の認知負荷を高める。本手法は、開発体験（DX）を向上させる実用的な改善だ。ただし、既存ファイルとの命名規則の乖離には注意が必要である。プロジェクト初期に導入すべき標準設定と言える。