mcpField
C
convex-migrate

convex-migrate

github.com/get-convexデータ・データベース6931.4k 回インストール1 日前に更新
リポジトリ

convex-migrate について

convex-migrate は、既存データを保ちながらデプロイ済みの Convex アプリのスキーマを変更するためのスキルです。段階的な変更、データのバックフィル、検証を案内します。

主な機能

  1. 01新規フィールドをまず任意に設定
  2. 02既存レコードのバックフィルと変換
  3. 03移行前後のレコード数を確認
  4. 04移行後にバリデーターを厳格化

活用シーン

  1. 01デプロイ済みレコードへの必須フィールド追加
  2. 02スキーマ変更に伴う既存データの更新

インストール

コマンドをコピーしてターミナルで実行します。

$npx skills add https://github.com/get-convex/agent-skills --skill convex-migrate

インストール後、Claude Code で/convex-migrateを入力して読み込まれたか確認します。

詳細

ライブアプリのスキーマ/データを移行する

既存のデータを損なわずにデプロイ済みのスキーマを変更します。まずスキーマ変更を段階的に行い、@convex-dev/migrations をインストールして、既存の行を有効にするバックフィルを作成して実行し、バリデーターを厳格化する前に検証します。

ワークフロー

  1. まず新しいフィールドを省略可能にします(デプロイ時に既存の行が拒否されないようにします)。
  2. @convex-dev/migrations をインストールし、既存の行をバックフィル/変換するマイグレーションを作成します。
  3. マイグレーションを実行し、すべての行が有効であることを確認します。
  4. バックフィルの完了後に、バリデーターを厳格化します(フィールドを必須にします)。

ルール

  • バックフィルが完了する前にバリデーターを厳格化しないでください。既存の行が拒否され、ライブアプリが壊れます。
  • 新しいフィールドはまず省略可能として追加し、移行した後で必須にします。
  • 移行の前後で行数を確認します。

コメント