migration-helper

Plan and execute structured schema migrations for Convex databases.

Updated Aug 23, 2026
One-click install
npx skills add https://github.com/sadroad/.dotfiles --skill migration-helper-sadroad
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: migration-helper
Source: https://github.com/sadroad/.dotfiles/tree/main/modules/home-manager/opencode/skills/migration-helper
Command: npx skills add https://github.com/sadroad/.dotfiles --skill migration-helper-sadroad

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill helps manage complex database schema changes in Convex, ensuring data integrity and minimizing downtime during migrations.

Core Features & Use Cases

  • Safe Schema Evolution: Guides users through adding fields, changing types, and restructuring tables without data loss.
  • Migration Strategies: Provides patterns for batch processing, scheduled runs, and dual-writing for zero-downtime deployments.
  • Use Case: When you need to add a new required field to your users table, this Skill will show you how to add it as optional, backfill existing data, and then make it required, all while keeping your application operational.

Quick Start

Use the migration-helper skill to plan and execute a migration for adding a required field to the users table.

Frequently Asked Questions about 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 database without causing downtime?

To add a required field safely, first introduce it as optional, backfill existing records with valid data, and then enforce the required constraint. This zero-downtime migration approach ensures continuous application availability.

What is the best way to restructure tables and change field types in a Convex schema migration?

The best way to handle table restructuring and type modifications is through structured schema migrations using batch processing and scheduled execution. This safely manages breaking changes while preserving overall data integrity.

How does a dual-write pattern work for zero-downtime schema migrations?

A dual-write pattern works for zero-downtime migrations by simultaneously writing data to both the old and new schema structures. This enables gradual backfilling and verification before fully deprecating the old structure.

Can I use batch processing to backfill existing data during a Convex migration?

Yes, you can use batch processing to backfill existing data during a Convex migration. This technique processes records in chunks, preventing system overload and maintaining application performance during large data updates.

When do I need to use a structured schema migration instead of direct database updates?

You need a structured schema migration for complex additive and breaking changes like field additions, type modifications, and table restructuring. It enforces migration principles to guarantee data integrity that direct updates lack.