convex-migration-helper

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

Updated Mar 7, 2026
One-click install
npx skills add https://github.com/tacticus-tools/tp2-reset --skill convex-migration-helper-tacticus-tools
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: convex-migration-helper
Source: https://github.com/tacticus-tools/tp2-reset/tree/main/.agents/skills/convex-migration-helper
Command: npx skills add https://github.com/tacticus-tools/tp2-reset --skill convex-migration-helper-tacticus-tools

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Plans and executes safe Convex schema and data migrations using a widen-migrate-narrow workflow and the @convex-dev/migrations component. The approach helps teams evolve production schemas without downtime and data loss.

Core Features & Use Cases

  • Widen-Narrow migration workflow: widen the schema, migrate data in batches, then narrow the schema to minimize risk.
  • Migration tooling integration: leverages the @convex-dev/migrations component for batched, resumable migrations.
  • Safe handling of breaking changes: supports adding/removing/renaming fields, splitting tables, and backfilling data across deployments.

Quick Start

Provide a high-level migration plan and use the migrations component to apply a safe, batched backfill and schema narrowing.

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?

A zero-downtime Convex schema migration uses a widen-migrate-narrow workflow and the @convex-dev/migrations component to widen the schema, batch backfill data, then safely narrow the schema to minimize risk.

What is the safest way to handle breaking schema changes in Convex?

The safest way to handle breaking schema changes in Convex is the widen-narrow workflow, which supports adding, removing, or renaming fields and splitting tables while ensuring safe data handling and rollback readiness.

Can I use the migrations component to backfill data across deployments?

Yes, you can use the @convex-dev/migrations component to backfill data across deployments. It provides batched, resumable migrations that ensure safe data handling during the backfill process across different environments.

How do I plan a data migration without causing production downtime?

To plan a data migration without production downtime, apply an online migration model that widens the schema first, migrates data in resumable batches, and enforces rollback readiness before narrowing the schema.

What are the limitations of the widen-migrate-narrow workflow?

The widen-migrate-narrow workflow requires enforcing the online migration model and safe data handling. It is limited by the need for batched, resumable migrations to avoid downtime and ensure rollback readiness during schema narrowing.