Essential SQLAlchemy， 2nd Edition

第11章. Alembicを使い始める

この作品はAIを使って翻訳されている。ご意見、ご感想をお待ちしている：[e-mail]

Alembic は、アプリケーションの進化に伴って必要になるデータベースの変更に対応するマイグレーションを、プログラマが作成・実行する方法を提供する。たとえば、テーブルにカラムを追加したり、モデルから属性を削除したりする。また、まったく新しいモデルを追加したり、既存のモデルを複数のモデルに分割したりすることもある。Alembic は、SQLAlchemy のパワーを活用することで、このような種類の変更を事前に行う方法を提供する。

、Alembicをインストールする必要がある：

pip install alembic

Alembicをインストールしたら、移行環境を作成する必要がある。

移行環境の作成

マイグレーション環境を作成するために、CH12というラベルのついたフォルダを作成し、そのディレクトリに移動する。 次に、alembic init alembic コマンドを実行して、alembic/ディレクトリにマイグレーション環境を作成する。一般的にはmigrations/ディレクトリにマイグレーション環境を作成するが、これはalembic init migrations 。好きなディレクトリ名をつけてもいいが、コード中のモジュール名として使われないような、何か特徴的な名前をつけることをお勧めする。 この初期化プロセスは、マイグレーション環境を作成し、構成オプションを含むalembic.iniファイルも作成する。ディレクトリを見ると、次のような構造になっている：

.
├── alembic
│   ├── README
│   ├── env.py
│   ├── script.py.mako
│   └── versions
└── alembic.ini

新しく作成したマイグレーション環境の中に、env.pyと script.py.makoテンプレートファイル、versions/ディレクトリを発見する。 version/ディレクトリにはマイグレーションスクリプトを格納する。 env.pyファイルは、Alembic が SQLAlchemy エンジンを定義してインスタンス化し、そのエンジンに接続してトランザクションを開始し、Alembic コマンドを実行したときにマイグレーションエンジンを正しく呼び出すために使われる。script.py.makoテンプレートはマイグレーションを作成するときに使われ、マイグレーションの基本構造を定義する。

環境が作成できたら、いよいよアプリケーションで動作するように設定する。

移行環境を設定する

alembic.iniと env.pyファイルにあるの設定を調整して、Alembicがデータベースとアプリケーションで動作するようにする必要がある。まずはalembic.iniファイルで、sqlalchemy.url オプションをデータベース接続文字列に合わせて変更する必要がある。カレントディレクトリにあるalembictest.dbというSQLiteファイルに接続するようにセットしたい。そのためには、sqlalchemy.url 行を以下のように編集する：

sqlalchemy.url = sqlite:///alembictest.db

すべてのAlembicの例では、ORMの宣言的なスタイルを使用して、app/db.pyファイルにすべてのコードを作成する。まず、 ...