convex-migration-helper

Manage Convex schema and data migrations using the @convex-dev/migrations component.

2|4|Updated Jun 23, 2025
One-click install
npx skills add https://github.com/xrehpicx/vector --skill convex-migration-helper-xrehpicx
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: convex-migration-helper
Source: https://github.com/xrehpicx/vector/tree/main/.agents/skills/convex-migration-helper
Command: npx skills add https://github.com/xrehpicx/vector --skill convex-migration-helper-xrehpicx

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 migrating Convex schemas and data, allowing for breaking changes and backfills with confidence.

Core Features & Use Cases

  • Schema Migration: Facilitates schema changes such as adding required fields, changing field types, and reshaping tables.
  • Data Migration: Handles data migration tasks like backfilling existing documents and transitioning to new data formats.
  • Use Case: When you need to upgrade your Convex application with a new version or add additional features, this Skill helps manage the schema and data changes.

Quick Start

Run the convex-migration-helper skill to begin the migration process for your Convex schema.

Frequently Asked Questions about convex-migration-helper

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

FAQPage Schema
How do I safely migrate Convex schemas when adding required fields or changing field types?

Safely migrating Convex schemas for breaking changes like adding required fields or changing field types requires managing data integrity during the transition. This Skill facilitates these schema modifications by orchestrating backfills and table reshaping to maintain application stability.

What is the best way to backfill existing documents during a Convex data migration?

Backfilling existing documents during a Convex data migration is handled through the @convex-dev/migrations component, which executes the required data transformations to transition existing records into new data formats safely.

Do I need the @convex-dev/migrations component to use this schema migration helper?

Yes, the @convex-dev/migrations component is required to use this schema migration helper, as it provides the underlying functionality needed to execute data transformations and backfills during your Convex schema changes.

Can I transition to new data formats in Convex without breaking my application?

Transitioning to new data formats in Convex without breaking your application is possible by running managed schema and data migrations, which ensure application stability and data integrity while you upgrade to new application versions.