convex-migrations

Automate versioned, reversible data migrations for Convex services.

20|5|Updated Nov 30, 2025
One-click install
npx skills add https://github.com/tale-project/tale --skill convex-migrations-tale-project
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: convex-migrations
Source: https://github.com/tale-project/tale/tree/main/.claude/skills/convex-migrations
Command: npx skills add https://github.com/tale-project/tale --skill convex-migrations-tale-project

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

The Convex migrations skill provides a structured framework for authoring versioned, reversible, and tested data migrations in services/platform/convex/migrations. It ensures migrations are triggered by schema changes that affect stored data, and enforces safety checks like idempotence, reversible down migrations, and CI-driven validation (migrations:check). It emphasizes proper registration in ALL_META and DB_MIGRATIONS and outlines how tests guard against regressions and data loss.

Core Features & Use Cases

  • Versioned migrations with explicit meta and slug, enabling traceability and rollbacks.
  • Idempotent up/down handlers with optional snapshot strategies to rebuild lost data.
  • Mandatory tests that validate applying then reversing migrations, and ledger state consistency.
  • Dual registration (ALL_META for meta, DB_MIGRATIONS for runnable migrations) to ensure CI and deployment safety.
  • Guidance on patterns for db and node migrations, including example structures and test directories.

Quick Start

Define a new migration version with a readable slug, implement up/down handlers, and validate it in CI before deployment.

Frequently Asked Questions about convex-migrations

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

FAQPage Schema
How do I create reversible data migrations for Convex?

Reversible Convex data migrations require implementing idempotent up/down handlers, assigning a versioned slug, and registering them in ALL_META and DB_MIGRATIONS to ensure safe rollbacks.

What is the best way to test Convex schema changes before deployment?

Testing Convex schema changes involves writing tests that apply and then reverse the migration, checking ledger state consistency and idempotence before CI deployment using migrations:check.

When do I need a versioned data migration in Convex?

You need a versioned Convex data migration when a schema change affects stored data, requiring idempotent up/down handlers and explicit meta registration to maintain reversibility.

Does Convex support idempotent up and down migrations?

Convex migrations support idempotent up/down handlers with optional snapshot strategies to rebuild lost data, ensuring safe application and reversal of schema changes.

Why do my Convex migrations need dual registration in ALL_META and DB_MIGRATIONS?

Dual registration in ALL_META and DB_MIGRATIONS provides migration metadata and runnable references, ensuring CI validation and deployment safety for versioned Convex data changes.