convex-migration-helper

The Convex Migration Helper provides a structured workflow for executing breaking schema changes and data migrations in Convex applications. It emphasizes a widen-migrate-narrow pattern to ensure data integrity and zero-downtime deployments using the @convex-dev/migrations component.

81.1K
Installs
5
Use cases
5/10
Quality

Is convex-migration-helper safe to install?

Review the source first

Review the source first: our audit of convex-migration-helper's source files found 2 shell commands, 0 external URLs, no file writes (high risk). Every command and URL listed appears verbatim in the skill's source. The skill instructs the agent to execute shell commands that modify production or development database state via the Convex CLI.

How we audit skills: our security review methodology.

Who is this skill for?

Developers managing Convex database schemas who need to perform breaking changes, backfills, or table restructuring.

What can you do with it?

  • Adding required fields to existing tables
  • Changing field types or data structures
  • Splitting or merging tables
  • Renaming or deleting fields
  • Migrating from nested to relational data

How good is this skill?

Quality score: 5/10. The skill provides clear, actionable guidance based on established Convex migration patterns. It correctly identifies the risks associated with database operations and provides specific CLI commands for execution.

What does the skill file contain?

SKILL.md
# Convex Migration Helper

Safely migrate Convex schemas and data when making breaking changes.

## When to Use

- Adding new required fields to existing tables
- Changing field types or structure
- Splitting or merging tables
- Renaming or deleting fields
- Migrating from nested to relational data

## When Not to Use

- Greenfield schema with no existing data in production or dev
- Adding optional fields that do not need backfilling
- Adding new tables with no existing data to migrate
- Adding or removing indexes with no correctness concern
- Questions about Convex schema design without a mig...

Frequently asked questions

Why is a multi-deploy workflow necessary for breaking changes?

Convex enforces schema validation at deployment. You must widen the schema to support both old and new formats before migrating data, then narrow the schema once all documents match the new format.

When should I use the @convex-dev/migrations component?

Use this component for any non-trivial migration to handle batching, cursor-based pagination, state tracking, and progress monitoring.

How do I safely test a migration before applying it to production data?

Use the dryRun: true option when executing the migration command to validate logic without modifying documents.

Data sourced from get-convex/agent-skills on GitHub. Install counts from skills.sh. The summary and security audit are derived from the skill's source files: every command and URL listed appears verbatim in the source.

Related skills

lark-base

314.2K

Users who need to programmatically interact with Lark Bitable data, automate table management, or perform data analysis within the Lark ecosystem

The lark-base skill provides a command-line interface for managing Lark Bitable (Base) resources, including tables, records, fields, views, forms, dashboards, workflows, and role-based permissions.

highLarkBitablelarksuite

supabase-postgres-best-practices

264.3K

Developers and database administrators working with Postgres and Supabase

This skill provides a structured set of Postgres performance optimization rules and best practices maintained by Supabase. It guides developers in writing, reviewing, and optimizing SQL queries, schema designs, and database configurations.

lowpostgressupabasesupabase

remotion-to-hyperframes

157.2K

Developers migrating existing Remotion video projects to the HyperFrames framework

The remotion-to-hyperframes skill translates Remotion (React) video compositions into HyperFrames (HTML + GSAP) compositions. It uses a linting process to identify incompatible React patterns, maps Remotion APIs to HyperFrames equivalents, generates HTML/CSS/GSAP output, and validates the translation using SSIM-based image comparison against a tiered test corpus.

highmigrationvideo-productionheygen-com

supabase

153.8K

Developers building applications with Supabase who require assistance with database schema design, security policy implementation, CLI operations, and integration troubleshooting

The Supabase skill provides guidance for developing with the Supabase platform, including database management, authentication, RLS policies, CLI usage, and MCP server integration. It emphasizes verifying implementation against current documentation, following security checklists, and using specific CLI commands for schema migrations.

highsupabasepostgresqlsupabase