convex-migration-helper

Plan Convex schema migrations using a widen-migrate-narrow workflow.

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

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

It prevents Convex deploy failures and production data inconsistencies when you need to make breaking schema changes, while keeping the app online during the transition.

Core Features & Use Cases

  • Plan a widen-migrate-narrow workflow for breaking changes so your schema always remains compatible with data at rest.
  • Guide safe online migrations that handle both old and new document formats during the migration window.
  • Provide migration patterns and component guidance for backfills, field changes, table reshaping, and zero-downtime rollout strategies (dual read/write, verification, and common pitfalls).

Quick Start

Use the convex-migration-helper to plan your schema change, run a widen phase, backfill with @convex-dev/migrations, and then narrow the schema only after verification.

Frequently Asked Questions about convex-migration-helper

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

FAQPage Schema
How do I perform zero-downtime schema migrations in Convex?

Zero-downtime Convex schema migrations use a widen-migrate-narrow workflow, expanding schemas to handle dual read/write formats, backfilling data, then narrowing schemas after verifying completion to prevent deploy failures.

What is the best way to handle breaking schema changes in Convex?

Breaking Convex schema changes are handled using online migration patterns supporting dual read/write formats, enabling applications to remain online while batched data backfills complete safely.

When do I need to use the widen-migrate-narrow workflow for Convex?

You need the widen-migrate-narrow workflow for Convex when applying breaking changes like adding required fields, changing types, renaming or removing fields, or splitting and merging tables.

How do I backfill data during an online Convex migration?

Data backfill during online Convex migrations is executed using @convex-dev/migrations for batched resumable processing, featuring dry runs and status monitoring to verify completion before narrowing schemas.

Does Convex support online migrations for nested-to-relational data?

Convex supports online migrations for nested-to-relational data by enforcing a widen-migrate-narrow workflow that handles dual read/write formats during the migration window without application downtime.

Why does my Convex deployment fail when changing schema types?

Convex deployments fail when changing schema types because new schemas become incompatible with data at rest, requiring online migration workflows to handle dual formats before finalizing type changes.