convex-migrations

Manage Convex database schema evolution with field and index migrations.

Updated Feb 21, 2026
One-click install
npx skills add https://github.com/mikeyfennelly1/hackeurope--210226 --skill convex-migrations-mikeyfennelly1
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: convex-migrations
Source: https://github.com/mikeyfennelly1/hackeurope--210226/tree/main/.agents/skills/convex-migrations
Command: npx skills add https://github.com/mikeyfennelly1/hackeurope--210226 --skill convex-migrations-mikeyfennelly1

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill provides strategies and code examples for safely evolving your Convex database schema, ensuring data integrity and minimizing downtime during updates.

Core Features & Use Cases

  • Schema Evolution: Safely add, remove, or rename fields in your Convex tables.
  • Data Backfilling: Implement patterns to populate new fields or migrate data.
  • Index Management: Add and utilize new indexes for improved query performance.
  • Zero-Downtime Migrations: Follow best practices for seamless schema changes.
  • Use Case: You need to add a new avatarUrl field to your users table. This Skill guides you through making the field optional, backfilling existing users, and then making the field required.

Quick Start

Follow the steps in the documentation to add a new optional field to your schema.

Frequently Asked Questions about convex-migrations

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

FAQPage Schema
How do I safely add a required field to an existing Convex database schema?

To safely add a required field to a Convex database schema, first add the field as optional, run a backfill mutation to populate existing records, and then update the schema to make the field required.

What is the best way to backfill data when changing a Convex table schema?

Backfilling data in a Convex table is best handled through internal mutations. This allows you to incrementally populate new fields or migrate existing data safely without causing downtime.

Can I rename or remove deprecated fields in a Convex database without downtime?

Yes, you can rename or remove deprecated fields in a Convex database without downtime by using incremental schema evolution patterns and internal mutations to safely transition your data.

Does Convex support changing field types and adding new indexes during a migration?

Convex supports changing field types and adding new indexes during schema migrations. You can utilize robust migration patterns and the internal mutation system to apply these updates safely.

When do I need to use schema migration strategies for my Convex backend?

You need schema migration strategies for your Convex backend when evolving database tables, such as adding optional fields, renaming columns, or introducing new indexes to maintain query performance.

What are the limitations of updating a Convex schema in a single deployment?

Updating a Convex schema in a single deployment can compromise data integrity if fields are made required before backfilling. Incremental updates using internal mutations are required for safe transitions.