C

convex-migration-helper

byget-convexΒ·#155 trending

Install the convex-migration-helper skill for your AI agent. Published by get-convex/agent-skills.

32.8Kweekly installs
24stars
First seenToday

Installation

Send this command to your AI agent:

npx skills add https://github.com/get-convex/agent-skills --skill convex-migration-helper

Documentation

Plan and execute Convex schema migrations safely with multi-deploy workflows and data transformation.

  • Follows a predictable three-step pattern: widen schema, migrate data, narrow schema; handles online migrations where the app continues serving requests during async data updates
  • Provides the @convex-dev/migrations component for batched, cursor-based pagination with state tracking, dry-run testing, progress monitoring, and automatic resume from failure
  • Covers common patterns including adding required fields, deleting fields, changing field types, splitting nested data, and cleaning up orphaned documents
  • Supports dual-write and dual-read strategies for zero-downtime migrations; includes a small-table shortcut for direct in-mutation backfills on tables under a few thousand documents