convex-migrations

Automate zero-downtime schema migrations for Convex applications.

Updated Nov 2, 2025

Search Tags:#indexing #migration #zero-downtime #convex #backfill #schema-evolution #data-migration

Ready to run

npx skills add https://github.com/cpmappstudio/cpca-sports --skill convex-migrations-cpmappstudio

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: convex-migrations
Source: https://github.com/cpmappstudio/cpca-sports/tree/main/.agents/skills/convex-migrations
Command: npx skills add https://github.com/cpmappstudio/cpca-sports --skill convex-migrations-cpmappstudio

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Safe, scalable schema evolution for Convex applications, enabling zero-downtime migrations across multi-tenant deployments.

Core Features & Use Cases

Field evolution: add, rename, or remove fields with backfilling strategies to preserve existing data.
Batch data backfills: perform data migrations in controlled batches with progress tracking.
Index migrations: introduce or adjust indexes while maintaining availability.
Migration orchestration: end-to-end runner patterns to start, track, and complete migrations safely.

Quick Start

Run a new migration by calling startMigration with a unique name, then execute backfill mutations in batches and finish with completeMigration when all data is migrated.

Frequently Asked Questions about convex-migrations

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

FAQPage Schema

How do I perform zero-downtime schema migrations in Convex?▼

Zero-downtime schema migrations in Convex are automated by calling startMigration, executing backfill mutations in controlled batches, and finishing with completeMigration to ensure consistent data evolution without downtime.

What is the best way to backfill data in batches during a Convex migration?▼

Backfilling data in batches during a Convex migration involves running backfill mutations with progress tracking to migrate existing data safely, ensuring availability is maintained throughout the process.

Can I add or remove fields without downtime in a multi-tenant Convex deployment?▼

Yes, field evolution in multi-tenant Convex deployments supports adding, renaming, or removing fields with backfilling strategies to preserve existing data while maintaining zero downtime.

How do index migrations work when adjusting schemas in Convex?▼

Index migrations in Convex introduce or adjust indexes while maintaining availability, coordinated through migration runner patterns that track progress and handle completion safely.

What are the limitations of coordinating migration steps across code changes in Convex?▼

Coordinating migration steps across code changes in Convex requires following the startMigration, batch backfill, and completeMigration sequence to ensure consistency, as skipping steps risks data inconsistency.