convex-migration-helper

Detects unused files and directories in your workspace, enabling you to delete them safely and keep your repository clean and tidy.

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

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires @convex-dev/migrations, and includes references (resource) components.

What problem does it solve?

This Skill helps you safely handle breaking Convex schema and data changes without failing deployments or corrupting existing production data.

Core Features & Use Cases

  • Widen-migrate-narrow planning: Guides you through the recommended multi-deploy workflow for required fields, type changes, field removals, and table reshaping.
  • Online data migration support: Uses the @convex-dev/migrations component for batched, resumable, monitored backfills and transformations.
  • Zero-downtime strategies: Covers dual-write, dual-read, dry runs, status checks, and rollback-aware migration design for real-world Convex apps.
  • Use case: If you need to add a required field to an existing table with live documents, this Skill helps you widen the schema, backfill the data, and then narrow the schema safely.

Quick Start

Ask for a safe migration plan for your Convex schema change and include the current table shape, the desired end state, and any existing data constraints.

Frequently Asked Questions about convex-migration-helper

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

FAQPage Schema
How do I add a required field to a Convex table without downtime?

To add a required field to a Convex table without downtime, use a widen-migrate-narrow workflow that temporarily widens the schema, backfills existing documents with the new field, and then narrows the schema to enforce the constraint safely.

What is the widen-migrate-narrow workflow in Convex?

The widen-migrate-narrow workflow in Convex is a multi-deploy strategy for breaking schema changes. It widens schema constraints to accept both old and new shapes, migrates and backfills data, and then narrows constraints to the desired strict state.

How can I run batched data backfills in Convex for schema migrations?

You can run batched data backfills in Convex using the @convex-dev/migrations component, which provides resumable, monitored data transformations for live applications without interrupting normal operations.

Does @convex-dev/migrations support zero-downtime rollouts for type changes?

Yes, @convex-dev/migrations supports zero-downtime rollouts for Convex type changes by implementing dual-write, dual-read, and dry-run verification strategies alongside rollback-aware deployment sequencing.

What is the best way to handle Convex table splits and merges in production?

The best way to handle Convex table splits and merges in production is using a structured migration plan with schema validation awareness, batched resumable backfills, and dry-run verification to prevent data corruption or failed deployments.

When should I avoid manual schema updates in Convex?

You should avoid manual schema updates in Convex when dealing with breaking changes like field deletions or type changes on live applications, as unmonitored updates risk corrupting production data and causing deployment failures without rollback safety.