convex-migration-helper

To run zero-downtime Convex migrations, you apply the widen-migrate-narrow workflow alongside the @convex-dev/migrations component, allowing you to backfill existing documents and restructure tables safely during production deployments.

The best way to backfill existing Convex documents is using the @convex-dev/migrations component to transform data safely, ensuring data integrity across your deployment without causing downtime.

The widen-migrate-narrow workflow handles Convex schema changes by first widening the schema to accept both old and new formats, migrating the data, and finally narrowing the schema to enforce the new structure safely.

Yes, you can use the @convex-dev/migrations component to manage multi-deploy rollouts, providing guidance and tooling to safely transition schemas and data across different Convex application deployments.

Performing optional dry-runs is recommended for Convex data migrations to validate the schema change plan and ensure proper fallbacks are in place before modifying production data.

The widen-migrate-narrow approach requires familiarity with Convex migrations and careful planning for fallbacks; limitations arise if proper fallbacks are not configured, risking data integrity during breaking schema changes.