convex-migrations

Migrate Convex database schemas with zero-downtime patterns.

23|5|Updated Nov 5, 2025
One-click install
npx skills add https://github.com/J-StaR-Films-Studios/VibeCode-Protocol-Suite --skill convex-migrations-j-star-films-studios
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: convex-migrations
Source: https://github.com/J-StaR-Films-Studios/VibeCode-Protocol-Suite/tree/main/assets/.agent/skills/convex-migrations
Command: npx skills add https://github.com/J-StaR-Films-Studios/VibeCode-Protocol-Suite --skill convex-migrations-j-star-films-studios

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires convex, python, and includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill addresses the challenge of evolving your Convex database schema, including adding new fields, backfilling data, removing deprecated fields, index migrations, and zero-downtime migration patterns.

Core Features & Use Cases

  • Schema Evolution: Safely evolve your Convex database schema with patterns for adding fields, backfilling data, and removing deprecated fields.
  • Zero-Downtime Deployments: Maintain continuous service availability during schema changes.
  • Use Case: If you need to add a new field to your user table and backfill existing data, this Skill can guide you through the process.

Quick Start

Use the convex-migrations skill to add a new 'avatarUrl' field to the 'users' table and backfill existing data.

Frequently Asked Questions about convex-migrations

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

FAQPage Schema
How do I backfill data when adding new fields to a Convex database schema?

To backfill data when adding new fields to a Convex database schema, you apply migration patterns that safely populate existing records, such as adding an 'avatarUrl' field to a 'users' table while maintaining data integrity.

What is a zero-downtime deployment pattern for Convex schema migrations?

A zero-downtime deployment pattern for Convex schema migrations is a strategy that maintains continuous service availability during schema changes, ensuring no service interruptions while you add fields, backfill data, or update indexes.

Do I need Python to perform schema evolution and index migrations on Convex?

Yes, you need Python and related Python libraries to perform schema evolution and index migrations on Convex, as these dependencies are required for executing the schema manipulation and data migration scripts.

What is the best way to remove deprecated fields from a Convex database?

The best way to remove deprecated fields from a Convex database is to use structured schema evolution strategies that safely deprecate and delete fields without breaking existing application queries or disrupting zero-downtime deployments.

Can I update indexes without downtime during a Convex schema migration?

Yes, you can update indexes without downtime during a Convex schema migration by applying zero-downtime migration patterns, which ensure continuous service availability while the index changes are applied in the background.