convex-migration-helper

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

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

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Convex schema and data migrations can be risky, potentially causing downtime or data inconsistencies. This skill helps teams plan, coordinate, and validate migrations before rolling them out, leveraging proven workflows to minimize disruption.

Core Features & Use Cases

  • Widen-migrate-narrow guided workflow for safe breaking changes and backfills.
  • Integration with the @convex-dev/migrations component to handle batching, dry runs, and progress tracking.
  • Supports online migrations with dual-write/read considerations and clear rollback strategies.
  • Provides reference patterns and best practices to structure migration tasks.

Quick Start

Plan and run a Convex migration by outlining the schema change, choosing the widen-migrate-narrow path, and applying it with the @convex-dev/migrations tool.

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 Convex schema migrations for breaking changes?

You run zero-downtime Convex migrations by following the widen-migrate-narrow workflow, which structures breaking changes and backfills into staged deployment cycles to prevent downtime and data inconsistencies.

What is the widen-migrate-narrow workflow for backend data migrations?

The widen-migrate-narrow workflow is a staged process that broadens schema compatibility, migrates existing data, and then narrows the schema to finalize breaking changes safely without disrupting active backend operations.

Can I use the @convex-dev/migrations component for batching and dry runs?

Yes, you can use the @convex-dev/migrations component to orchestrate online migrations with automated batching, dry runs, and progress tracking to validate data changes before full deployment.

How do I backfill data in Convex without causing downtime?

You backfill data in Convex without downtime by using the @convex-dev/migrations component to process records in batches, allowing dual-write and dual-read strategies to maintain application availability.

What's the best way to plan a rollback for a Convex schema change?

The best way to plan a rollback for a Convex schema change is to follow the widen-migrate-narrow workflow, which maintains dual-write compatibility and provides clear rollback strategies at each migration stage.

When do I need to use online migrations for Convex table reshaping?

You need online migrations for Convex table reshaping when your changes require backfills or breaking schema alterations that cannot block active users or cause data inconsistencies.