convex-migration-helper

Plan Convex schema and data migrations with widen-migrate-narrow strategies.

Updated Aug 23, 2026
One-click install
npx skills add https://github.com/awfixers-stuff/corp.awfixer.me --skill convex-migration-helper-awfixers-stuff
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: convex-migration-helper
Source: https://github.com/awfixers-stuff/corp.awfixer.me/tree/main/.agents/skills/convex-migration-helper
Command: npx skills add https://github.com/awfixers-stuff/corp.awfixer.me --skill convex-migration-helper-awfixers-stuff

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Plans Convex schema and data migrations with widen-migrate-narrow and @convex-dev/migrations to enable zero-downtime updates.

Core Features & Use Cases

  • Widen the schema, migrate data, then narrow the schema to safely apply breaking changes.
  • Online migrations run in batches to keep the app available during migration windows.
  • Guidance on using the @convex-dev/migrations component for robust, resumable migrations across tables and fields.

Quick Start

Start by identifying the breaking change, then implement a widening migration path followed by a narrowing migration path to complete the rollout.

Frequently Asked Questions about convex-migration-helper

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

FAQPage Schema
How do I apply breaking schema changes in Convex without downtime?

Convex zero-downtime migrations use a widen-migrate-narrow strategy: widen the schema to support both old and new shapes, backfill data in batches, then narrow the schema to complete the breaking change safely.

What is the best way to run online data backfills in Convex?

Online data backfills in Convex are best handled using the @convex-dev/migrations component, which supports robust, resumable workflows that process data in batches to keep your application available during migration windows.

How does the @convex-dev/migrations component handle table reshaping?

The @convex-dev/migrations component handles table reshaping by providing robust, resumable migration workflows across production and development environments, ensuring data integrity during batch processing.

Can I run batch migrations on Convex production environments safely?

Yes, you can safely run batch migrations on Convex production environments by using online migrations that process data incrementally, ensuring the application remains available throughout the migration window.

When do I need to use a widening migration path in Convex?

You need to use a widening migration path in Convex when applying breaking changes to your schema, allowing you to support both old and new data shapes simultaneously before narrowing the schema to finalize the update.