pw migrate

pw migrate <action> [--dir <path>] [--dsn <dsn>] [--yes] [--dry-run]

アクション

アクション	効果
status	適用済みと未適用のマイグレーション
version	現在のスキーマバージョン
up	未適用のマイグレーションをすべて適用
up-by-one	次の 1 件だけ適用
up-to <version>	指定バージョンまで適用
down	直近の 1 件をロールバック
down-to <version>	指定バージョンまでロールバック
create <name>	次のマイグレーションファイルを作成
validate	マイグレーション一式を検査
snapshot	現在のスキーマを取得

up-to と down-to はバージョン引数が必須、create は名前が必須です。それ以外の アクションは、位置引数を無視せず拒否します。

オプション

オプション	効果
--dir <path>	migration.dir を上書きするマイグレーションディレクトリ
--dsn <dsn>	アプリケーションの設定を上書きする対象データベース
--yes	破壊的な操作をプロンプトなしで承認する
--dry-run	何も変更せず、実行内容だけを報告する

マイグレーションファイル

ファイルは migration.dir（既定は migrations/）に置き、goose の形式を使います。

-- +goose Up
CREATE TABLE users (
    id INTEGER PRIMARY KEY,
    name TEXT NOT NULL
);

-- +goose Down
DROP TABLE users;

pw migrate create add_email

は次の連番ファイルを書き出し、そのパスをプロジェクトルートからの相対で表示します。

DSN の取得元

--dsn を指定しない場合、pw はアプリケーションの設定規則を再実装せず、 アプリケーション自身に解決済みの DSN を尋ねます。したがってマイグレーションは、 サーバーが開くのと同じデータベースを対象にします。APP_ENV が選んだ TOML ファイルに、 環境変数、オプションの順で上書きした値です。

解決済み DSN はパイプ経由で返り、プロセス一覧から見える引数には置かれません。 pw が出力するエラーでもマスクされます。

これは、ほとんどの migrate アクションがプロジェクトを必要とする理由でもあります。 --dir と --dsn がなければ、尋ねる相手がいません。

開発中の扱い

pw dev は起動時とマイグレーションディレクトリの変更時に 未適用分を適用します。そのため直接のマイグレーションコマンドは、主に確認、 ロールバック、デプロイで役立ちます。すべて自分で管理する場合は、自動適用を無効にします。

[migration]
auto = false

関連

• データベースマイグレーション — ファイル形式と、このコマンドの前後の流れ。
• クエリ — SQL の書き方。
• pw seed — スキーマ適用後のデータ投入。