convex-migrations

Automates schema migrations for Convex databases with batched execution and progress tracking.

Updated Apr 7, 2026
One-click install
npx skills add https://github.com/Yahia89/ordering-food --skill convex-migrations-yahia89
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: convex-migrations
Source: https://github.com/Yahia89/ordering-food/tree/main/.claude/skills/convex-migrations
Command: npx skills add https://github.com/Yahia89/ordering-food --skill convex-migrations-yahia89

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Convex migrations enable safe, incremental schema evolution for Convex databases, providing patterns to add fields, backfill data, remove deprecated fields, create indexes, and coordinate zero-downtime deployments.

Core Features & Use Cases

  • Add optional fields and backfill data to existing records without downtime.
  • Rename or change field types by copying data to new fields, then removing old ones.
  • Add and manage indexes to optimize common queries, with a migration runner to apply changes safely.
  • Coordinate multi-step migrations with progress tracking and failure handling for reliable deployments.

Quick Start

Begin by following the migration runner pattern to apply the example migrations to your Convex schema and monitor progress until completion.

Frequently Asked Questions about convex-migrations

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

FAQPage Schema
How do I backfill data and add fields to a Convex database without downtime?

To backfill data and add fields to a Convex database without downtime, use a migration runner with cursor-based pagination and batched execution. This safely updates existing records incrementally while your application remains online.

What is the best way to rename fields or change field types in Convex schemas?

The best way to rename fields or change types in Convex schemas is to copy data to new fields, then remove the old ones. This multi-step migration is coordinated safely with progress tracking and failure handling.

How does cursor-based pagination work for Convex schema migrations?

Cursor-based pagination for Convex schema migrations processes records in safe, manageable batches. The migration runner tracks progress and uses cursors to iterate through multi-table schemas without overwhelming the database.

Can I create indexes and coordinate multi-step migrations across multiple Convex tables?

Yes, you can create indexes and coordinate multi-step migrations across multiple Convex tables. The migration runner interface manages start, progress updates, completion, and failure handling for reliable deployments.

Do I need a migration runner to safely evolve Convex schemas and add indexes?

You need a migration runner to safely evolve Convex schemas and add indexes because it provides batched execution and failure handling. This ensures reliable zero-downtime deployments when modifying multi-table structures.