How can I monitor the progress of a running migration?

You can use the monitoring command: npx convex run --component migrations lib:getStatus --watch to see real-time status updates.

What should I do if a migration needs to be stopped?

You can cancel an active migration using the command: npx convex run --component migrations lib:cancel '{"name":"migrations:yourFnName"}'.

What is the standard flow for a Convex migration?

The flow involves loosening the schema to tolerate both old and new values, defining the migration in convex/migrations.ts, performing a dry run, and then executing the full run.

How do I safely test a migration before applying it?

Use the dry run command: npx convex run migrations:yourFn '{"dryRun":true,"cursor":null}'. This allows you to verify the logic without modifying production data.

Convex Data Migrations

Name: Convex Data Migrations
Author: ianwatts22

byianwatts22

Database Management

Guides developers through safe, idempotent data migrations within the Convex backend ecosystem using best-practice workflows.

About

The Convex Migration skill provides a standardized framework for managing backend data changes without downtime. It guides users through the full lifecycle of a migration, including schema preparation, defining idempotent migration functions with the @convex-dev/migrations component, performing dry runs for safety, and monitoring real-time execution. By implementing these patterns, developers can confidently refactor data structures and update schemas in production-grade Convex applications.

Key Features

Step-by-step guidance for the @convex-dev/migrations component
Standardized workflows for creating idempotent migration functions
Dry run command generation for risk-free testing
Real-time monitoring and progress tracking commands
Best practices for schema loosening and transitional data states
0 GitHub stars

Use Cases

Resuming interrupted migrations using cursor-based tracking
Updating legacy database records to a new schema version without downtime
Executing batch data transformations safely in a production environment

About

Key Features

Step-by-step guidance for the @convex-dev/migrations component
Standardized workflows for creating idempotent migration functions
Dry run command generation for risk-free testing
Real-time monitoring and progress tracking commands
Best practices for schema loosening and transitional data states
0 GitHub stars

Use Cases

Resuming interrupted migrations using cursor-based tracking
Updating legacy database records to a new schema version without downtime
Executing batch data transformations safely in a production environment