convex-migration-helper

To execute breaking schema migrations in Convex without downtime, use the widen-migrate-narrow pattern to safely evolve database schemas while the application stays live and serves users.

The widen-migrate-narrow pattern is a multi-step workflow for safely evolving database schemas by first widening the schema, migrating existing data, then narrowing it to the target state.

To change a field type or split a table in Convex with live production data, plan a migration describing your current field structure and desired target state to orchestrate the safe data transformation.

Yes, you need the @convex-dev/migrations component to handle batch processing, as it provides reliable, resumable, cursor-based pagination and state tracking for your data transformations.

You should use a migration tool for Convex deployments when you need to rename a field, change a data type, or add required fields to existing production data, preventing deployment failures from schema-data mismatches.