convex-migrations

Run Convex database schema migrations with batched processing and error handling.

Updated Apr 12, 2026

Search Tags:#database #schema #migration #patterns #zero-downtime #convex #backfill

Ready to run

npx skills add https://github.com/althof3/TCG-auction --skill convex-migrations-althof3

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: convex-migrations
Source: https://github.com/althof3/TCG-auction/tree/main/.agent/skills/convex-migrations
Command: npx skills add https://github.com/althof3/TCG-auction --skill convex-migrations-althof3

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Convex schema migrations are challenging to execute without downtime. This skill provides established patterns and tooling to evolve data models safely.

Core Features & Use Cases

Add new fields with zero-downtime backfills
Backfill existing documents in batches
Remove or rename fields without breaking code
Track migration progress and handle failures gracefully
Use index migrations to optimize queries for new fields

Quick Start

Run the migration runner to apply a prepared Convex migration across all records.

Frequently Asked Questions about convex-migrations

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

FAQPage Schema

How do I run zero-downtime database schema migrations on a live Convex deployment?▼

Zero-downtime Convex schema migrations are executed using a migration runner pattern that processes records in batches. This approach tracks progress and handles failures gracefully to evolve live database schemas without service interruption.

What is the best way to backfill existing documents in batches when adding new Convex schema fields?▼

The best way to backfill existing documents in batches is using the migration runner pattern provided. It safely adds new fields and populates existing records in controlled batches to avoid downtime and prevent system overload.

Can I remove or rename deprecated fields in Convex without breaking live application code?▼

Yes, you can remove or rename deprecated fields without breaking code by applying the established migration patterns. The runner ensures field changes are applied safely across all live documents while maintaining application compatibility.

How does batched processing handle progress tracking and error handling during a Convex backfill?▼

Batched processing handles Convex backfills by tracking migration progress and managing error handling gracefully. This ensures that any failures during the document update process are caught without halting the entire deployment migration.

When do I need to use a migration runner pattern to create indexes for new fields in Convex?▼

You need a migration runner pattern to create indexes when optimizing queries for new fields in a live Convex deployment. It ensures index migrations are applied safely across the database without causing downtime or performance degradation.