Description
convex-migration-helper is an agent skill that plans and carries out schema and data migrations in Convex, the TypeScript backend, so breaking changes can be made safely. It uses a widen, migrate, narrow approach together with the @convex-dev/migrations package. The skill is for changes that could break existing data: adding new required fields to tables that already hold records, changing a field's type or structure, splitting or merging tables, renaming or deleting fields, and moving nested data into relational tables. It also says when a migration is not needed, such as for a new schema with no production or development data, for optional fields that need no backfill, or for brand-new tables. Working through the widen step first keeps the application running while the data is moved, and the narrow step removes the old shape once the migration is complete. The skill is part of the get-convex agent skills, published by the Convex team on skills.sh and listed as free.…
Highlights
- Plans breaking schema and data migrations in Convex
- Widen, migrate, narrow sequence
- Uses the @convex-dev/migrations package
- Says when a migration is not needed
Ratings & Reviews
No ratings yet
Be the first to rate convex-migration-helper.
People also visit
convex-migration-helper FAQ
When should I use it?
For breaking changes to existing data: new required fields, changed types, split or merged tables, renames and deletions.
When is it not needed?
For a greenfield schema with no data, optional fields that need no backfill, or new tables.
What is widen, migrate, narrow?
A three-step approach: widen the schema to accept both shapes, migrate the data, then narrow the schema to the new shape.
How do I install it?
Run npx skills add https://github.com/get-convex/agent-skills --skill convex-migration-helper in your terminal.
Is it free?
The listing shows the skill as free.
What are the best convex-migration-helper alternatives?
Popular alternatives to convex-migration-helper include convex, convex-expert and nestjs-patterns. See all convex-migration-helper alternatives