convex-migration-helper

Plan and execute Convex schema and data migrations with zero-downtime strategies.

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

SYSTEM DOCUMENTATION & REQUIREMENTS

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

What problem does it solve?

This Skill helps in planning and executing safe Convex schema and data migrations, ensuring smooth transitions without downtime.

Core Features & Use Cases

  • Schema Planning: Identify and plan schema changes, including adding new fields, changing field types, and splitting or merging tables.
  • Data Migrations: Execute data migrations using the widen-migrate-narrow pattern, ensuring data integrity and consistency.
  • Zero-Downtime Strategies: Implement strategies for zero-downtime rollouts, including dual write and dual read approaches.
  • Migration Component: Utilize the @convex-dev/migrations component for batching, pagination, and state tracking.
  • Use Case: Imagine you need to migrate a Convex schema that includes changing field types and backfilling data. This Skill guides you through the process, ensuring a smooth transition.

Quick Start

Use the convex-migration-helper skill to plan and execute a migration for your Convex schema changes.

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 zero-downtime schema migrations in Convex?

You can execute zero-downtime Convex schema migrations by implementing dual write and dual read approaches. This Skill plans these rollout strategies to ensure smooth transitions without downtime during field type changes or table merges.

What is the widen-migrate-narrow pattern for data backfilling in Convex?

The widen-migrate-narrow pattern for Convex data migrations involves widening the schema, backfilling existing records, and narrowing the schema. It utilizes the @convex-dev/migrations component to handle batching and pagination safely during the transition.

Can I use @convex-dev/migrations for batching large data rollouts?

Yes, you can use the @convex-dev/migrations component for batching large data rollouts in Convex. It provides built-in pagination and state tracking to manage data backfills and schema changes efficiently without overwhelming the database.

What is the best way to plan Convex schema changes like splitting tables?

The best way to plan Convex schema changes like splitting or merging tables is to map out the data migration workflow first. This Skill identifies required schema modifications and structures the execution to maintain data integrity throughout the process.

How do I handle field type changes in Convex without breaking queries?

To handle field type changes in Convex without breaking queries, implement a zero-downtime dual read approach where both old and new field types are supported. This strategy allows gradual data backfilling while existing queries continue functioning normally.