convex-migration-helper

Plan Convex schema migrations with the widen-migrate-narrow workflow.

Updated Dec 23, 2021

Search Tags:#deployment #migrations #backend #schema #zero-downtime #convex #data-migration

Ready to run

npx skills add https://github.com/dvakatsiienko/bytes --skill convex-migration-helper-dvakatsiienko

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: convex-migration-helper
Source: https://github.com/dvakatsiienko/bytes/tree/main/apps/x-com-chat/.agents/skills/convex-migration-helper
Command: npx skills add https://github.com/dvakatsiienko/bytes --skill convex-migration-helper-dvakatsiienko

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Convex migrations require careful planning to avoid downtime and data loss when changing schemas or migrating data across environments. This skill provides a safe, repeatable workflow and tooling patterns to plan, test, and execute schema migrations with confidence, including backfilling data and coordinating multi-step deploys.

Core Features & Use Cases

End-to-end migration planning: widen/narrow schema safely, backfill documents, and coordinate multi-step deploys.
Reusable migration patterns: apply common patterns like adding/removing fields, renaming fields, splitting data into new tables, and zero-downtime strategies using the Convex migrations component.
Use Case: Teams needing zero-downtime migrations during live production updates, or when breaking changes must be rolled out across multiple deployments.

Quick Start

Plan the migration by outlining the schema change, run a dry-run, and prepare deployment steps.

Frequently Asked Questions about convex-migration-helper

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

FAQPage Schema

How do I run zero-downtime Convex schema migrations without data loss?▼

Convex schema migrations require the widen-migrate-narrow workflow to backfill existing documents and adjust schemas across coordinated deployments. This approach uses the migrations component to ensure online safety, monitor progress, and verify completion with a dry run before finalizing changes.

What is the widen-migrate-narrow workflow for backend data migrations?▼

The widen-migrate-narrow workflow is a multi-deploy strategy for backend data migrations that safely widens the schema, backfills existing documents, then narrows the schema after data migration completes. It ensures online migration safety by coordinating deployments and verifying completion with a dry run.

How do I plan a Convex migration when adding, removing, or renaming fields?▼

Plan a Convex migration by identifying the required schema change and the data shape to backfill, then apply reusable migration patterns for adding, removing, or renaming fields. Outline the schema change, run a dry-run, and prepare coordinated deployment steps to execute safely.

Can I split data into new tables during a zero-downtime Convex deployment?▼

Yes, you can split data into new tables during a zero-downtime Convex deployment using the migrations component to backfill existing documents. The workflow supports reusable patterns for splitting data while coordinating multi-step deploys to maintain online migration safety.

Do I need a dry run before finalizing Convex schema changes in production?▼

A dry run is required before finalizing Convex schema changes to verify completion and ensure online migration safety. The workflow monitors progress and validates that backfilled documents and adjusted schemas are coordinated correctly across multi-step deployments before finalizing.