convex-migration-helper

Plan and execute safe Convex schema migrations with batch processing and dry-run validation.

99|6|Updated Jan 11, 2026
One-click install
npx skills add https://github.com/vvedantb/eva --skill convex-migration-helper-vvedantb
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: convex-migration-helper
Source: https://github.com/vvedantb/eva/tree/main/.agents/skills/convex-migration-helper
Command: npx skills add https://github.com/vvedantb/eva --skill convex-migration-helper-vvedantb

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Convex migrations are risky during schema changes; this skill provides a structured approach to safely evolve data models and keep applications online.

Core Features & Use Cases

  • Online migrations with batch processing and resume capability
  • Backfilling deprecated fields and migrating data between schemas
  • Guidance on deploying multi-step migrate/narrow patterns and using @convex-dev/migrations

Quick Start

Plan and execute a safe Convex migration by widening the schema, migrating data, and narrowing the schema, validating with a dry run.

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 safe data migration in Convex while the app stays online?

Online Convex migrations use a widen-migrate-narrow pattern with batch processing to safely backfill data while keeping applications live. This structured approach allows schema changes to deploy without downtime.

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

Breaking schema changes in Convex require a multi-step pattern: widening the schema first, backfilling and migrating the data, then narrowing the schema to enforce the new types.

How do I backfill new fields in a Convex database?

You can backfill Convex fields using the @convex-dev/migrations component, which supports batch processing and resume capabilities to reliably populate new schema fields from existing data.

Can I test a Convex schema migration before running it in production?

Yes, you can validate Convex schema migrations using a dry run. This capability allows you to test the data backfill and schema switching logic safely before executing on production data.

How do I split a Convex table or rename fields without downtime?

Splitting tables or renaming fields requires an online-switching migration strategy. You deploy the new schema alongside the old one, backfill the data across them, and safely switch reads and writes before removing the old fields.