convex-migrations

Evolve Convex database schemas with zero-downtime migration patterns.

78|18|Updated Feb 20, 2025
One-click install
npx skills add https://github.com/nakafaai/nakafa.com --skill convex-migrations-nakafaai
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: convex-migrations
Source: https://github.com/nakafaai/nakafa.com/tree/main/.agents/skills/convex-migrations
Command: npx skills add https://github.com/nakafaai/nakafa.com --skill convex-migrations-nakafaai

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill provides proven patterns and practical workflows to evolve Convex database schemas without downtime, enabling safe addition or removal of fields, indexing, and data backfills across deployment cycles.

Core Features & Use Cases

  • Schema evolution patterns: Add optional fields, backfill data, and gradually migrate to new schemas while preserving existing data.
  • Zero-downtime migrations: Techniques to deploy schema changes without service interruptions.
  • Use Case: When you need to add a new user metadata field and populate it for all existing records without impacting live users.

Quick Start

Start by reviewing migration patterns, then run the starter migration to add fields, backfill, and transition to the new schema.

Frequently Asked Questions about convex-migrations

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

FAQPage Schema
How do I evolve Convex database schemas without downtime?

To evolve Convex database schemas without downtime, apply patterns for adding optional fields, backfilling data in batches, and updating code to read both old and new fields across deployment cycles.

What is the best way to backfill data for existing records in Convex?

The best way to backfill data for existing records in Convex is defining migration workflows that batch work and track progress, populating new fields without impacting live users.

How does zero-downtime migration work when adding new fields to a schema?

Zero-downtime migration for adding new schema fields works by deploying code that reads both old and new fields, running a batched backfill, and then transitioning to the new schema safely.

Can I remove fields from a Convex schema without service interruptions?

You can remove fields from a Convex schema without service interruptions by gradually migrating to new schemas using zero-downtime patterns that preserve existing data during deployment.

How do I track progress when running a large data backfill in Convex?

To track progress during a large Convex data backfill, define migration workflows that explicitly batch work and monitor the transition state across evolving application deployments.