migration-helper

Plan and execute Convex schema migrations with backfills and index updates.

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

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Plan and execute Convex schema migrations safely, including adding fields, creating tables, and data transformations to preserve existing data and minimize downtime.

Core Features & Use Cases

  • No automatic migrations: apply additive changes first and backfill data as needed.
  • Support for common patterns: add optional fields, create new tables, add indexes, rename fields, and split structures.
  • Use cases: migrate breaking changes with backfills, data transformation, and zero-downtime rollout.

Quick Start

Provide your migration plan and then run the internal migration mutation to backfill data and switch to the new schema.

Frequently Asked Questions about migration-helper

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

FAQPage Schema
How do I safely migrate Convex schemas with zero downtime?

To safely migrate Convex schemas with zero downtime, apply additive changes first and backfill existing data using internal mutations. This preserves production availability while executing data transformations without interruption.

What are common zero-downtime migration patterns for Convex databases?

Common zero-downtime migration patterns include adding optional fields, creating new tables, adding indexes, renaming fields, and splitting structures. These patterns rely on additive changes paired with batch data backfills.

When do I need a data backfill during a schema migration?

A data backfill is needed during a schema migration when changes affect existing data, such as adding required fields or splitting structures. Backfills update historical records to match the new schema safely.

How do I execute a data backfill in Convex without taking the application offline?

Execute a data backfill without downtime by running internal migration mutations that process data in batches. This allows controlled rollout and data transformation while the application continues serving traffic.

What is the best way to rename fields in a Convex schema without breaking existing queries?

The best way to rename fields without breaking queries is an additive zero-downtime migration. Create the new field, backfill data from the old field, update application code, and then remove the old field.