convex-migration-helper

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

Updated Apr 24, 2026
One-click install
npx skills add https://github.com/featurectrl/website --skill convex-migration-helper-featurectrl
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: convex-migration-helper
Source: https://github.com/featurectrl/website/tree/main/.claude/skills/convex-migration-helper
Command: npx skills add https://github.com/featurectrl/website --skill convex-migration-helper-featurectrl

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Convex migrations often require careful coordination to avoid downtime and data inconsistency. The Convex Migration Helper provides a guided, safe workflow for planning and executing schema and data migrations.

Core Features & Use Cases

  • Guides multi-deploy migration patterns (widen, migrate, narrow) to support zero-downtime changes.
  • Integrates with @convex-dev/migrations to batch and resume large migrations.
  • Helps backfill data, add or remove fields, and restructure tables safely.

Quick Start

Define your first migration with the migrations component and perform a dry run to validate the plan.

Frequently Asked Questions about convex-migration-helper

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

FAQPage Schema
What is the best way to run zero-downtime schema migrations in Convex?

Zero-downtime Convex migrations use the widen-migrate-narrow workflow to sequence schema expansions, data backfills, and schema cleanups. This multi-deploy pattern ensures breaking changes are applied safely without interrupting production traffic.

How do I backfill data in Convex without causing downtime?

Backfilling Convex data without downtime involves integrating the @convex-dev/migrations component to batch and resume large data updates. This safely processes bulk records across tables while your application continues serving live traffic.

How does the widen-migrate-narrow workflow handle breaking schema changes?

The widen-migrate-narrow workflow handles breaking schema changes by expanding the schema first, migrating existing data to the new format, and finally narrowing the schema to remove old fields. This sequencing prevents write failures during deployment.

Can I use the @convex-dev/migrations component to resume interrupted data migrations?

Yes, the @convex-dev/migrations component supports resuming interrupted data migrations. It inherently batches large data operations and tracks progress, allowing paused or failed runs to resume safely without restarting.

Do I need multi-deploy sequencing for adding or removing fields in Convex?

Multi-deploy sequencing is necessary for adding or removing fields in Convex when handling breaking changes across production environments. Proper deploy sequencing ensures older application versions do not crash when encountering the updated schema.