convex-migration-helper

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

32|1|Updated Jan 17, 2026

Search Tags:#deployment #database #backend #schema #migration #convex

Ready to run

npx skills add https://github.com/damien-schneider/reflet --skill convex-migration-helper-damien-schneider

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: convex-migration-helper
Source: https://github.com/damien-schneider/reflet/tree/main/packages/backend/.agents/skills/convex-migration-helper
Command: npx skills add https://github.com/damien-schneider/reflet --skill convex-migration-helper-damien-schneider

SYSTEM DOCUMENTATION & REQUIREMENTS

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

What problem does it solve?

This skill solves the challenge of performing breaking schema changes in Convex without downtime, ensuring data integrity and preventing deployment failures caused by schema-data mismatches.

Core Features & Use Cases

Widen-Migrate-Narrow Workflow: Orchestrates the multi-step process of safely evolving database schemas.
Batch Processing: Leverages the @convex-dev/migrations component for reliable, resumable, and batched data transformations.
Use Case: Use this skill when you need to rename a field, change a data type, or split a table while your application remains live and serving users.

Quick Start

Ask the migration helper to plan a migration for your specific schema change by describing the current field structure and the desired target state.

Frequently Asked Questions about convex-migration-helper

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

FAQPage Schema

How do I execute a breaking schema migration in Convex without downtime?▼

To execute breaking schema migrations in Convex without downtime, use the widen-migrate-narrow pattern to safely evolve database schemas while the application stays live and serves users.

What is the widen-migrate-narrow pattern for database schema changes?▼

The widen-migrate-narrow pattern is a multi-step workflow for safely evolving database schemas by first widening the schema, migrating existing data, then narrowing it to the target state.

How do I change a field type or split a table in Convex with live production data?▼

To change a field type or split a table in Convex with live production data, plan a migration describing your current field structure and desired target state to orchestrate the safe data transformation.

Do I need the @convex-dev/migrations component to handle batch processing?▼

Yes, you need the @convex-dev/migrations component to handle batch processing, as it provides reliable, resumable, cursor-based pagination and state tracking for your data transformations.

When should I use a dedicated migration tool for Convex deployments?▼

You should use a migration tool for Convex deployments when you need to rename a field, change a data type, or add required fields to existing production data, preventing deployment failures from schema-data mismatches.