convex-migration-helper

Manage breaking schema changes and data backfills for Convex databases.

Updated Feb 21, 2026
One-click install
npx skills add https://github.com/jcodog/CoD-Stats-Tracker --skill convex-migration-helper-jcodog
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: convex-migration-helper
Source: https://github.com/jcodog/CoD-Stats-Tracker/tree/main/packages/backend/.agents/skills/convex-migration-helper
Command: npx skills add https://github.com/jcodog/CoD-Stats-Tracker --skill convex-migration-helper-jcodog

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 production environments without causing downtime or data corruption. It provides a structured, multi-step workflow to ensure data integrity during complex database evolutions.

Core Features & Use Cases

  • Widen-Migrate-Narrow Workflow: Guides you through the industry-standard pattern for zero-downtime database changes.
  • Batch Processing: Leverages the @convex-dev/migrations component to handle large datasets safely via cursor-based pagination.
  • Use Case: Use this when you need to rename a field, split a table, or add a required field to a table that already contains thousands of production documents.

Quick Start

Use the convex-migration-helper to plan a migration for adding a required field to the users table while maintaining zero downtime.

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 breaking schema changes in a Convex database without downtime?

To execute breaking schema changes in a Convex database without downtime, use a multi-deploy migration strategy following a widen-migrate-narrow workflow to ensure production stability and data integrity.

What is the best way to backfill large datasets during a Convex migration?

The best way to backfill large datasets during a Convex migration is leveraging the @convex-dev/migrations component with cursor-based batch processing to handle thousands of production documents safely.

When do I need a multi-step migration workflow for renaming fields or splitting tables?

You need a multi-step migration workflow for renaming fields, splitting tables, or adding required fields to existing tables containing thousands of production documents to prevent data corruption.

Does the Convex migration helper support automated data consistency verification?

Yes, the Convex migration helper supports automated verification of data consistency by providing structured patterns for zero-downtime updates and ensuring data integrity throughout the transition.

Can I use batch processing with TypeScript to handle complex Convex schema migrations?

Yes, you can use batch processing with TypeScript to handle complex Convex schema migrations via cursor-based pagination, allowing asynchronous data backfills between old and new data structures.

What are the limitations of using a widen-migrate-narrow workflow for database evolutions?

The widen-migrate-narrow workflow requires managing multiple deployments and asynchronous batch processing, meaning limitations include coordinating schema widening and narrowing phases without disrupting production stability.