convex-migrations

Automate batched Convex schema migrations with backfills and index updates.

Updated Apr 10, 2026
One-click install
npx skills add https://github.com/qdhenry/Foundry-OSS --skill convex-migrations-qdhenry
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: convex-migrations
Source: https://github.com/qdhenry/Foundry-OSS/tree/main/.agents/skills/convex-migrations
Command: npx skills add https://github.com/qdhenry/Foundry-OSS --skill convex-migrations-qdhenry

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Convex migrations provide safe, zero-downtime strategies for evolving schemas by adding fields, backfilling data, removing deprecated fields, and updating indexes.

Core Features & Use Cases

  • Safe, batched migrations for large datasets.
  • Backfilling and field renaming with backward compatibility.
  • Index migrations and governance-aware upgrades.

Quick Start

Run the migration steps to safely evolve a Convex schema with batched backfills and index updates in your development environment before production.

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 Convex schema migrations are performed by adding new fields, backfilling data in batches, removing deprecated fields, and updating indexes while maintaining backward compatibility throughout the transition.

What is the best way to backfill data when changing a Convex schema?

The best way to backfill data during a Convex schema migration is using batched backfill mutations governed by a migrations table to track progress and ensure safe recovery for large datasets.

How does backward compatibility work during Convex index migrations?

Backward compatibility during Convex index migrations requires code changes that handle both old and new schema shapes simultaneously, allowing the application to function safely while data transitions across batches.

Do I need a migrations table to automate Convex data model updates?

Yes, automating Convex data model updates requires a migrations table and internal mutations to accurately track migration progress and manage safe recovery during the backfill process.

Can I rename fields without downtime in a Convex application?

Yes, you can rename fields without downtime in Convex by applying backward-compatible migration patterns that support both old and new field names during the batched transition period.

What are the limitations of batched schema migrations for large datasets?

Batched schema migrations for large datasets require careful handling of old and new schema shapes simultaneously, limiting rapid structural changes and necessitating strict migration tracking to prevent data inconsistency.