convex-migrations

Define zero-downtime migration patterns for Convex schemas.

Updated Dec 25, 2025
One-click install
npx skills add https://github.com/benfwalla/things-to-be-happy-about --skill convex-migrations-benfwalla
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: convex-migrations
Source: https://github.com/benfwalla/things-to-be-happy-about/tree/main/.claude/skills/convex-migrations
Command: npx skills add https://github.com/benfwalla/things-to-be-happy-about --skill convex-migrations-benfwalla

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Convex schemas often need evolution as applications grow, requiring safe, zero-downtime migrations without data loss or downtime.

Core Features & Use Cases

  • Schema evolution strategies: add fields, backfill data, remove deprecated fields, and index migrations with minimal disruption.
  • Backward-compatible transitions: support multiple schema versions during rollout and code changes.
  • Use Case: You’re evolving a user table from name and email to include profile settings while ensuring existing records remain valid.

Quick Start

Follow the migration steps to safely evolve your Convex schema without downtime.

Frequently Asked Questions about convex-migrations

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

FAQPage Schema
How do I evolve a Convex database schema without downtime?

To perform zero-downtime schema migrations in Convex, use phased rollout strategies that maintain backward compatibility. This approach allows adding fields, backfilling data, and removing deprecated fields without causing downtime or data loss.

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

The best way to backfill data in Convex is using safe migration patterns that support backward-compatible transitions. This allows you to add new fields like profile settings to existing user tables while ensuring current records remain valid during the rollout.

Can I use phased rollouts for index migrations in Convex?

Yes, you can use phased rollouts for index migrations in Convex. The migration patterns specify step-by-step strategies to safely evolve indexes and schemas across environments with minimal disruption to ongoing operations.

How do I safely remove deprecated fields from a Convex database?

To safely remove deprecated fields from a Convex database, follow a phased migration strategy that ensures backward compatibility first. Remove the fields only after all code references are updated and existing data is transitioned.

What are the limitations of zero-downtime migrations in Convex?

Zero-downtime migrations in Convex require careful governance and tracking to avoid limitations like data loss. You must support multiple schema versions simultaneously during rollout, which adds complexity to the transition process.