convex-migration-helper

Plan and execute Convex schema migrations with online batch workflows.

Updated Mar 19, 2026
One-click install
npx skills add https://github.com/just-optimal/optimal-habits-monorepo --skill convex-migration-helper-just-optimal
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: convex-migration-helper
Source: https://github.com/just-optimal/optimal-habits-monorepo/tree/main/packages/db/.agents/skills/convex-migration-helper
Command: npx skills add https://github.com/just-optimal/optimal-habits-monorepo --skill convex-migration-helper-just-optimal

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Plan and execute Convex schema migrations safely, including adding fields, creating tables, and transforming data when changes affect existing records.

Core Features & Use Cases

  • Online migrations that keep the app running while data is migrated in batches.
  • Backfilling fields and transforming data without breaking existing documents.
  • Safe deployment patterns including widening then narrowing schemas, and using the migrations component for dry runs and status checks.

Quick Start

Install and configure the Convex migrations component, define a sample migration, and run it to safely backfill data.

Frequently Asked Questions about convex-migration-helper

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

FAQPage Schema
How do I execute safe Convex schema migrations without downtime?

To execute safe Convex schema migrations without downtime, use an online migration workflow that processes data in batches. This approach ensures your application remains fully operational while records are adapted, backfilled, or transformed in the background.

What is the best way to backfill data when adding new fields in Convex?

The best way to backfill data when adding new fields in Convex is to define a migration using the migrations component. This allows you to safely populate new fields and transform existing documents without breaking your current application logic.

Can I test a data migration before applying it to production?

Yes, you can test a data migration before applying it to production by performing a dry-run. The Convex migrations component supports dry-runs and provides status monitoring to help you verify changes safely prior to full deployment.

How do I handle changing field types or splitting tables in Convex?

To handle changing field types or splitting and merging tables in Convex, apply safe deployment patterns like widening then narrowing schemas. Use the migrations component to orchestrate these complex structural transformations incrementally.

What are the limitations of online Convex data migrations?

Online Convex data migrations require careful schema widening and narrowing patterns to avoid breaking existing documents. Complex operations like changing field types or splitting tables must be executed incrementally in batches using the migrations component.