convex-migration-helper

Plan and execute Convex schema migrations with the widen-narrow workflow.

Updated Apr 24, 2026
One-click install
npx skills add https://github.com/Katlyng/proy_vibetribe --skill convex-migration-helper-katlyng
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: convex-migration-helper
Source: https://github.com/Katlyng/proy_vibetribe/tree/main/packages/backend/.agents/skills/convex-migration-helper
Command: npx skills add https://github.com/Katlyng/proy_vibetribe --skill convex-migration-helper-katlyng

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Safely plan and execute Convex schema and data migrations to avoid deployment fallout and data loss.

Core Features & Use Cases

  • Online migrations: Migrations run without downtime, handling old and new data formats during deployment.
  • Zero-downtime patterns: Supports widen-narrow strategy with dual-write/read as needed.
  • Migrations tooling: Guidance and references for @convex-dev/migrations, including dry-run, status checks, and batch processing.
  • Use case: When adding or removing fields, changing types, or splitting tables while preserving data integrity.

Quick Start

Plan and execute a safe Convex migration that widens the schema, backfills existing documents, and then narrows the schema.

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 a zero-downtime Convex schema migration without data loss?

Execute a zero-downtime Convex schema migration by applying a widen-narrow workflow with the @convex-dev/migrations component, allowing the system to handle both old and new data formats during deployment without downtime.

What is the best way to backfill existing documents when changing types in Convex?

The best way to backfill existing documents during a Convex schema migration is to use batch processing through the @convex-dev/migrations component, ensuring data integrity while you add, remove, or change field types.

Can I dry-run a Convex data migration before applying it to production?

Yes, you can dry-run a Convex data migration using the @convex-dev/migrations component to validate changes safely and check migration status before executing batch processing on your live deployment.

When do I need to use the widen-narrow pattern for online Convex migrations?

You need the widen-narrow pattern for online Convex migrations when accommodating breaking changes like adding or removing fields, changing types, or splitting tables while preserving data integrity during zero-downtime deployments.

Does the @convex-dev/migrations component support batch processing for schema backfills?

Yes, the @convex-dev/migrations component supports batch processing for schema backfills, providing guidance for dry-run validation, status checks, and reversible data modifications during online migrations.