convex-migration-helper

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

Updated Aug 23, 2026
One-click install
npx skills add https://github.com/WannaCry081/React-Workflow-Starter --skill convex-migration-helper-wannacry081
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: convex-migration-helper
Source: https://github.com/WannaCry081/React-Workflow-Starter/tree/main/.agents/skills/convex-migration-helper
Command: npx skills add https://github.com/WannaCry081/React-Workflow-Starter --skill convex-migration-helper-wannacry081

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Plan and execute safe Convex schema and data migrations to prevent downtime and data loss during evolving data models.

Core Features & Use Cases

  • widen-migrate-narrow workflow coordination with the @convex-dev/migrations component.
  • Backfill and migrate existing documents safely during deployment.
  • Handle breaking schema changes, table restructures (split/merge), and field renaming or removal with zero downtime.
  • Supports dry runs and progress monitoring to validate migrations before production.

Quick Start

Plan a safe Convex migration for my current schema that backfills data and aligns with a widen-migrate-narrow deployment.

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 a zero-downtime Convex schema migration?

Use the widen-migrate-narrow workflow with the @convex-dev/migrations component to coordinate schema widening, batched data backfill, and schema narrowing for safe zero-downtime Convex migrations.

What is the widen-migrate-narrow workflow for Convex databases?

The widen-migrate-narrow workflow widens schema to accept both formats, backfills existing documents, and then narrows schema to enforce the new format, preventing downtime and data loss during Convex changes.

Can I backfill existing documents in Convex without taking my app offline?

Yes, you can backfill existing documents without downtime by using the @convex-dev/migrations component to run batched online migrations that process data while your application continues serving traffic.

How do I handle breaking schema changes like splitting or merging tables in Convex?

Handle breaking schema changes like splitting or merging tables by planning a multi-stage migration that coordinates schema updates and batched data backfilling to maintain availability throughout the table restructure.

Does the @convex-dev/migrations component support dry runs for data backfill?

Yes, the @convex-dev/migrations component supports dry runs and progress monitoring, allowing you to validate schema changes and data backfill operations before executing them in production.

When do I need a multi-deploy migration strategy for Convex?

You need a multi-deploy migration strategy for Convex when applying breaking schema changes, renaming or removing fields, or restructuring tables to ensure zero downtime and prevent data loss.