convex-migration-helper

Name: convex-migration-helper
Availability: InStock
Author: mariopak8-gif

Manage Convex schema widening, migration, and narrowing with online data migrations.

Updated Jun 2, 2026

Search Tags:#schema migration #data migration #Convex #schema evolution #online migration

Ready to run

npx skills add https://github.com/mariopak8-gif/lssc-one --skill convex-migration-helper-mariopak8-gif

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: convex-migration-helper
Source: https://github.com/mariopak8-gif/lssc-one/tree/main/.agents/skills/convex-migration-helper
Command: npx skills add https://github.com/mariopak8-gif/lssc-one --skill convex-migration-helper-mariopak8-gif

SYSTEM DOCUMENTATION & REQUIREMENTS

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

What problem does it solve?

This Skill streamlines the process of planning and executing schema and data migrations in Convex, ensuring smooth transitions with minimal downtime.

Core Features & Use Cases

Schema Migration: Handle breaking schema changes, backfills, table reshaping, and zero-downtime rollouts.
Data Migrations: Perform data migrations online, with asynchronous batch updates.
Use Case: When adding a new required field to an existing table, use this Skill to widen the schema, migrate the data, and then narrow the schema without interrupting service.

Quick Start

Run the convex-migration-helper skill to add a new required field to the 'users' table.

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 new required field to an existing Convex table without downtime?▼

To add a new required field in Convex without downtime, widen the schema, migrate existing data asynchronously, and then narrow the schema. This approach ensures smooth schema evolution by validating data before enforcing strict types.

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

The best way to handle breaking Convex schema changes is preferentially adding new fields over direct type changes. You manage table reshaping, backfills, and zero-downtime rollouts using the @convex-dev/migrations framework.

Can I perform data migrations online while my Convex application is running?▼

Yes, you can perform data migrations online in Convex. The skill executes asynchronous batch updates during the migration process, allowing you to reshape tables and backfill data without interrupting active service.

Do I need the @convex-dev/migrations package to evolve my Convex schema?▼

Yes, you need the @convex-dev/migrations package and the Convex framework to execute schema evolution. The skill relies on these dependencies to manage schema validation, data backfills, and online rollouts.

Why should I prefer adding new fields over changing types during a Convex schema migration?▼

Preferring new fields over type changes during Convex schema migration prevents breaking existing application logic. This strategy allows you to widen the schema and migrate data safely before narrowing it to enforce new validation rules.