convex-migrations

Automate incremental Convex schema migrations with migration tracking and batched processing.

1|Updated Jan 22, 2026
One-click install
npx skills add https://github.com/blocknavi/convex-batch-processor --skill convex-migrations
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: convex-migrations
Source: https://github.com/blocknavi/convex-batch-processor/tree/main/.claude/skills/convex-migrations
Command: npx skills add https://github.com/blocknavi/convex-batch-processor --skill convex-migrations

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill provides best-practice patterns and tooling guidance for evolving Convex schemas safely, enabling adding new fields, backfilling data, removing deprecated fields, and reworking indexes without downtime.

Core Features & Use Cases

  • Backfilling: incrementally populate new fields without locking or downtime.
  • Index migrations: add or adjust indexes to support new queries.
  • Safe deprecations: gradually remove fields after code paths stop using them.
  • Migration tracking: keep a record of migration runs and progress to prevent duplicates.
  • Use Case: Deploying a new optional field across a user table and backfilling existing users.

Quick Start

Kick off a named migration with startMigration, then incrementally backfill data, update indexes, and complete the migration.

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 in a Convex database without downtime?

To backfill data in a Convex database without downtime, use incremental batched internal mutations to populate new fields. This approach processes records gradually, preventing table locks while existing code continues operating unaffected.

What is the best way to handle schema evolution in Convex?

The best way to handle schema evolution in Convex is applying incremental migrations that track run progress. This prevents duplicate migrations while safely adding new fields, updating indexes, and removing deprecated fields across evolving schemas.

Does Convex support zero-downtime index migrations for new queries?

Convex supports zero-downtime index migrations by allowing you to add or adjust indexes incrementally. You can rework indexes to support new queries without external tooling, preserving continuous application availability.

Can I safely remove deprecated fields from a Convex schema?

You can safely remove deprecated fields from a Convex schema by gradually deprecating them after code paths stop using them. Named migrations track this progress, ensuring field removal occurs only when safe.

Do I need external migration tooling for Convex databases?

No external migration tooling is needed for Convex databases. The system manages schema evolution entirely through internal mutations, handling backfilling, index adjustments, and migration tracking without external dependencies.