convex-migration-helper

Plans and executes Convex schema and data migrations using the widen-migrate-narrow workflow.

5|Updated Mar 5, 2024
One-click install
npx skills add https://github.com/TRAPZZY/God-Eyes --skill convex-migration-helper-trapzzy
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: convex-migration-helper
Source: https://github.com/TRAPZZY/God-Eyes/tree/main/.trae/skills/convex-migration-helper
Command: npx skills add https://github.com/TRAPZZY/God-Eyes --skill convex-migration-helper-trapzzy

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires @convex-dev/migrations, and includes references (resource) components.

What problem does it solve? Convex rejects deployments when a schema does not match existing data at rest, so breaking changes like adding required fields, changing field types, or splitting tables cannot ship directly. This Skill guides the multi-deploy widen-migrate-narrow workflow so schema and data stay consistent throughout the migration. ## Core Features & Use Cases - Multi-Deploy Migration Planning: Structures breaking changes into widen schema, backfill data, then narrow schema phases with code that handles both old and new formats. - Batched Data Migrations: Uses the @convex-dev/migrations component for cursor-based pagination, dry runs, resume from failure, and status monitoring. - Use Case: You need to change a boolean isPro field into a plan enum on a teams table with production data. The Skill walks you through adding the optional new field, dual-writing during the window, running a dry-run-tested backfill migration, verifying completion, and deploying the narrowed schema. ## Quick Start Ask the assistant to plan a safe migration for adding a required role field to your existing Convex users table, including the schema changes, backfill migration, and verification steps.

Frequently Asked Questions about convex-migration-helper

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
Can I test a Convex migration before changing production data?▼

Yes, run the migration with dryRun set to true, which executes one batch and then rolls back so you can inspect what it would do. This catches bugs in migration logic before they touch real documents.