get-convex/convex-migration-helper

Convexのスキーマとデータマイグレーションを、widen-migrate-narrow パターンと @convex-dev/migrations を用いて計画します。破壊的なスキーマ変更、バックフィル、テーブル再編成、ゼロダウンタイムロールアウトに使用します。

convex-migration-helper とは?

このスキルは、Convexアプリケーションにおけるデータベーススキーマとデータのマイグレーションを計画・実行するための支援ツールです。widen-migrate-narrow パターンと @convex-dev/migrations ライブラリを活用し、破壊的なスキーマ変更(カラム削除・型変更など)、バックフィル(既存データの変換)、テーブル再編成、ゼロダウンタイムでのロールアウトなど、複雑な移行作業を安全かつ効率的に行うことができます。Claude Code、Cursor、CodexなどのAIエージェントと連携し、開発者がマイグレーションの計画とコード生成を迅速に行えるよう支援します。具体的には、`npx convex-migration-helper` コマンドを実行することで、対話的にマイグレーションファイルやスキーマ変更案を生成可能です。

対応~Claude Code~Codex CLI~Cursor
npx skills add https://github.com/get-convex/agent-skills/tree/main/skills/convex-migration-helper

Installed? Explore more 生産性&コラボレーション skills: steipete/gemini, steipete/gh-issues, steipete/skill-creator · View all 6 →

お気に入りのAIに質問する

このエージェントスキルを事前に読み込んだ状態で新しいチャットを開きます。

ドキュメント

convex-migration-helper は何をしますか?

Convex のスキーマとデータマイグレーションを、widen-migrate-narrow パターンと @convex-dev/migrations を用いて計画します。破壊的なスキーマ変更、バックフィル、テーブル再編成、ゼロダウンタイムロールアウトに使用します。

概要

このスキルは、Convex アプリケーションにおけるデータベーススキーマとデータのマイグレーションを計画・実行するためのツールです。widen-migrate-narrow パターンと @convex-dev/migrations ライブラリを活用し、ダウンタイムを最小限に抑えながら安全に移行を進めることができます。

使用方法

AIエージェント(Claude Code、Cursor、Codex など)で以下のコマンドを実行してください:

npx convex-migration-helper

このコマンドは対話的なプロンプトを表示し、マイグレーションの計画とコード生成を支援します。

主な機能

  • widen-migrate-narrow パターン: ゼロダウンタイムでスキーマを変更
  • バックフィル: 既存データの新しいスキーマへの変換
  • テーブル再編成: カラムの追加・削除・名前変更
  • 破壊的変更の安全な適用: インデックス変更、型変換など
  • @convex-dev/migrations の統合: スキーマ定義とマイグレーションロジックの分離

前提条件

  • Convex プロジェクトがセットアップ済みであること
  • Node.js 16 以上がインストール済みであること

詳細

詳しい使い方やベストプラクティスについては、公式ドキュメント を参照してください。

Individual skills in this repo

This repo contains 5 individual skills — each has its own dedicated page.

関連スキル