migration-helper

Plan and execute Convex schema migrations with backfill and dual-write strategies.

7|1|Updated Nov 6, 2025
One-click install
npx skills add https://github.com/robertguss/web-app-starter-kit --skill migration-helper-robertguss
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: migration-helper
Source: https://github.com/robertguss/web-app-starter-kit/tree/main/.claude/skills/migration-helper
Command: npx skills add https://github.com/robertguss/web-app-starter-kit --skill migration-helper-robertguss

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Plan and execute Convex schema migrations safely, including adding fields, creating tables, and data transformations. Use when schema changes affect existing data.

Core Features & Use Cases

  • Additive changes are supported with backfill capabilities to ensure data integrity during migrations.
  • Zero-downtime strategies include batch processing, scheduled migrations, and dual-write patterns to migrate data progressively.
  • Clear migration patterns and example workflows guide developers from schema changes to production readiness.

Quick Start

Create and run an internal migration mutation that backfills new fields, builds the new schema, and executes the migration in controlled batches.

Frequently Asked Questions about migration-helper

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

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

To perform a zero-downtime schema migration in Convex, use internal mutations to backfill new fields, apply batch processing, schedule migrations, and implement dual-write patterns for progressive data transitions without service interruptions.

What is the best way to rename a table in Convex without breaking existing data?

Renaming a table in Convex requires a breaking change strategy. You can use dual-write patterns to maintain both old and new tables during the transition, then backfill existing data before removing the old structure.

How do I backfill new fields in Convex during a data migration?

To backfill new fields in Convex, define an internal mutation that iterates through existing documents in controlled batches, populating the new field values while maintaining schema integrity and avoiding timeout errors.

When do I need to use a dual-write pattern for Convex schema changes?

You need a dual-write pattern for Convex schema changes when transitioning between structures without downtime. It allows you to write data to both old and new schemas simultaneously, ensuring consistency during progressive migration.

Can I batch data transformations in Convex to avoid timeout issues?

Yes, you can batch data transformations in Convex. By defining internal mutations that process data in controlled batches, you execute migrations safely within time limits, ensuring production-ready transitions without exceeding system constraints.