convex-migration-helper

Guides Convex schema migrations with widening, narrowing, data backfilling, and verification.

1|Updated Apr 28, 2026
One-click install
npx skills add https://github.com/Carts1024/Highrable-Stellar --skill convex-migration-helper-carts1024
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: convex-migration-helper
Source: https://github.com/Carts1024/Highrable-Stellar/tree/main/.agents/skills/convex-migration-helper
Command: npx skills add https://github.com/Carts1024/Highrable-Stellar --skill convex-migration-helper-carts1024

SYSTEM DOCUMENTATION & REQUIREMENTS

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

What problem does it solve?

This Skill addresses the challenge of safely and efficiently migrating Convex schemas and data, ensuring that breaking changes are implemented without disrupting the application's functionality.

Core Features & Use Cases

  • Schema Migration: Handles the widening, migrating, and narrowing of Convex schemas for breaking changes.
  • Data Migration: Manages data backfilling and verification during schema changes.
  • Use Case: For a developer working on a Convex application, this Skill provides a step-by-step guide to adding a new required field to an existing table, ensuring the migration is smooth and data integrity is maintained.

Quick Start

Run the convex-migration-helper skill to plan and execute a migration for adding a new required field to the 'users' table.

Frequently Asked Questions about convex-migration-helper

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

FAQPage Schema
How do I safely migrate Convex schemas when adding a new required field?

To migrate Convex schemas safely, you must follow a widening, migrating, and narrowing sequence. This process backfills existing data for the new required field and verifies integrity before finalizing the schema change without disrupting application functionality.

What is the best way to handle data backfilling during a Convex schema migration?

Data backfilling during a Convex schema migration is handled by updating existing records to meet the new schema requirements before enforcing the changes. This Skill guides you through the verification step to ensure data integrity is maintained throughout the backfill process.

Do I need the @convex-dev/migrations library to execute schema changes?

Yes, the @convex-dev/migrations library is required as a dependency. It provides the necessary functions and scripts for manipulating Convex schemas and data, allowing you to safely plan and execute widening, migrating, and narrowing schema changes.

How does the widening and narrowing process work for Convex database management?

Widening and narrowing involves temporarily relaxing schema constraints to backfill data, then tightening them once data matches the new structure. This schema migration technique prevents application errors by ensuring existing data complies before enforcing breaking changes.

Can I use this approach to add breaking changes to existing Convex tables without downtime?

Yes, this approach implements breaking changes without downtime by separating schema migration into distinct phases. By widening the schema first, you can migrate and backfill data safely, then narrow the schema to apply the strict requirements without disrupting the application.