convex-migration-helper

Plan and execute Convex migrations with a widen-migrate-narrow workflow.

Updated Apr 15, 2026
One-click install
npx skills add https://github.com/RestartDK/project-europe --skill convex-migration-helper-restartdk
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: convex-migration-helper
Source: https://github.com/RestartDK/project-europe/tree/main/.agents/skills/convex-migration-helper
Command: npx skills add https://github.com/RestartDK/project-europe --skill convex-migration-helper-restartdk

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Plans and executes safe Convex schema and data migrations using widening and narrowing patterns to minimize downtime and data loss.

Core Features & Use Cases

  • Widen-narrow migration workflow: plan, backfill, and revert safely during breaking changes.
  • Online migrations: migrate data in batches while the app remains live.
  • Guidance for zero-downtime deployments and common patterns, with references to migration-patterns and migrations-component documentation.

Quick Start

Plan a two-deploy migration for a production table, run a dry-run, then deploy the final schema changes.

Frequently Asked Questions about convex-migration-helper

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

FAQPage Schema
How do I run zero-downtime schema migrations on Convex?

Zero-downtime schema migrations on Convex use a widen-migrate-narrow workflow to deploy breaking changes safely. This approach backfills data in batches while the application remains live, minimizing downtime and preventing data loss.

What is the best way to backfill existing data during a Convex deployment?

The best way to backfill data during a Convex deployment is using an online migration pattern with the @convex-dev/migrations component. It processes data in batches while the app stays live, supporting safe schema evolution and robust deployment.

Can I do a dry run before executing a Convex data migration?

Yes, you can run a dry run before executing a Convex data migration. The migration workflow supports dry-run status checks and guided planning to validate schema changes and backfill operations before final deployment.

When do I need a two-deploy migration for Convex tables?

A two-deploy migration is needed for Convex tables when handling breaking changes that require zero downtime. You first widen the schema to support both old and new formats, backfill the data, and then narrow the schema in the final deployment.

Does the Convex migration helper support reverting breaking schema changes?

Yes, the Convex migration helper supports reverting breaking schema changes safely. The widen-narrow workflow includes planning, backfilling, and safe revert procedures to ensure robust schema evolution without data loss.

Are there limitations to running online migrations with the @convex-dev/migrations component?

Online migrations using the @convex-dev/migrations component require adherence to the widen-migrate-narrow pattern to avoid limitations. Skipping this structured workflow during breaking changes risks downtime and potential data corruption.